WebApiSkill interface
Eine Fähigkeit, die einen Web-API-Endpunkt aufrufen kann, sodass Sie ein Skillset erweitern können, indem Sie ihren benutzerdefinierten Code aufrufen.
- Extends
Eigenschaften
| auth |
Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId bereitgestellt und nicht angegeben wird, wird die vom System zugewiesene verwaltete Identität verwendet. Bei Aktualisierungen des Indexers bleibt der Wert unverändert, wenn die Identität nicht angegeben ist. Wenn nicht definiert, wird der Wert dieser Eigenschaft gelöscht. |
| auth |
Gilt für benutzerdefinierte Fähigkeiten, die eine Verbindung mit externem Code in einer Azure-Funktion oder einer anderen Anwendung herstellen, die die Transformationen bereitstellt. Dieser Wert sollte die Anwendungs-ID sein, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt die benutzerdefinierte Fähigkeit eine Verbindung mit der Funktion oder App mithilfe einer verwalteten ID (entweder system oder vom Benutzer zugewiesen) des Suchdiensts und dem Zugriffstoken der Funktion oder App mithilfe dieses Werts als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens. |
| batch |
Die gewünschte Batchgröße, die die Anzahl der Dokumente angibt. |
| degree |
Bei Festlegung wird die Anzahl der parallelen Aufrufe, die an die Web-API vorgenommen werden können, ausgeführt. |
| http |
Die Header, die zum Erstellen der HTTP-Anforderung erforderlich sind. |
| http |
Die Methode für die HTTP-Anforderung. |
| odatatype | Polymorphe 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. der Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document. |
| description | Die Beschreibung der Fähigkeiten, die die Eingaben, Ausgaben und die Nutzung der Fähigkeiten beschreibt. |
| inputs | Eingaben der Fähigkeiten können eine Spalte im Quelldatensatz oder die Ausgabe einer upstream-Fähigkeit sein. |
| name | Der Name der Fähigkeit, die sie innerhalb des Skillsets eindeutig identifiziert. Eine Fähigkeit ohne definierten Namen erhält einen Standardnamen des 1-basierten Indexes im Kompetenzarray, dem das Zeichen "#" vorangestellt ist. |
| outputs | Die Ausgabe einer Fähigkeit ist entweder ein Feld in einem Suchindex oder ein Wert, der als Eingabe durch eine andere Fähigkeit genutzt werden kann. |
Details zur Eigenschaft
authIdentity
Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId bereitgestellt und nicht angegeben wird, wird die vom System zugewiesene verwaltete Identität verwendet. Bei Aktualisierungen des Indexers bleibt der Wert unverändert, wenn die Identität nicht angegeben ist. Wenn nicht definiert, wird der Wert dieser Eigenschaft gelöscht.
authIdentity?: SearchIndexerDataIdentityEigenschaftswert
authResourceId
Gilt für benutzerdefinierte Fähigkeiten, die eine Verbindung mit externem Code in einer Azure-Funktion oder einer anderen Anwendung herstellen, die die Transformationen bereitstellt. Dieser Wert sollte die Anwendungs-ID sein, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt die benutzerdefinierte Fähigkeit eine Verbindung mit der Funktion oder App mithilfe einer verwalteten ID (entweder system oder vom Benutzer zugewiesen) des Suchdiensts und dem Zugriffstoken der Funktion oder App mithilfe dieses Werts als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens.
authResourceId?: stringEigenschaftswert
string
batchSize
Die gewünschte Batchgröße, die die Anzahl der Dokumente angibt.
batchSize?: numberEigenschaftswert
number
degreeOfParallelism
Bei Festlegung wird die Anzahl der parallelen Aufrufe, die an die Web-API vorgenommen werden können, ausgeführt.
degreeOfParallelism?: numberEigenschaftswert
number
httpHeaders
Die Header, die zum Erstellen der HTTP-Anforderung erforderlich sind.
httpHeaders?: {[propertyName: string]: string}Eigenschaftswert
{[propertyName: string]: string}
httpMethod
Die Methode für die HTTP-Anforderung.
httpMethod?: stringEigenschaftswert
string
odatatype
Polymorphe 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?: stringEigenschaftswert
string
uri
Die URL für die Web-API.
uri: stringEigenschaftswert
string
Geerbte Eigenschaftsdetails
context
Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. der Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.
context?: stringEigenschaftswert
string
geerbt vonBaseSearchIndexerSkill.context
description
Die Beschreibung der Fähigkeiten, die die Eingaben, Ausgaben und die Nutzung der Fähigkeiten beschreibt.
description?: stringEigenschaftswert
string
geerbt vonBaseSearchIndexerSkill.description
inputs
Eingaben der Fähigkeiten können eine Spalte im Quelldatensatz oder die Ausgabe einer upstream-Fähigkeit sein.
inputs: InputFieldMappingEntry[]Eigenschaftswert
name
Der Name der Fähigkeit, die sie innerhalb des Skillsets eindeutig identifiziert. Eine Fähigkeit ohne definierten Namen erhält einen Standardnamen des 1-basierten Indexes im Kompetenzarray, dem das Zeichen "#" vorangestellt ist.
name?: stringEigenschaftswert
string
geerbt vonBaseSearchIndexerSkill.name
outputs
Die Ausgabe einer Fähigkeit ist entweder ein Feld in einem Suchindex oder ein Wert, der als Eingabe durch eine andere Fähigkeit genutzt werden kann.
outputs: OutputFieldMappingEntry[]