Model Config Structure
Each item under models
is part of a list of records, either a boolean value or Object:
When specifying a model as an object:
An object allows for detailed configuration of the model, including its deploymentName
and/or version
. This mode is used for more granular control over the models, especially when working with multiple versions or deployments under one instance or resource group.
Example:
endpoints / azureOpenAI / groups / {group_item} / models / {model_item=Object}
models:
gpt-4-vision-preview:
deploymentName: "gpt-4-vision-preview"
version: "2024-02-15-preview"
Notes:
- Deployment Names and Versions are critical for ensuring that the correct model is used.
- Double-check these values for accuracy to prevent unexpected behavior.
deploymentName
Key:
Key | Type | Description | Example |
---|---|---|---|
deploymentName | String | The name of the deployment for the model. Identifies the deployment of the model within Azure. | This does not have to be the matching OpenAI model name as is convention, but must match the actual name of your deployment on Azure. |
Required: yes
Example:
endpoints / azureOpenAI / groups / {group_item} / models / {model_item=Object} / deploymentName
deploymentName: "gpt-4-vision-preview"
version
Key:
Key | Type | Description | Example |
---|---|---|---|
version | String | Specifies the version of the model. Defines the version of the model to be used. |
Required: yes
Example:
endpoints / azureOpenAI / groups / {group_item} / models / {model_item=Object} / version
version: "2024-02-15-preview"
Enabling a Model with Default Group Configuration
Key:
Key | Type | Description | Example |
---|---|---|---|
models | Boolean | Enables a model with default group configuration. | When a model is enabled (`true`) without using an object, it uses the group's configuration values for deployment name and version. |
Example:
endpoints / azureOpenAI / groups / {group_item} / models
models:
gpt-4-turbo: true