WebApiSkill interface

Csomag:

@azure/search-documents

Egy olyan képesség, amely meghívhat egy webes API-végpontot, amely lehetővé teszi, hogy bővítse a képességkészletet az egyéni kód meghívásával.

Extends

BaseSearchIndexerSkill

Tulajdonságok

authIdentity	A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. Ha authResourceId van megadva, és nincs megadva, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az indexelő frissítéseinél, ha az identitás nincs meghatározva, az érték változatlan marad. Ha a "none" értékre van állítva, a tulajdonság értéke törlődik.
authResourceId	Olyan egyéni képességekre vonatkozik, amelyek külső kódhoz csatlakoznak egy Azure-függvényben vagy más, az átalakításokat biztosító alkalmazásban. Ennek az értéknek a függvényhez vagy alkalmazáshoz az Azure Active Directoryban való regisztráláskor létrehozott alkalmazásazonosítónak kell lennie. Ha meg van adva, az egyéni képesség a keresési szolgáltatás felügyelt azonosítójával (rendszer vagy felhasználó által hozzárendelt) és a függvény vagy alkalmazás hozzáférési jogkivonatával csatlakozik a függvényhez vagy alkalmazáshoz, és ezt az értéket használja erőforrás-azonosítóként a hozzáférési jogkivonat hatókörének létrehozásához.
batchSize	A kívánt kötegméret, amely a dokumentumok számát jelzi.
degreeOfParallelism	Ha be van állítva, a webes API-ba indítható párhuzamos hívások száma.
httpHeaders	A http-kérés végrehajtásához szükséges fejlécek.
httpMethod	A http-kérelem metódusa.
odatatype	Polimorfikus diszkriminatív, amely meghatározza az objektum különböző típusait
timeout	A kérés kívánt időtúllépése. Az alapértelmezett érték 30 másodperc.
uri	A webes API URL-címe.

Örökölt tulajdonságok

context	A műveletek végrehajtásának szintjét jelöli, például a dokumentum gyökerét vagy a dokumentum tartalmát (például /document vagy /document/content). Az alapértelmezett érték a /document.
description	A képesség leírása, amely leírja a képesség bemeneteit, kimeneteit és használatát.
inputs	A készségek bemenetei lehetnek a forrásadatkészlet oszlopai, vagy egy felsőbb rétegbeli képesség kimenete.
name	Annak a képességnek a neve, amely egyedileg azonosítja azt a képességkészleten belül. A névvel nem rendelkező képességek a képességtömb 1-alapú indexének alapértelmezett nevét kapják, "#" karakterrel előtaggal.
outputs	A szakértelem kimenete vagy egy keresési index mezője, vagy egy olyan érték, amelyet egy másik képesség bemenetként használhat fel.

Tulajdonság adatai

authIdentity

A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. Ha authResourceId van megadva, és nincs megadva, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az indexelő frissítéseinél, ha az identitás nincs meghatározva, az érték változatlan marad. Ha a "none" értékre van állítva, a tulajdonság értéke törlődik.

authIdentity?: SearchIndexerDataIdentity

Tulajdonság értéke

SearchIndexerDataIdentity

authResourceId

Olyan egyéni képességekre vonatkozik, amelyek külső kódhoz csatlakoznak egy Azure-függvényben vagy más, az átalakításokat biztosító alkalmazásban. Ennek az értéknek a függvényhez vagy alkalmazáshoz az Azure Active Directoryban való regisztráláskor létrehozott alkalmazásazonosítónak kell lennie. Ha meg van adva, az egyéni képesség a keresési szolgáltatás felügyelt azonosítójával (rendszer vagy felhasználó által hozzárendelt) és a függvény vagy alkalmazás hozzáférési jogkivonatával csatlakozik a függvényhez vagy alkalmazáshoz, és ezt az értéket használja erőforrás-azonosítóként a hozzáférési jogkivonat hatókörének létrehozásához.

authResourceId?: string

Tulajdonság értéke

string

batchSize

A kívánt kötegméret, amely a dokumentumok számát jelzi.

batchSize?: number

Tulajdonság értéke

number

degreeOfParallelism

Ha be van állítva, a webes API-ba indítható párhuzamos hívások száma.

degreeOfParallelism?: number

Tulajdonság értéke

number

httpHeaders

A http-kérés végrehajtásához szükséges fejlécek.

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

Tulajdonság értéke

{[propertyName: string]: string}

httpMethod

A http-kérelem metódusa.

httpMethod?: string

Tulajdonság értéke

string

odatatype

Polimorfikus diszkriminatív, amely meghatározza az objektum különböző típusait

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

Tulajdonság értéke

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

timeout

A kérés kívánt időtúllépése. Az alapértelmezett érték 30 másodperc.

timeout?: string

Tulajdonság értéke

string

uri

A webes API URL-címe.

uri: string

Tulajdonság értéke

string

Örökölt tulajdonság részletei

context

A műveletek végrehajtásának szintjét jelöli, például a dokumentum gyökerét vagy a dokumentum tartalmát (például /document vagy /document/content). Az alapértelmezett érték a /document.

context?: string

Tulajdonság értéke

string

A SearchIndexerSkill.contextwebhelyről örökölt

description

A képesség leírása, amely leírja a képesség bemeneteit, kimeneteit és használatát.

description?: string

Tulajdonság értéke

string

A SearchIndexerSkill.descriptionwebhelyről örökölt

inputs

A készségek bemenetei lehetnek a forrásadatkészlet oszlopai, vagy egy felsőbb rétegbeli képesség kimenete.

inputs: InputFieldMappingEntry[]

Tulajdonság értéke

InputFieldMappingEntry[]

A SearchIndexerSkill.inputs fájlbólörökölt

name

Annak a képességnek a neve, amely egyedileg azonosítja azt a képességkészleten belül. A névvel nem rendelkező képességek a képességtömb 1-alapú indexének alapértelmezett nevét kapják, "#" karakterrel előtaggal.

name?: string

Tulajdonság értéke

string

SearchIndexerSkill.name-től örökölt

outputs

A szakértelem kimenete vagy egy keresési index mezője, vagy egy olyan érték, amelyet egy másik képesség bemenetként használhat fel.

outputs: OutputFieldMappingEntry[]

Tulajdonság értéke

OutputFieldMappingEntry[]

A SearchIndexerSkill.outputs fájlbólörökölt