azureSearchChatExtensionParameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/azureSearchChatExtensionParameters",
  "title": "azureSearchChatExtensionParameters",
  "required": [
    "authentication",
    "endpoint",
    "index_name"
  ],
  "type": "object",
  "properties": {
    "authentication": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions"
        },
        {
          "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions"
        },
        {
          "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions"
        }
      ]
    },
    "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."
    },
    "endpoint": {
      "type": "string",
      "description": "The absolute endpoint path for the Azure Search resource to use.",
      "format": "uri"
    },
    "index_name": {
      "type": "string",
      "description": "The name of the index to use as available in the referenced Azure Search resource."
    },
    "fields_mapping": {
      "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions"
    },
    "query_type": {
      "$ref": "#/components/schemas/azureSearchQueryType"
    },
    "semantic_configuration": {
      "type": "string",
      "description": "The additional semantic configuration for the query."
    },
    "filter": {
      "type": "string",
      "description": "Search filter."
    },
    "embedding_dependency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource"
        },
        {
          "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource"
        }
      ]
    }
  },
  "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension."
}