AzureSearchChatExtensionConfiguration interface

Package:

@azure/openai

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

Extends

AzureChatExtensionConfiguration

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.
embeddingDependency	The embedding dependency for vector search.
endpoint	The absolute endpoint path for the Azure Cognitive Search resource to use.
fieldsMapping	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.
inScope	Whether queries should be restricted to use of indexed data.
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.
semanticConfiguration	The additional semantic configuration for the query.
strictness	The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.
topNDocuments	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 Azure Cognitive Search.

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?: OnYourDataAuthenticationOptionsUnion

Property Value

OnYourDataAuthenticationOptionsUnion

embeddingDependency

The embedding dependency for vector search.

embeddingDependency?: OnYourDataVectorizationSourceUnion

Property Value

OnYourDataVectorizationSourceUnion

endpoint

The absolute endpoint path for the Azure Cognitive Search resource to use.

endpoint: string

Property Value

string

fieldsMapping

Customized field mapping behavior to use when interacting with the search index.

fieldsMapping?: AzureSearchIndexFieldMappingOptions

Property Value

AzureSearchIndexFieldMappingOptions

filter

Search filter.

filter?: string

Property Value

string

indexName

The name of the index to use as available in the referenced Azure Cognitive Search resource.

indexName: string

Property Value

string

inScope

Whether queries should be restricted to use of indexed data.

inScope?: boolean

Property Value

boolean

queryType

The query type to use with Azure Cognitive Search.

queryType?: string

Property 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?: string

Property Value

string

semanticConfiguration

The additional semantic configuration for the query.

semanticConfiguration?: string

Property 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?: number

Property Value

number

topNDocuments

The configured top number of documents to feature for the configured query.

topNDocuments?: number

Property 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 Azure Cognitive Search.

type: "azure_search"

Property Value

"azure_search"