AzureSearchChatExtensionConfiguration Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

Azure.AI.OpenAI v1.0.0-beta.17

Source:

AzureSearchChatExtensionConfiguration.cs

A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat extension.

public class AzureSearchChatExtensionConfiguration : Azure.AI.OpenAI.AzureChatExtensionConfiguration, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.AzureSearchChatExtensionConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.AzureSearchChatExtensionConfiguration>

type AzureSearchChatExtensionConfiguration = class
    inherit AzureChatExtensionConfiguration
    interface IJsonModel<AzureSearchChatExtensionConfiguration>
    interface IPersistableModel<AzureSearchChatExtensionConfiguration>

Public Class AzureSearchChatExtensionConfiguration
Inherits AzureChatExtensionConfiguration
Implements IJsonModel(Of AzureSearchChatExtensionConfiguration), IPersistableModel(Of AzureSearchChatExtensionConfiguration)

Inheritance

Object

AzureChatExtensionConfiguration

AzureSearchChatExtensionConfiguration

Implements

IJsonModel<AzureSearchChatExtensionConfiguration> IPersistableModel<AzureSearchChatExtensionConfiguration> IPersistableModel<T>

Constructors

AzureSearchChatExtensionConfiguration()

Initializes a new instance of AzureSearchChatExtensionConfiguration.

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.
FieldMappingOptions	Customized field mapping behavior to use when interacting with the search index.
Filter	Search filter.
IndexName	The name of the index to use as available in the referenced Azure Cognitive Search resource.
QueryType	The query type to use with Azure Cognitive Search.
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.
SearchEndpoint	The absolute endpoint path for the Azure Cognitive Search resource to use.
SemanticConfiguration	The additional semantic configuration for the query.
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

IJsonModel<AzureChatExtensionConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from AzureChatExtensionConfiguration)
IJsonModel<AzureChatExtensionConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from AzureChatExtensionConfiguration)
IJsonModel<AzureSearchChatExtensionConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureSearchChatExtensionConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AzureChatExtensionConfiguration>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from AzureChatExtensionConfiguration)
IPersistableModel<AzureChatExtensionConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from AzureChatExtensionConfiguration)
IPersistableModel<AzureChatExtensionConfiguration>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from AzureChatExtensionConfiguration)
IPersistableModel<AzureSearchChatExtensionConfiguration>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AzureSearchChatExtensionConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureSearchChatExtensionConfiguration>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.