Microsoft Azure · Schema

azureChatExtensionType

A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI chat extensions to augment the response behavior. The use of this configuration is compatible only with Azure OpenAI.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1
View JSON Schema on GitHub

JSON Schema

microsoft-azure-azurechatextensiontype-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/azureChatExtensionType",
  "title": "azureChatExtensionType",
  "type": "string",
  "description": "  A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n  completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n  The use of this configuration is compatible only with Azure OpenAI.",
  "enum": [
    "azure_search",
    "azure_ml_index",
    "azure_cosmos_db",
    "elasticsearch",
    "pinecone"
  ],
  "x-ms-enum": {
    "name": "AzureChatExtensionType",
    "modelAsString": true,
    "values": [
      {
        "name": "azureSearch",
        "value": "azure_search",
        "description": "Represents the use of Azure Search as an Azure OpenAI chat extension."
      },
      {
        "name": "azureMachineLearningIndex",
        "value": "azure_ml_index",
        "description": "Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension."
      },
      {
        "name": "azureCosmosDB",
        "value": "azure_cosmos_db",
        "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension."
      },
      {
        "name": "elasticsearch",
        "value": "elasticsearch",
        "description": "Represents the use of Elasticsearch\u00ae index as an Azure OpenAI chat extension."
      },
      {
        "name": "pinecone",
        "value": "pinecone",
        "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension."
      }
    ]
  }
}