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

WebApiSkill interface

包:

@azure/search-documents

一种可以调用 Web API 终结点的技能，允许你通过调用自定义代码来扩展技能集。

扩展

BaseSearchIndexerSkill

属性

authIdentity	用于出站连接的用户分配的托管标识。 如果未指定 authResourceId，则使用系统分配的托管标识。 对索引器的更新（如果未指定标识）时，该值保持不变。 如果未定义，则清除此属性的值。
authResourceId	适用于连接到 Azure 函数中的外部代码的自定义技能或提供转换的其他应用程序。 此值应该是在向 Azure Active Directory 注册函数或应用时为该函数或应用创建的应用程序 ID。 指定后，自定义技能使用搜索服务的托管 ID（系统或用户分配）和函数或应用的访问令牌连接到函数或应用，使用此值作为创建访问令牌范围的资源 ID。
batchSize	指示文档数的所需批大小。
degreeOfParallelism	如果已设置，则可以对 Web API 进行并行调用的数量。
httpHeaders	发出 http 请求所需的标头。
httpMethod	http 请求的方法。
odatatype	多态鉴别器，它指定此对象可以的不同类型的
timeout	请求的所需超时。 默认值为 30 秒。
uri	Web API 的 URL。

继承属性

context	表示执行操作的级别，例如文档根或文档内容（例如 /document 或 /document/content）。 默认值为 /document。
description	描述技能的说明，描述技能的输入、输出和用法。
inputs	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。

属性详细信息

authIdentity

用于出站连接的用户分配的托管标识。 如果未指定 authResourceId，则使用系统分配的托管标识。 对索引器的更新（如果未指定标识）时，该值保持不变。 如果未定义，则清除此属性的值。

authIdentity?: SearchIndexerDataIdentity

属性值

SearchIndexerDataIdentity

authResourceId

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

authResourceId?: string

属性值

string

batchSize

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

batchSize?: number

属性值

number

degreeOfParallelism

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

degreeOfParallelism?: number

属性值

number

httpHeaders

发出 http 请求所需的标头。

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

属性值

{[propertyName: string]: string}

httpMethod

http 请求的方法。

httpMethod?: string

属性值

string

odatatype

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

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

属性值

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

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

timeout?: string

属性值

string

uri

Web API 的 URL。

uri: string

属性值

string

继承属性详细信息

context

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

context?: string

属性值

string

继承自BaseSearchIndexerSkill.context

description

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

description?: string

属性值

string

继承自BaseSearchIndexerSkill.description

inputs

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

inputs: InputFieldMappingEntry[]

属性值

InputFieldMappingEntry[]

继承自BaseSearchIndexerSkill.inputs

name

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。

name?: string

属性值

string

继承自BaseSearchIndexerSkill.name 的

outputs

技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。

outputs: OutputFieldMappingEntry[]

属性值

OutputFieldMappingEntry[]

继承自baseSearchIndexerSkill.outputs