WebApiSkill interface

Balíček:

@azure/search-documents

Dovednost, která může volat koncový bod webového rozhraní API, což vám umožní rozšířit sadu dovedností tím, že zavolá váš vlastní kód.

Extends

BaseSearchIndexerSkill

Vlastnosti

authIdentity	Spravovaná identita přiřazená uživatelem používaná pro odchozí připojení. Pokud je zadaný identifikátor authResourceId a není zadaný, použije se spravovaná identita přiřazená systémem. Při aktualizacích indexeru, pokud není zadána identita, zůstane hodnota beze změny. Pokud je nastavena na "none", hodnota této vlastnosti je vymazána.
authResourceId	Platí pro vlastní dovednosti, které se připojují k externímu kódu ve funkci Azure nebo v jiné aplikaci, která transformace poskytuje. Tato hodnota by měla být ID aplikace vytvořené pro funkci nebo aplikaci při registraci v Azure Active Directory. Při zadání se vlastní dovednost připojí k funkci nebo aplikaci pomocí spravovaného ID (systému nebo uživatelem přiřazeného) vyhledávací služby a přístupového tokenu funkce nebo aplikace. Tato hodnota se použije jako ID prostředku pro vytvoření oboru přístupového tokenu.
batchSize	Požadovaná velikost dávky označující počet dokumentů.
degreeOfParallelism	Pokud je nastavená, počet paralelních volání, která je možné provést ve webovém rozhraní API.
httpHeaders	Hlavičky potřebné k provedení požadavku HTTP.
httpMethod	Metoda požadavku HTTP.
odatatype	Polymorfní diskriminátor, který určuje různé typy tohoto objektu
timeout	Požadovaný časový limit požadavku Výchozí hodnota je 30 sekund.
uri	Adresa URL webového rozhraní API.

Zděděné vlastnosti

context	Představuje úroveň, na které se provádí operace, například kořenový dokument nebo obsah dokumentu (například /document nebo /document/content). Výchozí hodnota je /document.
description	Popis dovednosti, která popisuje vstupy, výstupy a využití dovednosti.
inputs	Vstupy dovedností můžou být sloupec ve zdrojové sadě dat nebo výstup upstreamové dovednosti.
name	Název dovednosti, která ji jednoznačně identifikuje v sadě dovedností. Dovednost bez definovaného názvu bude mít výchozí název indexu založeného na 1 v poli dovedností s předponou znaku #.
outputs	Výstupem dovednosti je buď pole v indexu vyhledávání, nebo hodnota, kterou lze využívat jako vstup jinou dovedností.

Podrobnosti vlastnosti

authIdentity

Spravovaná identita přiřazená uživatelem používaná pro odchozí připojení. Pokud je zadaný identifikátor authResourceId a není zadaný, použije se spravovaná identita přiřazená systémem. Při aktualizacích indexeru, pokud není zadána identita, zůstane hodnota beze změny. Pokud je nastavena na "none", hodnota této vlastnosti je vymazána.

authIdentity?: SearchIndexerDataIdentity

Hodnota vlastnosti

SearchIndexerDataIdentity

authResourceId

Platí pro vlastní dovednosti, které se připojují k externímu kódu ve funkci Azure nebo v jiné aplikaci, která transformace poskytuje. Tato hodnota by měla být ID aplikace vytvořené pro funkci nebo aplikaci při registraci v Azure Active Directory. Při zadání se vlastní dovednost připojí k funkci nebo aplikaci pomocí spravovaného ID (systému nebo uživatelem přiřazeného) vyhledávací služby a přístupového tokenu funkce nebo aplikace. Tato hodnota se použije jako ID prostředku pro vytvoření oboru přístupového tokenu.

authResourceId?: string

Hodnota vlastnosti

string

batchSize

Požadovaná velikost dávky označující počet dokumentů.

batchSize?: number

Hodnota vlastnosti

number

degreeOfParallelism

Pokud je nastavená, počet paralelních volání, která je možné provést ve webovém rozhraní API.

degreeOfParallelism?: number

Hodnota vlastnosti

number

httpHeaders

Hlavičky potřebné k provedení požadavku HTTP.

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

Hodnota vlastnosti

{[propertyName: string]: string}

httpMethod

Metoda požadavku HTTP.

httpMethod?: string

Hodnota vlastnosti

string

odatatype

Polymorfní diskriminátor, který určuje různé typy tohoto objektu

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

Hodnota vlastnosti

"#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.ChatCompletionSkill"

timeout

Požadovaný časový limit požadavku Výchozí hodnota je 30 sekund.

timeout?: string

Hodnota vlastnosti

string

uri

Adresa URL webového rozhraní API.

uri: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

context

Představuje úroveň, na které se provádí operace, například kořenový dokument nebo obsah dokumentu (například /document nebo /document/content). Výchozí hodnota je /document.

context?: string

Hodnota vlastnosti

string

Zděděno zSearchIndexerSkill.context

description

Popis dovednosti, která popisuje vstupy, výstupy a využití dovednosti.

description?: string

Hodnota vlastnosti

string

Zděděno zSearchIndexerSkill.description

inputs

Vstupy dovedností můžou být sloupec ve zdrojové sadě dat nebo výstup upstreamové dovednosti.

inputs: InputFieldMappingEntry[]

Hodnota vlastnosti

InputFieldMappingEntry[]

Zděděno zSearchIndexerSkill.inputs

name

Název dovednosti, která ji jednoznačně identifikuje v sadě dovedností. Dovednost bez definovaného názvu bude mít výchozí název indexu založeného na 1 v poli dovedností s předponou znaku #.

name?: string

Hodnota vlastnosti

string

Zděděno odSearchIndexerSkill.name

outputs

Výstupem dovednosti je buď pole v indexu vyhledávání, nebo hodnota, kterou lze využívat jako vstup jinou dovedností.

outputs: OutputFieldMappingEntry[]

Hodnota vlastnosti

OutputFieldMappingEntry[]

Zděděno zSearchIndexerSkill.outputs