When you enable Owlbot AI, users can ask questions about your product and instantly receive an answer, all directly within your developer hub ✨
Thanks to OpenAI’s models, Owlbot is trained on your documentation to respond with precise answers to your users’ questions. This can be anything from questions about the product or complete code snippets for making API calls.
Owlbot AI is embedded in your developer hub's search, and accessible on any page in your hub, allowing your users to get all of their questions answered in one centralized place. Based on the question or phrase a user types into the search bar, the answer returned will include relevant pages in your hub and/or an AI-generated response.
At the bottom of each answer, Owlbot links out to the docs that were used to answer the question, so the user can read more information about the topic. Users can also upvote or downvote the answer they've received, as well as copying the answer to their clipboard.
Owlbot AI is an additional $150/month per project on top of your ReadMe plan. For customers on our Enterprise plan with multiple projects, the cost is per child project, billed annually.
To enable Owlbot AI in your developer hub, head to the Owlbot AI page in your project dashboard's sidebar. For non-Enterprise projects, click the Enable Owlbot AI button and follow the steps from there. You can also enable Owlbot AI via the Upgrade Plan page in your project dashboard. If you're on an Enterprise project, head to the Owlbot AI page in your Enterprise Group dashboard and connect with our sales team to discuss enabling Owlbot AI for your hub!
Owlbot AI is still in beta!
It's ready to start enabling now, though! We're continuing to roll out new features and improvements on an ongoing basis ✨
We log every question and answer so Project Admins can get a sense of what users are looking for and how well the prompts are being answered. Users can also choose to upvote or downvote a response based on their satisfaction, and that vote is logged as well. Currently we don’t have any way to provide feedback on the responses, but we are looking into adding this functionality.
No, project data is only used to answer specific questions asked by users and is not used to train any of OpenAI's models. Questions and answers are stored by ReadMe for the admin UI, and OpenAI retains logs of API requests for 30 days. More information about OpenAI's use of data can be found here.
Currently Owlbot is updated with new content every two hours. During the beta we are tweaking this to get the best experience and are hoping to make this almost instant in the future.
Are hidden pages used to generate answers? What about Enterprise projects with a mix of public and private content?
Hidden pages are never indexed by Owlbot. For non-Enterprise projects, this means that Owlbot will respond using content from non-hidden pages (i.e., pages that your users see in the sidebar).
For Enterprise projects, only content the user has access to is used to answer questions. If a user has access to only one enterprise project and not another, they will never see answers generated using content from the project they do not have access to (via End User permissioning).
Currently only content from the Guides and API Reference section of the main version of a project are used to answer questions asked to Owlbot. We are looking to add Discussions, Changelog posts, Custom Pages, and Recipes in the near future.
We use a mix of GPT-4 and GPT-4-32k depending on the specific query being made.
Currently there is no limit. During the beta period, we may re-evaluate this depending on usage patterns.
Owlbot can only be enabled on an entire Enterprise Group and applies to all child projects within that group. It cannot be enabled on a per-child project basis. If you're interested in enabling Owlbot AI for your Enterprise Group, reach out to your CSM or email [email protected]!
Updated 4 days ago