elasticsearchChatExtensionParameters

Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.

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.
endpoint	string	The endpoint of Elasticsearch®.
index_name	string	The index name of Elasticsearch®.
fields_mapping	object
query_type	object
embedding_dependency	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/elasticsearchChatExtensionParameters",
  "title": "elasticsearchChatExtensionParameters",
  "required": [
    "authentication",
    "endpoint",
    "index_name"
  ],
  "type": "object",
  "properties": {
    "authentication": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions"
        },
        {
          "$ref": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions"
        }
      ]
    },
    "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 endpoint of Elasticsearch\u00ae.",
      "format": "uri"
    },
    "index_name": {
      "type": "string",
      "description": "The index name of Elasticsearch\u00ae."
    },
    "fields_mapping": {
      "$ref": "#/components/schemas/elasticsearchIndexFieldMappingOptions"
    },
    "query_type": {
      "$ref": "#/components/schemas/elasticsearchQueryType"
    },
    "embedding_dependency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource"
        },
        {
          "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource"
        },
        {
          "$ref": "#/components/schemas/onYourDataModelIdVectorizationSource"
        }
      ]
    }
  },
  "description": "Parameters to use when configuring Elasticsearch\u00ae as an Azure OpenAI chat extension. "
}