WebApiSkill interface

Paket:

@azure/search-documents

Ein Skill, der einen Web-API-Endpunkt aufrufen kann, sodass Sie ein Skillset erweitern können, indem Sie ihren benutzerdefinierten Code aufrufen.

Extends

BaseSearchIndexerSkill

Eigenschaften

batchSize	Die gewünschte Batchgröße, die die Anzahl der Dokumente angibt.
degreeOfParallelism	Wenn festgelegt, die Anzahl der parallelen Aufrufe, die an die Web-API ausgeführt werden können.
httpHeaders	Die Header, die für die HTTP-Anforderung erforderlich sind.
httpMethod	Die -Methode für die HTTP-Anforderung.
odatatype	Polymorpher Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann
timeout	Das gewünschte Timeout für die Anforderung. Der Standardwert ist „30 Sekunden“.
uri	Die URL für die Web-API.

Geerbte Eigenschaften

context	Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. den Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.
description	Die Beschreibung des Skills, die die Eingaben, Ausgaben und Die Verwendung des Skills beschreibt.
inputs	Eingaben der Skills können eine Spalte im Quelldatensatz oder die Ausgabe eines Upstream Skills sein.
name	Der Name des Skills, der ihn innerhalb des Skillsets eindeutig identifiziert. Einem Skill ohne definierten Namen wird im Skills-Array ein Standardname des 1-basierten Index zugewiesen, der dem Zeichen #vorangestellt ist.
outputs	Die Ausgabe eines Skills ist entweder ein Feld in einem Suchindex oder ein Wert, der von einem anderen Skill als Eingabe verwendet werden kann.

Details zur Eigenschaft

batchSize

Die gewünschte Batchgröße, die die Anzahl der Dokumente angibt.

batchSize?: number

Eigenschaftswert

number

degreeOfParallelism

Wenn festgelegt, die Anzahl der parallelen Aufrufe, die an die Web-API ausgeführt werden können.

degreeOfParallelism?: number

Eigenschaftswert

number

httpHeaders

Die Header, die für die HTTP-Anforderung erforderlich sind.

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

Eigenschaftswert

{[propertyName: string]: string}

httpMethod

Die -Methode für die HTTP-Anforderung.

httpMethod?: string

Eigenschaftswert

string

odatatype

Polymorpher Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann

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

Eigenschaftswert

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Das gewünschte Timeout für die Anforderung. Der Standardwert ist „30 Sekunden“.

timeout?: string

Eigenschaftswert

string

uri

Die URL für die Web-API.

uri: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

context

Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. den Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.

context?: string

Eigenschaftswert

string

Geerbt vonBaseSearchIndexerSkill.context

description

Die Beschreibung des Skills, die die Eingaben, Ausgaben und Die Verwendung des Skills beschreibt.

description?: string

Eigenschaftswert

string

Geerbt vonBaseSearchIndexerSkill.description

inputs

Eingaben der Skills können eine Spalte im Quelldatensatz oder die Ausgabe eines Upstream Skills sein.

inputs: InputFieldMappingEntry[]

Eigenschaftswert

InputFieldMappingEntry[]

Geerbt vonBaseSearchIndexerSkill.inputs

name

Der Name des Skills, der ihn innerhalb des Skillsets eindeutig identifiziert. Einem Skill ohne definierten Namen wird im Skills-Array ein Standardname des 1-basierten Index zugewiesen, der dem Zeichen #vorangestellt ist.

name?: string

Eigenschaftswert

string

Geerbt vonBaseSearchIndexerSkill.name

outputs

Die Ausgabe eines Skills ist entweder ein Feld in einem Suchindex oder ein Wert, der von einem anderen Skill als Eingabe verwendet werden kann.

outputs: OutputFieldMappingEntry[]

Eigenschaftswert

OutputFieldMappingEntry[]

Geerbt vonBaseSearchIndexerSkill.outputs