Skip to content

Commit 10dfe2b

Browse files
hubwriterCopilot
andcommitted
Address BYOK configuration review feedback
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2b69398 commit 10dfe2b

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

‎content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Models must support **tool calling** (also called function calling) and **stream
4343
## Configuring your provider
4444

4545
You configure your model provider by setting environment variables before starting {% data variables.copilot.copilot_cli_short %}.
46+
4647
| Environment variable | Required | Description |
4748
|---|---|---|
4849
| `COPILOT_PROVIDER_BASE_URL` | Yes | The base URL of your model provider's API endpoint. |
@@ -51,8 +52,8 @@ You configure your model provider by setting environment variables before starti
5152
| `COPILOT_PROVIDER_BEARER_TOKEN` | No | Bearer token used for provider authentication when API-key authentication is not used. |
5253
| `COPILOT_PROVIDER_WIRE_API` | No | Specifies the API protocol used when communicating with the provider. |
5354
| `COPILOT_PROVIDER_AZURE_API_VERSION` | Azure only | The Azure OpenAI API version used for requests. |
54-
| `COPILOT_PROVIDER_MODEL_ID` | Azure only | The Azure OpenAI deployment name used to route requests. |
55-
| `COPILOT_PROVIDER_WIRE_MODEL` | Azure only | The underlying model name associated with the deployment. |
55+
| `COPILOT_PROVIDER_MODEL_ID` | No | The well-known model name used to identify model capabilities and token limits. |
56+
| `COPILOT_PROVIDER_WIRE_MODEL` | No | The model name sent to the provider API for inference. For Azure OpenAI, use the deployment name. |
5657
| `COPILOT_PROVIDER_MAX_PROMPT_TOKENS` | No | Maximum number of prompt tokens allowed in a request. |
5758
| `COPILOT_PROVIDER_MAX_OUTPUT_TOKENS` | No | Maximum number of tokens generated in a response. |
5859
| `COPILOT_MODEL` | Yes | The model identifier to use. You can also set this with the `--model` command-line flag. |
@@ -91,8 +92,8 @@ Use the following steps if you are connecting to OpenAI, Ollama, vLLM, Foundry L
9192
export COPILOT_PROVIDER_TYPE=azure
9293
export COPILOT_PROVIDER_API_KEY=YOUR-AZURE-API-KEY
9394
export COPILOT_PROVIDER_AZURE_API_VERSION=YOUR-AZURE-API-VERSION
94-
export COPILOT_PROVIDER_MODEL_ID=YOUR-DEPLOYMENT-NAME
95-
export COPILOT_PROVIDER_WIRE_MODEL=YOUR-MODEL-NAME
95+
export COPILOT_PROVIDER_MODEL_ID=YOUR-MODEL-NAME
96+
export COPILOT_PROVIDER_WIRE_MODEL=YOUR-DEPLOYMENT-NAME
9697
export COPILOT_MODEL=YOUR-DEPLOYMENT-NAME
9798
```
9899

@@ -103,12 +104,13 @@ Use the following steps if you are connecting to OpenAI, Ollama, vLLM, Foundry L
103104
* `YOUR-MODEL-NAME`: the underlying model associated with the deployment (for example, `gpt-4o`)
104105
* `YOUR-AZURE-API-VERSION`: the Azure OpenAI API version
105106
* `YOUR-AZURE-API-KEY`: your Azure OpenAI API key
107+
106108
### Azure-specific environment variables
107109

108110
| Variable | Description |
109111
|---|---|
110-
| `COPILOT_PROVIDER_MODEL_ID` | The Azure OpenAI deployment name. Azure OpenAI routes requests through deployments rather than directly through model names. |
111-
| `COPILOT_PROVIDER_WIRE_MODEL` | The underlying model name associated with the deployment. This allows {% data variables.copilot.copilot_cli_short %} to identify model capabilities while Azure routes requests through the deployment specified by `COPILOT_PROVIDER_MODEL_ID`. |
112+
| `COPILOT_PROVIDER_MODEL_ID` | The well-known model name. {% data variables.copilot.copilot_cli_short %} uses this value to identify model capabilities and token limits. |
113+
| `COPILOT_PROVIDER_WIRE_MODEL` | The Azure OpenAI deployment name. Azure OpenAI routes requests through deployments rather than directly through model names. |
112114

113115
{% data reusables.copilot.copilot-cli.start-cli %}
114116

@@ -143,4 +145,3 @@ You can run {% data variables.copilot.copilot_cli_short %} in offline mode to pr
143145
```
144146

145147
1. {% data reusables.copilot.copilot-cli.start-cli %}
146-

0 commit comments

Comments
 (0)