From 3fcae04ccfce5adc7a43b8e35ac906a55cdff7b4 Mon Sep 17 00:00:00 2001 From: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Date: Tue, 8 Jul 2025 10:05:19 -0700 Subject: [PATCH] [Improvement] GitHub Models docs (#56518) --- .../get-started/github-copilot-features.md | 4 --- content/github-models/about-github-models.md | 5 ++++ .../github-models-at-scale/index.md | 3 ++- ...ing-your-own-api-keys-in-github-models.md} | 25 +++++++++++++++---- 4 files changed, 27 insertions(+), 10 deletions(-) rename content/github-models/github-models-at-scale/{set-up-custom-model-integration-models-byok.md => using-your-own-api-keys-in-github-models.md} (72%) diff --git a/content/copilot/get-started/github-copilot-features.md b/content/copilot/get-started/github-copilot-features.md index f59375f2d0..337da29787 100644 --- a/content/copilot/get-started/github-copilot-features.md +++ b/content/copilot/get-started/github-copilot-features.md @@ -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 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 %} is available in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs. {% data reusables.copilot.copilot-edits.about-copilot-edits %} diff --git a/content/github-models/about-github-models.md b/content/github-models/about-github-models.md index 6a5f4e217c..8daf73a3a6 100644 --- a/content/github-models/about-github-models.md +++ b/content/github-models/about-github-models.md @@ -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 model’s 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 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/optimizing-your-ai-powered-app-with-github-models) * [AUTOTITLE](/github-models/use-github-models/evaluating-ai-models) +* [AUTOTITLE](/billing/managing-billing-for-your-products/about-billing-for-github-models) diff --git a/content/github-models/github-models-at-scale/index.md b/content/github-models/github-models-at-scale/index.md index 403015ee58..17066195cd 100644 --- a/content/github-models/github-models-at-scale/index.md +++ b/content/github-models/github-models-at-scale/index.md @@ -6,5 +6,6 @@ versions: children: - /use-models-at-scale - /manage-models-at-scale - - /set-up-custom-model-integration-models-byok + - /using-your-own-api-keys-in-github-models --- + diff --git a/content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md b/content/github-models/github-models-at-scale/using-your-own-api-keys-in-github-models.md similarity index 72% rename from content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md rename to content/github-models/github-models-at-scale/using-your-own-api-keys-in-github-models.md index a48a983836..7232a77eae 100644 --- a/content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md +++ b/content/github-models/github-models-at-scale/using-your-own-api-keys-in-github-models.md @@ -1,23 +1,25 @@ --- title: Using your own API keys in GitHub 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: 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: - Enterprise allowTitleToDifferFromFilename: true +redirect_from: + - /github-models/github-models-at-scale/set-up-custom-model-integration-models-byok --- {% 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). 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? 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.org_settings %} {% 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). 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 Now that you've enabled your custom models in {% data variables.product.prodname_github_models %}, learn how to: