1
0
mirror of synced 2025-12-19 18:10:59 -05:00

[Improvement] GitHub Models docs (#56518)

This commit is contained in:
Sunbrye Ly
2025-07-08 10:05:19 -07:00
committed by GitHub
parent a5746b7b18
commit 3fcae04ccf
4 changed files with 27 additions and 10 deletions

View File

@@ -49,10 +49,6 @@ AI-generated text completion to help you write pull request descriptions quickly
{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} See [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions). {% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} See [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions).
### {% data variables.product.prodname_github_models %} ({% data variables.release-phases.public_preview %})
Bringing the power of industry leading large and small language models to users directly on {% data variables.product.github %}. See [AUTOTITLE](/github-models).
### {% data variables.copilot.copilot_edits_short %} ### {% data variables.copilot.copilot_edits_short %}
{% data variables.copilot.copilot_edits_short %} is available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs. {% data reusables.copilot.copilot-edits.about-copilot-edits %} {% data variables.copilot.copilot_edits_short %} is available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs. {% data reusables.copilot.copilot-edits.about-copilot-edits %}

View File

@@ -52,6 +52,10 @@ Use the Comparisons view to evaluate the outputs of multiple prompt configuratio
Use the Playground to quickly explore models and test prompt ideas in real time. The Playground is ideal for early experimentation, helping you understand a models behavior, capabilities, and response style. You can interactively select models, adjust parameters, and compare responses side by side. Use the Playground to quickly explore models and test prompt ideas in real time. The Playground is ideal for early experimentation, helping you understand a models behavior, capabilities, and response style. You can interactively select models, adjust parameters, and compare responses side by side.
## Billing
For more information about billing for {% data variables.product.prodname_github_models %}, see [AUTOTITLE](/billing/managing-billing-for-your-products/about-billing-for-github-models).
## Join the community ## Join the community
To ask questions and share feedback, see this [GitHub Models discussion post](https://github.com/orgs/community/discussions/159087). To ask questions and share feedback, see this [GitHub Models discussion post](https://github.com/orgs/community/discussions/159087).
@@ -62,3 +66,4 @@ To learn how others are using {% data variables.product.prodname_github_models %
* [AUTOTITLE](/github-models/use-github-models/prototyping-with-ai-models) * [AUTOTITLE](/github-models/use-github-models/prototyping-with-ai-models)
* [AUTOTITLE](/github-models/use-github-models/optimizing-your-ai-powered-app-with-github-models) * [AUTOTITLE](/github-models/use-github-models/optimizing-your-ai-powered-app-with-github-models)
* [AUTOTITLE](/github-models/use-github-models/evaluating-ai-models) * [AUTOTITLE](/github-models/use-github-models/evaluating-ai-models)
* [AUTOTITLE](/billing/managing-billing-for-your-products/about-billing-for-github-models)

View File

@@ -6,5 +6,6 @@ versions:
children: children:
- /use-models-at-scale - /use-models-at-scale
- /manage-models-at-scale - /manage-models-at-scale
- /set-up-custom-model-integration-models-byok - /using-your-own-api-keys-in-github-models
--- ---

View File

@@ -1,23 +1,25 @@
--- ---
title: Using your own API keys in GitHub Models title: Using your own API keys in GitHub Models
shortTitle: Use custom models shortTitle: Use custom models
intro: Learn how to integrate your preferred custom models with {% data variables.product.prodname_github_models %} by using your own LLM API keys. intro: 'Learn how to integrate your preferred custom models with {% data variables.product.prodname_github_models %} by using your own LLM API keys.'
versions: versions:
feature: github-models feature: github-models
permissions: Organization owners can add custom models to {% data variables.product.prodname_github_models %} for their organization permissions: 'Organization owners can add custom models to {% data variables.product.prodname_github_models %} for their organization'
topics: topics:
- Enterprise - Enterprise
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
redirect_from:
- /github-models/github-models-at-scale/set-up-custom-model-integration-models-byok
--- ---
{% data reusables.models.byok-preview-note %} {% data reusables.models.byok-preview-note %}
>
> Model support is currently limited to OpenAI and AzureAI.
You can bring your own API keys (BYOK) to {% data variables.product.prodname_github_models %}, and enable teams to use your preferred large language model (LLM) providers across tools like Prompts, Playground, and Models in Actions. For more information about {% data variables.product.prodname_github_models %}, see [AUTOTITLE](/github-models/about-github-models). You can bring your own API keys (BYOK) to {% data variables.product.prodname_github_models %}, and enable teams to use your preferred large language model (LLM) providers across tools like Prompts, Playground, and Models in Actions. For more information about {% data variables.product.prodname_github_models %}, see [AUTOTITLE](/github-models/about-github-models).
To learn about billing and pricing, see [AUTOTITLE](/billing/managing-billing-for-your-products/about-billing-for-github-models). To learn about billing and pricing, see [AUTOTITLE](/billing/managing-billing-for-your-products/about-billing-for-github-models).
>[!NOTE] Model support is currently limited to OpenAI and AzureAI.
## Why bring your own API keys? ## Why bring your own API keys?
As an organization owner, you may have specific requirements for governance, data security, and compliance. By setting up your own API keys, you can: As an organization owner, you may have specific requirements for governance, data security, and compliance. By setting up your own API keys, you can:
@@ -47,10 +49,23 @@ You must first add the relevant API keys for the organization. After that, your
{% data reusables.profile.access_org %} {% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %} {% data reusables.profile.org_settings %}
{% data reusables.organizations.models-development %} {% data reusables.organizations.models-development %}
1. Under "Models permissions", select **All publishers** to enable models added by API keys. 1. Under "Models permissions," select **All publishers** to enable models added by API keys.
* If this option isn't available, you need to allow the use of the model in the organization. See [AUTOTITLE](/github-models/github-models-at-scale/manage-models-at-scale#controlling-model-usage-in-your-organization). * If this option isn't available, you need to allow the use of the model in the organization. See [AUTOTITLE](/github-models/github-models-at-scale/manage-models-at-scale#controlling-model-usage-in-your-organization).
1. Optionally, select **Only select models** to create a custom list of enabled or disabled models. This allows you to control which models are available to your organization. 1. Optionally, select **Only select models** to create a custom list of enabled or disabled models. This allows you to control which models are available to your organization.
## Creating an enabled or disabled models list
To control which models are available to your organization, create an enabled or disabled models list as follows:
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
{% data reusables.organizations.models-development %}
1. Under "Models permissions," select **Only select models**, then select **Enabled list** from the dropdown to create a list of allowed models.
1. Optionally, select **Disabled list** from the dropdown if you want to create a list of blocked models.
1. Above the table of models, click **Add models or publishers**.
1. In the "Select models and publishers to allow" dialog, select the models and publishers you want to include in your list.
1. Click **Update enabled list** to save your changes.
## Next steps ## Next steps
Now that you've enabled your custom models in {% data variables.product.prodname_github_models %}, learn how to: Now that you've enabled your custom models in {% data variables.product.prodname_github_models %}, learn how to: