次の方法で共有

WebApiSkill interface

  • リファレンス
パッケージ:
@azure/search-documents

Web API エンドポイントを呼び出すことができるスキル。カスタム コードを呼び出すことでスキルセットを拡張できます。

Extends
BaseSearchIndexerSkill

プロパティ

authIdentity

送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて、指定されていない場合は、システム割り当てマネージド ID が使用されます。 インデクサーの更新時に、ID が指定されていない場合、値は変更されません。 未定義の場合、このプロパティの値はクリアされます。
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

送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて、指定されていない場合は、システム割り当てマネージド ID が使用されます。 インデクサーの更新時に、ID が指定されていない場合、値は変更されません。 未定義の場合、このプロパティの値はクリアされます。

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 から継承