ElasticsearchChatExtensionConfiguration interface
A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat extension.
Properties
| authentication | The authentication method to use when accessing the defined data source. Each data source type supports a specific set of available authentication methods; please see the documentation of the data source for supported mechanisms. If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) authentication. |
| embedding |
The embedding dependency for vector search. |
| endpoint | The endpoint of Elasticsearch®. |
| fields |
The index field mapping options of Elasticsearch®. |
| index |
The index name of Elasticsearch®. |
| in |
Whether queries should be restricted to use of indexed data. |
| query |
The query type of Elasticsearch®. |
| role |
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. |
| strictness | The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. |
| top |
The configured top number of documents to feature for the configured query. |
| type | The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its default value for Elasticsearch®. |
Property Details
authentication
The authentication method to use when accessing the defined data source. Each data source type supports a specific set of available authentication methods; please see the documentation of the data source for supported mechanisms. If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) authentication.
authentication?: OnYourDataAuthenticationOptionsUnionProperty Value
embeddingDependency
The embedding dependency for vector search.
embeddingDependency?: OnYourDataVectorizationSourceUnionProperty Value
endpoint
The endpoint of Elasticsearch®.
endpoint: stringProperty Value
string
fieldsMapping
The index field mapping options of Elasticsearch®.
fieldsMapping?: ElasticsearchIndexFieldMappingOptionsProperty Value
indexName
The index name of Elasticsearch®.
indexName: stringProperty Value
string
inScope
Whether queries should be restricted to use of indexed data.
inScope?: booleanProperty Value
boolean
queryType
The query type of Elasticsearch®.
queryType?: stringProperty Value
string
roleInformation
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.
roleInformation?: stringProperty Value
string
strictness
The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
strictness?: numberProperty Value
number
topNDocuments
The configured top number of documents to feature for the configured query.
topNDocuments?: numberProperty Value
number
type
The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its default value for Elasticsearch®.
type: "elasticsearch"Property Value
"elasticsearch"
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for