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

WebApiSkill interface

包:

@azure/search-documents

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

Extends

BaseSearchIndexerSkill

属性

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	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

属性详细信息

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