Microsoft Azure · Schema

azureCosmosDBChatExtensionParameters

Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for MongoDB vCore.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
authentication	object
top_n_documents	integer	The configured top number of documents to feature for the configured query.
in_scope	boolean	Whether queries should be restricted to use of indexed data.
strictness	integer	The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
role_information	string	Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses.
database_name	string	The MongoDB vCore database name to use with Azure Cosmos DB.
container_name	string	The name of the Azure Cosmos DB resource container.
index_name	string	The MongoDB vCore index name to use with Azure Cosmos DB.
fields_mapping	object
embedding_dependency	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/azureCosmosDBChatExtensionParameters",
  "title": "azureCosmosDBChatExtensionParameters",
  "required": [
    "authentication",
    "container_name",
    "database_name",
    "embedding_dependency",
    "fields_mapping",
    "index_name"
  ],
  "type": "object",
  "properties": {
    "authentication": {
      "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions"
    },
    "top_n_documents": {
      "type": "integer",
      "description": "The configured top number of documents to feature for the configured query.",
      "format": "int32"
    },
    "in_scope": {
      "type": "boolean",
      "description": "Whether queries should be restricted to use of indexed data."
    },
    "strictness": {
      "maximum": 5,
      "minimum": 1,
      "type": "integer",
      "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.",
      "format": "int32"
    },
    "role_information": {
      "type": "string",
      "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit."
    },
    "database_name": {
      "type": "string",
      "description": "The MongoDB vCore database name to use with Azure Cosmos DB."
    },
    "container_name": {
      "type": "string",
      "description": "The name of the Azure Cosmos DB resource container."
    },
    "index_name": {
      "type": "string",
      "description": "The MongoDB vCore index name to use with Azure Cosmos DB."
    },
    "fields_mapping": {
      "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions"
    },
    "embedding_dependency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource"
        },
        {
          "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource"
        }
      ]
    }
  },
  "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore."
}