ElasticsearchChatExtensionConfiguration Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat extension.
public class ElasticsearchChatExtensionConfiguration : Azure.AI.OpenAI.AzureChatExtensionConfiguration, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ElasticsearchChatExtensionConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ElasticsearchChatExtensionConfiguration>type ElasticsearchChatExtensionConfiguration = class
inherit AzureChatExtensionConfiguration
interface IJsonModel<ElasticsearchChatExtensionConfiguration>
interface IPersistableModel<ElasticsearchChatExtensionConfiguration>Public Class ElasticsearchChatExtensionConfiguration
Inherits AzureChatExtensionConfiguration
Implements IJsonModel(Of ElasticsearchChatExtensionConfiguration), IPersistableModel(Of ElasticsearchChatExtensionConfiguration)- Inheritance
- Implements
Constructors
| ElasticsearchChatExtensionConfiguration() |
Initializes a new instance of ElasticsearchChatExtensionConfiguration. |
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. Please note OnYourDataAuthenticationOptions is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include OnYourDataAccessTokenAuthenticationOptions, OnYourDataApiKeyAuthenticationOptions, OnYourDataConnectionStringAuthenticationOptions, OnYourDataEncodedApiKeyAuthenticationOptions, OnYourDataKeyAndKeyIdAuthenticationOptions, OnYourDataSystemAssignedManagedIdentityAuthenticationOptions and OnYourDataUserAssignedManagedIdentityAuthenticationOptions. |
| DocumentCount |
The configured top number of documents to feature for the configured query. |
| Endpoint |
The endpoint of Elasticsearch®. |
| FieldMappingOptions |
The index field mapping options of Elasticsearch®. |
| IndexName |
The index name of Elasticsearch®. |
| QueryType |
The query type of Elasticsearch®. |
| 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. |
| ShouldRestrictResultScope |
Whether queries should be restricted to use of indexed data. |
| Strictness |
The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. |
| VectorizationSource |
The embedding dependency for vector search. Please note OnYourDataVectorizationSource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include OnYourDataDeploymentNameVectorizationSource, OnYourDataEndpointVectorizationSource and OnYourDataModelIdVectorizationSource. |
Explicit Interface Implementations
Applies to
Azure SDK for .NET
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