你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AzureSearchChatExtensionConfiguration interface

包:

@azure/openai

将 Azure 搜索 用作 Azure OpenAI 聊天扩展时的可配置选项的特定表示形式。

Extends

AzureChatExtensionConfiguration

属性

authentication	访问定义的数据源时使用的身份验证方法。 每个数据源类型都支持一组特定的可用身份验证方法;有关支持的机制，请参阅数据源的文档。 如果未提供其他凭据，“数据上的”将尝试使用系统托管标识 (默认凭据) 身份验证。
embeddingDependency	矢量搜索的嵌入依赖项。
endpoint	要使用的Azure 认知搜索资源的绝对终结点路径。
fieldsMapping	与搜索索引交互时要使用的自定义字段映射行为。
filter	搜索筛选器。
indexName	在引用的Azure 认知搜索资源中用作可用索引的名称。
inScope	是否应将查询限制为使用索引数据。
queryType	要与 Azure 认知搜索 一起使用的查询类型。
roleInformation	为模型提供有关它应该如何运行以及在生成回复时应引用的任何上下文的说明。 可以描述助手的个性，并告诉它如何设置响应的格式。 有 100 个令牌限制，它计入总体令牌限制。
semanticConfiguration	查询的其他语义配置。
strictness	搜索相关性筛选的配置严格性。 严格性越高，精度越高，但答案的召回率越低。
topNDocuments	要为配置的查询提供的文档数。
type	配置 Azure OpenAI 聊天扩展时要使用的类型标签。 通常不应将其默认值更改为Azure 认知搜索。

属性详细信息

authentication

访问定义的数据源时使用的身份验证方法。 每个数据源类型都支持一组特定的可用身份验证方法;有关支持的机制，请参阅数据源的文档。 如果未提供其他凭据，“数据上的”将尝试使用系统托管标识 (默认凭据) 身份验证。

authentication?: OnYourDataAuthenticationOptionsUnion

属性值

OnYourDataAuthenticationOptionsUnion

embeddingDependency

矢量搜索的嵌入依赖项。

embeddingDependency?: OnYourDataVectorizationSourceUnion

属性值

OnYourDataVectorizationSourceUnion

endpoint

要使用的Azure 认知搜索资源的绝对终结点路径。

endpoint: string

属性值

string

fieldsMapping

与搜索索引交互时要使用的自定义字段映射行为。

fieldsMapping?: AzureSearchIndexFieldMappingOptions

属性值

AzureSearchIndexFieldMappingOptions

filter

搜索筛选器。

filter?: string

属性值

string

indexName

在引用的Azure 认知搜索资源中用作可用索引的名称。

indexName: string

属性值

string

inScope

是否应将查询限制为使用索引数据。

inScope?: boolean

属性值

boolean

queryType

要与 Azure 认知搜索 一起使用的查询类型。

queryType?: string

属性值

string

roleInformation

为模型提供有关它应该如何运行以及在生成回复时应引用的任何上下文的说明。 可以描述助手的个性，并告诉它如何设置响应的格式。 有 100 个令牌限制，它计入总体令牌限制。

roleInformation?: string

属性值

string

semanticConfiguration

查询的其他语义配置。

semanticConfiguration?: string

属性值

string

strictness

搜索相关性筛选的配置严格性。 严格性越高，精度越高，但答案的召回率越低。

strictness?: number

属性值

number

topNDocuments

要为配置的查询提供的文档数。

topNDocuments?: number

属性值

number

type

配置 Azure OpenAI 聊天扩展时要使用的类型标签。 通常不应将其默认值更改为Azure 认知搜索。

type: "azure_search"

属性值

"azure_search"