ChatCompletionSkill interface

Csomag:

@azure/search-documents

Egy olyan képesség, amely az Azure AI Foundry Chat Completions végpontján keresztül hív nyelvi modellt.

Extends

WebApiSkill

Tulajdonságok

apiKey	API-kulcs a modellben való hitelesítéshez. Az apiKey és az authIdentity nem adható meg egyszerre.
commonModelParameters	Az ügyfelek által módosítható közös nyelvi modellparaméterek. Ha nincs megadva, ésszerű alapértelmezett értékeket alkalmazunk.
extraParameters	Nyitott típusú szótár a modellspecifikus paraméterekhez, amelyeket hozzá kell fűzni a csevegés befejezési hívásához. Az Azure AI Foundry bővíthetőségi mintáját követi.
extraParametersBehavior	Hogyan kezeli az extra paramétereket az Azure AI Foundry. Az alapértelmezett érték az "error".
odatatype	Polimorfikus diszkriminatív, amely meghatározza az objektum különböző típusait
responseFormat	Meghatározza, hogy az LLM hogyan formázza a válaszát. Alapértelmezés szerint a "szöveg" választípus.

Örökölt 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	Alkalmazható egyedi képességekre, amelyek egy Azure függvényben vagy más alkalmazásban lévő külső kódhoz kapcsolódnak, amely az átalakításokat biztosítja. Ennek az értéknek az alkalmazásazonosítónak kell lennie, amelyet a függvényhez vagy alkalmazáshoz hoztak létre, amikor az Azure Active Directory-ban regisztrált. 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.
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.
degreeOfParallelism	Ha be van állítva, a webes API-ba indítható párhuzamos hívások száma.
description	A képesség leírása, amely leírja a képesség bemeneteit, kimeneteit és használatát.
httpHeaders	A http-kérés végrehajtásához szükséges fejlécek.
httpMethod	A http-kérelem metódusa.
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.
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.

Tulajdonság adatai

apiKey

API-kulcs a modellben való hitelesítéshez. Az apiKey és az authIdentity nem adható meg egyszerre.

apiKey?: string

Tulajdonság értéke

string

commonModelParameters

Az ügyfelek által módosítható közös nyelvi modellparaméterek. Ha nincs megadva, ésszerű alapértelmezett értékeket alkalmazunk.

commonModelParameters?: CommonModelParameters

Tulajdonság értéke

CommonModelParameters

extraParameters

Nyitott típusú szótár a modellspecifikus paraméterekhez, amelyeket hozzá kell fűzni a csevegés befejezési hívásához. Az Azure AI Foundry bővíthetőségi mintáját követi.

extraParameters?: {[propertyName: string]: unknown}

Tulajdonság értéke

{[propertyName: string]: unknown}

extraParametersBehavior

Hogyan kezeli az extra paramétereket az Azure AI Foundry. Az alapértelmezett érték az "error".

extraParametersBehavior?: 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"

Tulajdonság értéke

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Meghatározza, hogy az LLM hogyan formázza a válaszát. Alapértelmezés szerint a "szöveg" választípus.

responseFormat?: ChatCompletionResponseFormat

Tulajdonság értéke

ChatCompletionResponseFormat

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

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

A WebApiSkill.authIdentitywebhelyről örökölt

authResourceId

Alkalmazható egyedi képességekre, amelyek egy Azure függvényben vagy más alkalmazásban lévő külső kódhoz kapcsolódnak, amely az átalakításokat biztosítja. Ennek az értéknek az alkalmazásazonosítónak kell lennie, amelyet a függvényhez vagy alkalmazáshoz hoztak létre, amikor az Azure Active Directory-ban regisztrált. 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

A WebApiSkill.authResourceIdwebhelyről örökölt

batchSize

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

batchSize?: number

Tulajdonság értéke

number

A WebApiSkill.batchSizewebhelyről örökölt

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 WebApiSkill.contextwebhelyről örökölt

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

A WebApiSkill.degreeOfParallelismwebhelyrő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 WebApiSkill.descriptionwebhelyről örökölt

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}

A WebApiSkill.httpHeaders webhelyrőlörökölt

httpMethod

A http-kérelem metódusa.

httpMethod?: string

Tulajdonság értéke

string

A WebApiSkill.httpMethod-tó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 WebApiSkill.inputs webhelyrő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

WebApiSkill.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 WebApiSkill.outputs webhelyrőlörökölt

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

A WebApiSkill.timeoutwebhelyről örökölt

uri

A webes API URL-címe.

uri: string

Tulajdonság értéke

string

A WebApiSkill.uriwebhelyről örökölt