Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 6.28 KB

managing-copilot-knowledge-bases.md

File metadata and controls

91 lines (61 loc) · 6.28 KB
title shortTitle intro versions product topics redirect_from
Managing Copilot knowledge bases
Manage 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 %}.
ghec
*
{% data reusables.copilot.ce-product-callout %}
Copilot
/copilot/managing-copilot/managing-github-copilot-in-your-organization/customizing-copilot-for-your-organization/managing-copilot-knowledge-bases
/copilot/managing-copilot/managing-github-copilot-in-your-organization/enhancing-copilot-for-your-organization/managing-copilot-knowledge-bases
/copilot/github-copilot-enterprise/copilot-docset-management/creating-private-docsets
/copilot/github-copilot-enterprise/copilot-docset-management
/copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases
/copilot/github-copilot-chat/copilot-chat-in-github/managing-copilot-knowledge-bases
/copilot/github-copilot-enterprise/managing-copilot-knowledge-bases
/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases
/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-copilot-knowledge-bases
/copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management

{% ifversion fpt %}

{% data reusables.rai.copilot.enterprise-fpt-link %}

{% endif %}

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 %}, {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, and {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}.

When you ask a question in {% data variables.product.prodname_copilot_chat %} with a knowledge base selected, {% 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_short %}, see AUTOTITLE and AUTOTITLE.

Creating a knowledge base

You can create a knowledge base from a single repository or a selection of repositories. You can create a knowledge base using public, private, and/or internal repositories.

Knowledge bases you create will be accessible by all organization members with a {% data variables.product.prodname_copilot_enterprise_short %} plan. When an organization member uses a knowledge base as context in {% data variables.product.prodname_copilot_chat %}, 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 %}

  1. In the left sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %} then click Knowledge bases.

  2. To the right of "Knowledge bases", click New knowledge base.

  3. 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.

    Screenshot of the "New knowledge base" page.

  4. Under "Content", to see a full list of available repositories, click Select repositories.

    Screenshot of the "Select repositories" page. The "Select repositories" page is highlighted with a dark orange outline.

  5. To select a repository or repositories, click the checkbox next to the repository name. When you're finished selecting repositories, click Apply.

    Screenshot of the "Select repositories" page.

  6. Optionally, you can specify particular paths within the selected repositories for searches. When a search is conducted using the knowledge base, only the files located in those designated paths will be included in the results. For more information on specifying repository paths, see AUTOTITLE

    • Click Edit file paths.

    Screenshot of the list of selected repositories. The "Edit file paths" link is highlighted with a dark orange outline.

    • List the paths you want to include in the knowledge base, one path per line. When you're finished, click Apply.
  7. Click Create knowledge base.

Updating a knowledge base

Organization owners can update a knowledge base created in their organization.

{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %}

  1. In the left sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %} then click Knowledge bases.
  2. To the right of the knowledge base you want to edit, click {% octicon "pencil" aria-label="The pencil symbol" %}.
  3. Make your desired changes to your knowledge base.
  4. 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 %}

  1. In the left sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %} then click Knowledge bases.
  2. To the right of the knowledge base you want to delete, click {% octicon "trash" aria-label="The trash symbol" %}.
  3. In the "Confirm deletion" dialog box, review the information and click Delete.