WebApiSkill interface

套件:

@azure/search-documents

可呼叫 Web API 端點的技能，可讓您藉由呼叫自定義程式代碼來擴充技能集。

Extends

BaseSearchIndexerSkill

屬性

authIdentity	用於輸出連線的使用者指派受控識別。 如果提供 authResourceId 且未指定，則會使用系統指派的受控識別。 在索引器更新時，如果未指定身分識別，該值會維持不變。 如果未定義，則會清除這個屬性的值。
authResourceId	適用於連線至 Azure 函式中外部程式代碼的自定義技能，或提供轉換的一些其他應用程式。 當函式或應用程式向 Azure Active Directory 註冊時，此值應該是為該函式或應用程式所建立的應用程式識別碼。 指定時，自定義技能會使用搜尋服務的受控標識碼（系統或使用者指派）和函式或應用程式的存取令牌，使用此值作為建立存取令牌範圍的資源標識符，聯機到函式或應用程式的函式或應用程式。
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 註冊時，此值應該是為該函式或應用程式所建立的應用程式識別碼。 指定時，自定義技能會使用搜尋服務的受控標識碼（系統或使用者指派）和函式或應用程式的存取令牌，使用此值作為建立存取令牌範圍的資源標識符，聯機到函式或應用程式的函式或應用程式。

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