WebApiSkill interface

Paquet:

@azure/search-documents

Compétence qui peut appeler un point de terminaison d’API web, ce qui vous permet d’étendre un ensemble de compétences en le faisant appeler votre code personnalisé.

Extends

BaseSearchIndexerSkill

Propriétés

authIdentity	Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes. Si une authResourceId est fournie et qu’elle n’est pas spécifiée, l’identité managée affectée par le système est utilisée. Lors des mises à jour de l’indexeur, si l’identité n’est pas spécifiée, la valeur reste inchangée. Si elle n’est pas définie, la valeur de cette propriété est effacée.
authResourceId	S’applique aux compétences personnalisées qui se connectent au code externe dans une fonction Azure ou une autre application qui fournit les transformations. Cette valeur doit être l’ID d’application créé pour la fonction ou l’application lorsqu’elle a été inscrite auprès d’Azure Active Directory. Quand elle est spécifiée, la compétence personnalisée se connecte à la fonction ou à l’application à l’aide d’un ID managé (système ou affecté par l’utilisateur) du service de recherche et du jeton d’accès de la fonction ou de l’application, en utilisant cette valeur comme ID de ressource pour créer l’étendue du jeton d’accès.
batchSize	Taille de lot souhaitée qui indique le nombre de documents.
degreeOfParallelism	Si elle est définie, le nombre d’appels parallèles qui peuvent être effectués à l’API web.
httpHeaders	En-têtes requis pour effectuer la requête http.
httpMethod	Méthode de la requête http.
odatatype	Discriminateur polymorphe, qui spécifie les différents types que cet objet peut être
timeout	Délai d’expiration souhaité pour la requête. La valeur par défaut est de 30 secondes.
uri	URL de l’API web.

Propriétés héritées

context	Représente le niveau auquel les opérations se produisent, telles que la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.
description	Description de la compétence qui décrit les entrées, sorties et utilisation de la compétence.
inputs	Les entrées des compétences peuvent être une colonne dans le jeu de données source ou la sortie d’une compétence en amont.
name	Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini reçoit un nom par défaut de son index basé sur 1 dans le tableau de compétences, précédé du caractère « # ».
outputs	La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée comme entrée par une autre compétence.

Détails de la propriété

authIdentity

Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes. Si une authResourceId est fournie et qu’elle n’est pas spécifiée, l’identité managée affectée par le système est utilisée. Lors des mises à jour de l’indexeur, si l’identité n’est pas spécifiée, la valeur reste inchangée. Si elle n’est pas définie, la valeur de cette propriété est effacée.

authIdentity?: SearchIndexerDataIdentity

Valeur de propriété

SearchIndexerDataIdentity

authResourceId

S’applique aux compétences personnalisées qui se connectent au code externe dans une fonction Azure ou une autre application qui fournit les transformations. Cette valeur doit être l’ID d’application créé pour la fonction ou l’application lorsqu’elle a été inscrite auprès d’Azure Active Directory. Quand elle est spécifiée, la compétence personnalisée se connecte à la fonction ou à l’application à l’aide d’un ID managé (système ou affecté par l’utilisateur) du service de recherche et du jeton d’accès de la fonction ou de l’application, en utilisant cette valeur comme ID de ressource pour créer l’étendue du jeton d’accès.

authResourceId?: string

Valeur de propriété

string

batchSize

Taille de lot souhaitée qui indique le nombre de documents.

batchSize?: number

Valeur de propriété

number

degreeOfParallelism

Si elle est définie, le nombre d’appels parallèles qui peuvent être effectués à l’API web.

degreeOfParallelism?: number

Valeur de propriété

number

httpHeaders

En-têtes requis pour effectuer la requête http.

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

Valeur de propriété

{[propertyName: string]: string}

httpMethod

Méthode de la requête http.

httpMethod?: string

Valeur de propriété

string

odatatype

Discriminateur polymorphe, qui spécifie les différents types que cet objet peut être

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

Valeur de propriété

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Délai d’expiration souhaité pour la requête. La valeur par défaut est de 30 secondes.

timeout?: string

Valeur de propriété

string

uri

URL de l’API web.

uri: string

Valeur de propriété

string

Détails de la propriété héritée

context

Représente le niveau auquel les opérations se produisent, telles que la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.

context?: string

Valeur de propriété

string

héritée deBaseSearchIndexerSkill.context

description

Description de la compétence qui décrit les entrées, sorties et utilisation de la compétence.

description?: string

Valeur de propriété

string

héritée deBaseSearchIndexerSkill.description

inputs

Les entrées des compétences peuvent être une colonne dans le jeu de données source ou la sortie d’une compétence en amont.

inputs: InputFieldMappingEntry[]

Valeur de propriété

InputFieldMappingEntry[]

héritée deBaseSearchIndexerSkill.inputs

name

Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini reçoit un nom par défaut de son index basé sur 1 dans le tableau de compétences, précédé du caractère « # ».

name?: string

Valeur de propriété

string

héritée deBaseSearchIndexerSkill.name

outputs

La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée comme entrée par une autre compétence.

outputs: OutputFieldMappingEntry[]

Valeur de propriété

OutputFieldMappingEntry[]

héritée deBaseSearchIndexerSkill.outputs