You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/copilot/how-tos/github-copilot-app/agent-sessions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ The session mode controls how much autonomy the agent has. You can set the mode
37
37
38
38
You can select a model and reasoning effort from the dropdowns above the prompt field. Higher reasoning effort gives the agent more time to think through complex problems but may take longer. You can change both settings at any time during a session.
39
39
40
-
If you configured your own model provider in the app using bring your own key (BYOK), those models also appear in the picker. For setup steps, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/use-byok-models).
40
+
If you configured your own model provider in the app, those models also appear in the picker. For setup steps, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/use-byok-models).
41
41
42
42
Hover over the {% octicon "info" aria-label="the info icon" %} icon in the model picker to see model details.
Copy file name to clipboardExpand all lines: content/copilot/how-tos/github-copilot-app/getting-started.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,8 @@ For a conceptual overview of the {% data variables.copilot.github_copilot_app %}
19
19
## Prerequisites
20
20
21
21
*[Git](https://github.com/git-guides/install-git) installed on your computer.
22
-
* A paid {% data variables.product.prodname_copilot_short %} plan.
22
+
* A {% data variables.product.github %} account.
23
+
* A {% data variables.product.prodname_copilot_short %} plan. Alternatively, if using your own model provider, you will need required credentials such as an API key. For more information, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/use-byok-models).
23
24
* If you use {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}, your plan administrator must enable the **{% data variables.copilot.copilot_cli_short %}** policy. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies) or [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).
24
25
25
26
## Installing the {% data variables.copilot.github_copilot_app %}
@@ -31,8 +32,10 @@ For a conceptual overview of the {% data variables.copilot.github_copilot_app %}
31
32
32
33
1. Open the {% data variables.copilot.github_copilot_app %}.
33
34
1. Click **Sign in to {% data variables.product.github %}** and follow the prompts to authenticate. If you use {% data variables.product.prodname_ghe_server %}, choose **Use GitHub Enterprise** and enter your server address when prompted.
34
-
1. The app walks you through onboarding. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity, or choose a sample project. You can also skip this step and add repositories later.
35
-
1. Choose a theme, then complete onboarding.
35
+
1. If you do not have a {% data variables.product.prodname_copilot_short %} plan, choose whether to sign up for a plan or continue with your own model provider.
36
+
* If you choose to use your own model provider, select a provider, enter any required credentials, then click **Save and continue**.
37
+
1. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity. You can also add a local repository, or skip this step and add repositories later.
38
+
1. Choose a theme, then complete onboarding to open the app.
Copy file name to clipboardExpand all lines: content/copilot/how-tos/github-copilot-app/use-byok-models.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,12 +13,14 @@ category:
13
13
---
14
14
15
15
> [!NOTE]
16
-
> Support to use your own provider (BYOK) in the {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.public_preview %} and subject to change.
16
+
> Support to use your own model provider in the {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.public_preview %} and subject to change.
17
17
18
-
You can configure the {% data variables.copilot.github_copilot_app %} to use your own LLM provider, also called BYOK (Bring Your Own Key), instead of {% data variables.product.github %}-hosted models.
18
+
You can configure the {% data variables.copilot.github_copilot_app %} to use your own LLM provider, also called BYOK (Bring Your Own Key), instead of {% data variables.product.github %}-hosted models. You can set up your model provider when you first open the app or later in app settings.
19
+
20
+
You must sign in with a {% data variables.product.github %} account to use the app, but you do not need a {% data variables.product.prodname_copilot_short %} plan if you use your own model provider. If you do have a {% data variables.product.prodname_copilot_short %} plan, you can use both your own model provider and {% data variables.product.github %}-hosted models in the same app.
19
21
20
22
> [!NOTE]
21
-
> This article is for users who want to configure their own LLM provider API key on their local machine. To set up custom models for users in an organization or enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/use-your-own-api-keys) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/use-your-own-api-keys).
23
+
> This article is for users who want to configure their own LLM provider settings on their local machine. To set up custom models for users in an organization or enterprise, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/use-your-own-api-keys) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/use-your-own-api-keys).
22
24
23
25
## Supported providers
24
26
@@ -36,9 +38,12 @@ You can configure the {% data variables.copilot.github_copilot_app %} to use you
36
38
## Prerequisites
37
39
38
40
* The {% data variables.copilot.github_copilot_app %} is installed. For setup steps, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/getting-started).
39
-
* You have an API key for your model provider.
41
+
* You have any required credentials, such as API key, for your model provider.
42
+
## Set up a model provider
43
+
44
+
If you are setting up the app for the first time and do not have a {% data variables.product.prodname_copilot_short %} plan, you can choose to set up your own model provider during onboarding.
40
45
41
-
## Add a model provider
46
+
To add or update a model provider later:
42
47
43
48
1. Open the {% data variables.copilot.github_copilot_app %}.
44
49
1. Open app settings, then click **Model providers**.
@@ -49,4 +54,4 @@ You can configure the {% data variables.copilot.github_copilot_app %} to use you
49
54
50
55
After you add a provider, its models appear in the model picker alongside {% data variables.product.github %}-hosted models. You can select the model and use it in a session. For more information, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/agent-sessions).
51
56
52
-
Keys are stored in the system credential store and are never displayed in the UI.
57
+
Provider credentials are stored in the system credential store and are never displayed in the UI.
0 commit comments