Bring your own key for Copilot (Public preview) (#58549)
Co-authored-by: Jaryl <jarylw@github.com> Co-authored-by: Sarah Vessels <82317+cheshire137@users.noreply.github.com> Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com>
This commit is contained in:
@@ -13,6 +13,7 @@ children:
|
||||
- /manage-agents
|
||||
- /manage-spark
|
||||
- /view-usage-and-adoption
|
||||
- /use-your-own-api-keys
|
||||
redirect_from:
|
||||
- /copilot/managing-copilot/managing-copilot-for-your-enterprise
|
||||
- /copilot/how-tos/administer/enterprises
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Using your LLM provider API keys with Copilot
|
||||
shortTitle: Use your own API keys
|
||||
intro: 'Learn how to integrate your preferred custom models with {% data variables.product.prodname_copilot %} by using your own LLM API keys, and make them available for organizations in your enterprise account.'
|
||||
versions:
|
||||
feature: copilot-byok
|
||||
topics:
|
||||
- Copilot
|
||||
contentType: how-tos
|
||||
allowTitleToDifferFromFilename: true
|
||||
---
|
||||
|
||||
{% data reusables.copilot.byok-intro %}
|
||||
|
||||
## Why bring your own API keys?
|
||||
|
||||
As an enterprise owner, you may have specific requirements for governance, data security, and compliance. Setting up your own API keys allows you to address:
|
||||
|
||||
{% data reusables.copilot.byok-why %}
|
||||
|
||||
## Adding your key to an enterprise account
|
||||
|
||||
> [!IMPORTANT] We highly recommend adhering to the principle of least privilege by assigning only the minimum necessary scopes to your API keys.
|
||||
|
||||
After you've added your key and selected one or more models, you and members of your organizations will be able to use them with {% data variables.copilot.copilot_byok_supported_features %}. Your models will appear at the bottom of the model picker, under the enterprise name.
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.ai-controls-tab %}
|
||||
1. In the sidebar, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**.
|
||||
1. Click **Configure allowed models**.
|
||||
{% data reusables.copilot.byok-add %}
|
||||
|
||||
## Managing availability of custom models in your organizations
|
||||
|
||||
You can choose whether the models you have added are available to organizations in your enterprise account.
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.ai-controls-tab %}
|
||||
1. In the sidebar, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**.
|
||||
1. Click **Configure allowed models**.
|
||||
1. Click the **Custom models** tab.
|
||||
1. Above the list of API keys, click the **Added models** tab.
|
||||
1. Next to a model, click **Configure**. If any organizations already have access to the model, instead of "Configure", you will need to click **All organizations** or **X organizations**.
|
||||
1. In the modal that opens, click the **Access** tab.
|
||||
>[!NOTE] The model must be set to 'Enabled' before the "Access" tab will be available.
|
||||
1. Choose how the model should be made available to organizations:
|
||||
* To make the model available to all organizations in your enterprise account, select **Allow for all organizations**.
|
||||
* To only make the model available for specific organizations, select **Choose per organization**, and check or uncheck the organizations listed below.
|
||||
1. Click **Save**.
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/use-your-own-api-keys) in our documentation for organizations.
|
||||
* [AUTOTITLE](/copilot/concepts/chat)
|
||||
@@ -19,5 +19,6 @@ children:
|
||||
- /add-copilot-coding-agent
|
||||
- /prepare-for-custom-agents
|
||||
- /review-activity
|
||||
- /use-your-own-api-keys
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Using your LLM provider API keys with Copilot
|
||||
shortTitle: Use your own API keys
|
||||
intro: 'Learn how to integrate your preferred custom models with {% data variables.product.prodname_copilot %} by using your own LLM API keys, and make them available to your organization members.'
|
||||
versions:
|
||||
feature: copilot-byok
|
||||
topics:
|
||||
- Copilot
|
||||
contentType: how-tos
|
||||
allowTitleToDifferFromFilename: true
|
||||
---
|
||||
|
||||
{% data reusables.copilot.byok-intro %}
|
||||
|
||||
## Why bring your own API keys?
|
||||
|
||||
As an organization owner, you may have specific requirements for governance, data security, and compliance. Setting up your own API keys allows you to address:
|
||||
|
||||
{% data reusables.copilot.byok-why %}
|
||||
|
||||
## Adding your key to an organization account
|
||||
|
||||
> [!IMPORTANT] We highly recommend adhering to the principle of least privilege by assigning only the minimum necessary scopes to your API keys.
|
||||
|
||||
After you've added your key and selected one or more models, you and your organization members will be able to use them with {% data variables.copilot.copilot_byok_supported_features %}. Your models will appear at the bottom of the model picker, under the organization name.
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
1. In the sidebar, under "Code, planning, and automation", click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**.
|
||||
1. Under "Copilot", click **Models**.
|
||||
{% data reusables.copilot.byok-add %}
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/use-your-own-api-keys) in our documentation for enterprise accounts.
|
||||
* [AUTOTITLE](/copilot/concepts/chat)
|
||||
@@ -12,7 +12,7 @@ redirect_from:
|
||||
- /copilot/how-tos/ai-models/configure-access-to-ai-models
|
||||
- /github-models/use-github-models/integrating-ai-models-into-your-development-workflow
|
||||
contentType: how-tos
|
||||
category:
|
||||
category:
|
||||
- Configure Copilot
|
||||
---
|
||||
|
||||
@@ -47,3 +47,9 @@ You can enable access in two ways:
|
||||
As an enterprise or organization owner, you can enable or disable access to AI models for everyone who has been assigned a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} seat through your enterprise or organization. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization) and [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise).
|
||||
|
||||
> [!NOTE] Models available in {% data variables.copilot.copilot_auto_model_selection %} will follow the policies set for an organization or enterprise. See [AUTOTITLE](/copilot/concepts/auto-model-selection).
|
||||
|
||||
{% ifversion copilot-byok %}
|
||||
|
||||
You can also integrate your preferred custom models from supported LLM providers by bringing your own API keys. Organization owners can make custom models available for members of their organization and enterprise owners can add custom models and choose which organizations can make use of them. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/use-your-own-api-keys) for organizations and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/use-your-own-api-keys) for enterprise accounts.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -149,6 +149,8 @@ Depending on the question you ask, {% data variables.copilot.copilot_chat %} can
|
||||
|
||||
When leveraging Bing, {% data variables.product.prodname_copilot_short %} will use the content of your prompt, as well as additional available context, to generate a Bing search query on your behalf that is sent to the Bing Search API. {% data variables.product.prodname_copilot_short %} will provide a link to the search results with its response. The search query sent to Bing is governed by [Microsoft's Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement).
|
||||
|
||||
{% data reusables.rai.copilot.byok-transparency-note %}
|
||||
|
||||
## Next steps
|
||||
|
||||
For details of how to use {% data variables.copilot.copilot_chat_dotcom %}, see:
|
||||
|
||||
@@ -39,6 +39,8 @@ When you use the `@github` chat participant, {% data variables.copilot.copilot_c
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-leveraging-web-search %}
|
||||
|
||||
{% data reusables.rai.copilot.byok-transparency-note %}
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-use-cases %}
|
||||
|
||||
### Answering coding questions
|
||||
@@ -81,6 +83,8 @@ When you use the `@github` chat participant, {% data variables.copilot.copilot_c
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-leveraging-web-search %}
|
||||
|
||||
{% data reusables.rai.copilot.byok-transparency-note %}
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-use-cases %}
|
||||
|
||||
### Answering coding questions
|
||||
@@ -115,6 +119,8 @@ This can be a useful tool for programmers, as it can provide guidance and suppor
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-output-formatting %}
|
||||
|
||||
{% data reusables.rai.copilot.byok-transparency-note %}
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-use-cases %}
|
||||
|
||||
### Answering coding questions
|
||||
@@ -149,6 +155,8 @@ This can be a useful tool for programmers, as it can provide guidance and suppor
|
||||
|
||||
{% data reusables.rai.copilot.copilot-chat-ide-output-formatting %}
|
||||
|
||||
{% data reusables.rai.copilot.byok-transparency-note %}
|
||||
|
||||
## Use cases for {% data variables.copilot.copilot_chat %}
|
||||
|
||||
{% data variables.copilot.copilot_chat %} can provide coding assistance in a variety of scenarios.
|
||||
|
||||
Reference in New Issue
Block a user