ChatCompletionSkill interface

Balíček:

@azure/search-documents

Dovednost, která volá jazykový model přes endpoint Chat Completions v Azure AI Foundry.

Extends

WebApiSkill

Vlastnosti

apiKey	API klíč pro autentizaci k modelu. apiKey i authIdentity nelze zadat současně.
commonModelParameters	Parametry běžného jazykového modelu, které mohou zákazníci vyladit. Pokud je tato možnost vynechána, použije se přiměřené výchozí nastavení.
extraParameters	Slovník otevřeného typu pro parametry specifické pro model, které by měly být připojeny k volání dokončování chatu. Řídí se vzorem rozšiřitelnosti Azure AI Foundry.
extraParametersBehavior	Jak jsou dodatečné parametry řešeny v Azure AI Foundry. Výchozí hodnota je 'error'.
odatatype	Polymorfní diskriminátor, který určuje různé typy tohoto objektu
responseFormat	Určuje, jak má LLM formátovat svou odpověď. Výchozí je typ odpovědi "text".

Zděděné 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í to pro vlastní dovednosti, které se propojují s externím kódem v Azure funkci nebo jiné aplikaci, která tyto 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ů.
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.
degreeOfParallelism	Pokud je nastavená, počet paralelních volání, která je možné provést ve webovém rozhraní API.
description	Popis dovednosti, která popisuje vstupy, výstupy a využití dovednosti.
httpHeaders	Hlavičky potřebné k provedení požadavku HTTP.
httpMethod	Metoda požadavku HTTP.
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í.
timeout	Požadovaný časový limit požadavku Výchozí hodnota je 30 sekund.
uri	Adresa URL webového rozhraní API.

Podrobnosti vlastnosti

apiKey

API klíč pro autentizaci k modelu. apiKey i authIdentity nelze zadat současně.

apiKey?: string

Hodnota vlastnosti

string

commonModelParameters

Parametry běžného jazykového modelu, které mohou zákazníci vyladit. Pokud je tato možnost vynechána, použije se přiměřené výchozí nastavení.

commonModelParameters?: CommonModelParameters

Hodnota vlastnosti

CommonModelParameters

extraParameters

Slovník otevřeného typu pro parametry specifické pro model, které by měly být připojeny k volání dokončování chatu. Řídí se vzorem rozšiřitelnosti Azure AI Foundry.

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

Hodnota vlastnosti

{[propertyName: string]: unknown}

extraParametersBehavior

Jak jsou dodatečné parametry řešeny v Azure AI Foundry. Výchozí hodnota je 'error'.

extraParametersBehavior?: string

Hodnota vlastnosti

string

odatatype

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

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

Hodnota vlastnosti

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

Určuje, jak má LLM formátovat svou odpověď. Výchozí je typ odpovědi "text".

responseFormat?: ChatCompletionResponseFormat

Hodnota vlastnosti

ChatCompletionResponseFormat

Podrobnosti zděděných vlastností

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

Zděděno zWebApiSkill.authIdentity

authResourceId

Platí to pro vlastní dovednosti, které se propojují s externím kódem v Azure funkci nebo jiné aplikaci, která tyto 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

Zděděno zWebApiSkill.authResourceId

batchSize

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

batchSize?: number

Hodnota vlastnosti

number

Zděděno zWebApiSkill.batchSize

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 zWebApiSkill.context

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

Zděděno zWebApiSkill.degreeOfParallelism

description

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

description?: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.description

httpHeaders

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

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

Hodnota vlastnosti

{[propertyName: string]: string}

Zděděno zWebApiSkill.httpHeaders

httpMethod

Metoda požadavku HTTP.

httpMethod?: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.httpMethod

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 zWebApiSkill.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 zWebApiSkill.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 zWebApiSkill.outputs

timeout

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

timeout?: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.timeout

uri

Adresa URL webového rozhraní API.

uri: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.uri