89d651364b
This updates documentation related to knowledge bases (formerly known as Copilot for Docs/docsets) ahead of our upcoming GA 🎉 The way that we think about this product has changed, meaning that I have dropped the current "Copilot docset management" section and the "About docset management" page in favour of folding this content into the main "Copilot Chat in GitHub.com" articles. "Managing knowledge bases" is still its own page, because that *just makes sense*. At a more granular level, this PR: * Updates references to "docsets" to refer to "knowledge bases" instead * Reflects the new way to use a knowledge base in Copilot Chat, with the "Attach knowledge" button * Switches documentation about creating and managing knowledge bases to point to the new home of these settings within an organization's settings screen * Corrects some inconsistencies in the main "About Copilot Chat in GitHub.com" article where we refer to IDEs. We should keep IDE chat and Dotcom chat more separate, imo, as they are different products with different features. For more context, see the content design plan in https://github.com/github/docs-strategy/pull/2468. Closes https://github.com/github/docs-content/issues/13473.
4.6 KiB
title, shortTitle, intro, versions, topics, product, redirect_from
| title | shortTitle | intro | versions | topics | product | redirect_from | ||||
|---|---|---|---|---|---|---|---|---|---|---|
| Managing Copilot knowledge bases | Managing knowledge bases | Organization owners can create a knowledge base bringing together Markdown documentation across one or more repositories, and then organization members can use that knowledge base as context for {% data variables.product.prodname_copilot_chat_dotcom_short %}. |
|
|
{% data reusables.gated-features.copilot-enterprise-beta %} |
|
About knowledge bases
Organization owners can create knowledge bases, bringing together Markdown documentation across one or more repositories. Organization members can then specify that knowledge base as the context for {% data variables.product.prodname_copilot_chat_dotcom_short %}.
When you ask a question in {% data variables.product.prodname_copilot_chat_dotcom_short %}, {% data variables.product.prodname_copilot %} will search the knowledge base for relevant information and synthesize a response. For more information on how to use knowledge bases in {% data variables.product.prodname_copilot_chat_dotcom_short %}, see "Asking a question about a knowledge base."
Creating a knowledge base
You can create a knowledge based on a single repository or a selection of repositories. You can create a knowledge base using public, private, and/or internal repositories.
A knowledge base you create will be accessible by all organization members with a {% data variables.product.prodname_copilot_enterprise %} subscription. When an organization member uses a knowledge base as context in {% data variables.product.prodname_copilot_chat_dotcom_short %}, the response will only use data from repositories that the organization member has read access to.
{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %}
-
In the left sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %} then click Customize.
-
In the box under Knowledge, click Add knowledge base.
-
In the "Name" field, enter a unique name for the knowledge base. Optionally, in the "Description" field, you can add a description for the knowledge base.
-
Under "Content", to see a full list of available repositories, click Select repositories.
-
To select a repository or repositories, click the checkbox next to the repository name. When you're finished selecting repositories, click Apply.
-
Optionally, you can define which paths within the selected repositories to index.
- Click Edit file paths.
- List the paths you want to include in the knowledge base, one path per line. When you're finished, click Apply.
-
Click Create knowledge base.
Updating a knowledge base
Organization owners can delete a knowledge base created in their organization.
{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %}
- In the left sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %} then click Customize.
- On the right hand side of the knowledge basde you want to edit, click {% octicon "pencil" aria-label="The pencil symbol" %}.
- Make changes to your knowledge base.
- Click Update knowledge base.
Deleting a knowledge base
Organization owners can delete a knowledge base created in their organization.
{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %}
- In the left sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %} then click Customize.
- On the right-hand side of the knowledge base you want to delete, click {% octicon "trash" aria-label="The trash symbol" %}.
- Review the information in the "Confirm deletion" dialog box, and click Delete.