ChatCompletionSkill interface

包:

@azure/search-documents

通过 Azure AI Foundry 的聊天完成终结点调用语言模型的技能。

扩展

WebApiSkill

属性

apiKey	用于向模型进行身份验证的 API 密钥。 apiKey 和 authIdentity 不能同时指定。
commonModelParameters	客户可以调整的通用语言模型参数。 如果省略，将应用合理的违约。
extraParameters	应追加到聊天完成调用的特定于模型的参数的开放类型字典。 遵循 Azure AI Foundry 的可扩展性模式。
extraParametersBehavior	Azure AI Foundry 如何处理额外参数。 默认值为“error”。
odatatype	多态鉴别器，它指定此对象可以的不同类型的
responseFormat	确定 LLM 应如何格式化其响应。 默认为“文本”响应类型。

继承属性

authIdentity	用于出站连接的用户分配的托管标识。 如果提供了 authResourceId 但未指定，则使用系统分配的托管标识。 在更新索引器时，如果未指定标识，则该值保持不变。 如果设置为“none”，则清除此属性的值。
authResourceId	适用于连接到 Azure 函数中的外部代码或提供转换的其他应用程序中的自定义技能。 此值应是向 Azure Active Directory 注册时为函数或应用创建的应用程序 ID。 指定后，自定义技能使用搜索服务的托管 ID（系统或用户分配）和函数或应用的访问令牌连接到函数或应用，并将此值用作创建访问令牌范围的资源 ID。
batchSize	指示文档数量的所需批大小。
context	表示执行作的级别，例如文档根目录或文档内容（例如，/document 或 /document/content）。 默认值为 /document。
degreeOfParallelism	如果设置，则可以对 Web API 进行的并行调用数。
description	描述技能的描述，描述技能的输入、输出和用法。
httpHeaders	发出 http 请求所需的标头。
httpMethod	http 请求的方法。
inputs	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	在技能集中唯一标识它的技能的名称。 未定义名称的技能将在技能数组中为其从 1 开始的索引的默认名称，前缀为字符“#”。
outputs	技能的输出要么是搜索索引中的字段，要么是可作为其他技能输入使用的值。
timeout	请求的所需超时。 默认值为 30 秒。
uri	Web API 的 URL。

属性详细信息

apiKey

用于向模型进行身份验证的 API 密钥。 apiKey 和 authIdentity 不能同时指定。

apiKey?: string

属性值

string

commonModelParameters

客户可以调整的通用语言模型参数。 如果省略，将应用合理的违约。

commonModelParameters?: CommonModelParameters

属性值

CommonModelParameters

extraParameters

应追加到聊天完成调用的特定于模型的参数的开放类型字典。 遵循 Azure AI Foundry 的可扩展性模式。

extraParameters?: {[propertyName: string]: unknown}

属性值

{[propertyName: string]: unknown}

extraParametersBehavior

Azure AI Foundry 如何处理额外参数。 默认值为“error”。

extraParametersBehavior?: string

属性值

string

odatatype

多态鉴别器，它指定此对象可以的不同类型的

odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill"

属性值

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

确定 LLM 应如何格式化其响应。 默认为“文本”响应类型。

responseFormat?: ChatCompletionResponseFormat

属性值

ChatCompletionResponseFormat

继承属性详细信息

authIdentity

用于出站连接的用户分配的托管标识。 如果提供了 authResourceId 但未指定，则使用系统分配的托管标识。 在更新索引器时，如果未指定标识，则该值保持不变。 如果设置为“none”，则清除此属性的值。

authIdentity?: SearchIndexerDataIdentity

属性值

SearchIndexerDataIdentity

继承自WebApiSkill.authIdentity

authResourceId

适用于连接到 Azure 函数中的外部代码或提供转换的其他应用程序中的自定义技能。 此值应是向 Azure Active Directory 注册时为函数或应用创建的应用程序 ID。 指定后，自定义技能使用搜索服务的托管 ID（系统或用户分配）和函数或应用的访问令牌连接到函数或应用，并将此值用作创建访问令牌范围的资源 ID。

authResourceId?: string

属性值

string

继承自WebApiSkill.authResourceId

batchSize

指示文档数量的所需批大小。

batchSize?: number

属性值

number

继承自WebApiSkill.batchSize

context

表示执行作的级别，例如文档根目录或文档内容（例如，/document 或 /document/content）。 默认值为 /document。

context?: string

属性值

string

继承自WebApiSkill.context

degreeOfParallelism

如果设置，则可以对 Web API 进行的并行调用数。

degreeOfParallelism?: number

属性值

number

继承自WebApiSkill.degreeOfParallelism

description

描述技能的描述，描述技能的输入、输出和用法。

description?: string

属性值

string

继承自WebApiSkill.description

httpHeaders

发出 http 请求所需的标头。

httpHeaders?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自WebApiSkill.httpHeaders

httpMethod

http 请求的方法。

httpMethod?: string

属性值

string

继承自WebApiSkill.httpMethod

inputs

技能的输入可以是源数据集中的列，也可以是上游技能的输出。

inputs: InputFieldMappingEntry[]

属性值

InputFieldMappingEntry[]

继承自WebApiSkill.inputs

name

在技能集中唯一标识它的技能的名称。 未定义名称的技能将在技能数组中为其从 1 开始的索引的默认名称，前缀为字符“#”。

name?: string

属性值

string

继承自 WebApiSkill.name

outputs

技能的输出要么是搜索索引中的字段，要么是可作为其他技能输入使用的值。

outputs: OutputFieldMappingEntry[]

属性值

OutputFieldMappingEntry[]

继承自WebApiSkill.outputs

timeout

请求的所需超时。 默认值为 30 秒。

timeout?: string

属性值

string

继承自WebApiSkill.timeout

uri

Web API 的 URL。

uri: string

属性值

string

继承自WebApiSkill.uri