WebApiSkill interface

Pacchetto:

@azure/search-documents

Una competenza che può chiamare un endpoint API Web, consentendo di estendere un set di competenze tramite la chiamata al codice personalizzato.

Extends

BaseSearchIndexerSkill

Proprietà

authIdentity	Identità gestita assegnata dall'utente usata per le connessioni in uscita. Se viene specificato un authResourceId e non viene specificato, viene usata l'identità gestita assegnata dal sistema. Negli aggiornamenti all'indicizzatore, se l'identità non è specificata, il valore rimane invariato. Se non definito, il valore di questa proprietà viene cancellato.
authResourceId	Si applica alle competenze personalizzate che si connettono a codice esterno in una funzione di Azure o a un'altra applicazione che fornisce le trasformazioni. Questo valore deve essere l'ID applicazione creato per la funzione o l'app quando è stato registrato con Azure Active Directory. Se specificata, la competenza personalizzata si connette alla funzione o all'app usando un ID gestito (sistema o assegnato dall'utente) del servizio di ricerca e il token di accesso della funzione o dell'app, usando questo valore come ID risorsa per creare l'ambito del token di accesso.
batchSize	Dimensione batch desiderata che indica il numero di documenti.
degreeOfParallelism	Se impostato, numero di chiamate parallele che possono essere effettuate all'API Web.
httpHeaders	Intestazioni necessarie per effettuare la richiesta HTTP.
httpMethod	Metodo per la richiesta HTTP.
odatatype	Discriminare polimorfico, che specifica i diversi tipi che questo oggetto può essere
timeout	Timeout desiderato per la richiesta. Il valore predefinito è 30 secondi.
uri	URL per l'API Web.

Proprietà ereditate

context	Rappresenta il livello in cui vengono eseguite le operazioni, ad esempio la radice del documento o il contenuto del documento, ad esempio /document o /document/content. Il valore predefinito è /document.
description	Descrizione della competenza che descrive gli input, gli output e l'utilizzo della competenza.
inputs	Gli input delle competenze possono essere una colonna nel set di dati di origine o l'output di una competenza upstream.
name	Nome della competenza che lo identifica in modo univoco all'interno del set di competenze. A una competenza senza nome definito verrà assegnato un nome predefinito del relativo indice basato su 1 nella matrice di competenze, preceduto dal carattere '#'.
outputs	L'output di una competenza è un campo in un indice di ricerca o un valore che può essere utilizzato come input da un'altra competenza.

Dettagli proprietà

authIdentity

Identità gestita assegnata dall'utente usata per le connessioni in uscita. Se viene specificato un authResourceId e non viene specificato, viene usata l'identità gestita assegnata dal sistema. Negli aggiornamenti all'indicizzatore, se l'identità non è specificata, il valore rimane invariato. Se non definito, il valore di questa proprietà viene cancellato.

authIdentity?: SearchIndexerDataIdentity

Valore della proprietà

SearchIndexerDataIdentity

authResourceId

Si applica alle competenze personalizzate che si connettono a codice esterno in una funzione di Azure o a un'altra applicazione che fornisce le trasformazioni. Questo valore deve essere l'ID applicazione creato per la funzione o l'app quando è stato registrato con Azure Active Directory. Se specificata, la competenza personalizzata si connette alla funzione o all'app usando un ID gestito (sistema o assegnato dall'utente) del servizio di ricerca e il token di accesso della funzione o dell'app, usando questo valore come ID risorsa per creare l'ambito del token di accesso.

authResourceId?: string

Valore della proprietà

string

batchSize

Dimensione batch desiderata che indica il numero di documenti.

batchSize?: number

Valore della proprietà

number

degreeOfParallelism

Se impostato, numero di chiamate parallele che possono essere effettuate all'API Web.

degreeOfParallelism?: number

Valore della proprietà

number

httpHeaders

Intestazioni necessarie per effettuare la richiesta HTTP.

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

Valore della proprietà

{[propertyName: string]: string}

httpMethod

Metodo per la richiesta HTTP.

httpMethod?: string

Valore della proprietà

string

odatatype

Discriminare polimorfico, che specifica i diversi tipi che questo oggetto può essere

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

Valore della proprietà

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

Timeout desiderato per la richiesta. Il valore predefinito è 30 secondi.

timeout?: string

Valore della proprietà

string

uri

URL per l'API Web.

uri: string

Valore della proprietà

string

Dettagli proprietà ereditate

context

Rappresenta il livello in cui vengono eseguite le operazioni, ad esempio la radice del documento o il contenuto del documento, ad esempio /document o /document/content. Il valore predefinito è /document.

context?: string

Valore della proprietà

string

ereditato dabaseSearchIndexerSkill.context

description

Descrizione della competenza che descrive gli input, gli output e l'utilizzo della competenza.

description?: string

Valore della proprietà

string

Ereditato daBaseSearchIndexerSkill.description

inputs

Gli input delle competenze possono essere una colonna nel set di dati di origine o l'output di una competenza upstream.

inputs: InputFieldMappingEntry[]

Valore della proprietà

InputFieldMappingEntry[]

ereditato dabaseSearchIndexerSkill.inputs

name

Nome della competenza che lo identifica in modo univoco all'interno del set di competenze. A una competenza senza nome definito verrà assegnato un nome predefinito del relativo indice basato su 1 nella matrice di competenze, preceduto dal carattere '#'.

name?: string

Valore della proprietà

string

ereditato daBaseSearchIndexerSkill.name

outputs

L'output di una competenza è un campo in un indice di ricerca o un valore che può essere utilizzato come input da un'altra competenza.

outputs: OutputFieldMappingEntry[]

Valore della proprietà

OutputFieldMappingEntry[]

ereditato daBaseSearchIndexerSkill.outputs