ChatCompletionSkill interface

Balíček:

@azure/search-documents

Dovednost, která volá jazykový model prostřednictvím koncového bodu dokončování chatu 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 Azure AI Foundry zpracovává další parametry. 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 zadán authResourceId a není zadaný, použije se spravovaná identita přiřazená systémem. Pokud při aktualizacích indexeru není identita určena, hodnota zůstane nezměněna. 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á poskytuje transformace. Tato hodnota by měla být ID aplikace vytvořené pro funkci nebo aplikaci při registraci v Azure Active Directory. Pokud je tato možnost zadaná, vlastní dovednost se připojí k funkci nebo aplikaci pomocí spravovaného ID (buď systémového, nebo přiřazeného uživatelem) vyhledávací služby a přístupového tokenu funkce nebo aplikace, přičemž tato hodnota se použije jako ID prostředku pro vytvoření rozsahu přístupového tokenu.
batchSize	Požadovaná velikost dávky, která udává počet dokladů.
context	Představuje úroveň, na které probíhají operace, jako je kořen dokumentu 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á lze provést do webového rozhraní API.
description	Popis dovednosti, který popisuje vstupy, výstupy a použití dovednosti.
httpHeaders	Hlavičky potřebné k provedení požadavku http.
httpMethod	Metoda pro požadavek http.
inputs	Vstupy dovedností mohou být sloupec ve zdrojové datové sadě nebo výstup nadřazené dovednosti.
name	Název dovednosti, který ji v sadě dovedností jednoznačně identifikuje. Dovednost, která nemá definovaný žádný název, bude mít v poli dovedností výchozí název indexu založeného na hodnotě 1, kterému předchází znak #.
outputs	Výstupem dovednosti je buď pole ve vyhledávacím indexu, nebo hodnota, která může být zpracována 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 Azure AI Foundry zpracovává další parametry. 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 zadán authResourceId a není zadaný, použije se spravovaná identita přiřazená systémem. Pokud při aktualizacích indexeru není identita určena, hodnota zůstane nezměněna. Pokud je nastavena na "none", hodnota této vlastnosti je vymazána.

authIdentity?: SearchIndexerDataIdentity

Hodnota vlastnosti

SearchIndexerDataIdentity

Zděděno zWebApiSkill.authIdentity

authResourceId

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

authResourceId?: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.authResourceId

batchSize

Požadovaná velikost dávky, která udává počet dokladů.

batchSize?: number

Hodnota vlastnosti

number

Zděděno zWebApiSkill.batchSize

context

Představuje úroveň, na které probíhají operace, jako je kořen dokumentu 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á lze provést do webového rozhraní API.

degreeOfParallelism?: number

Hodnota vlastnosti

number

Zděděno zWebApiSkill.degreeOfParallelism

description

Popis dovednosti, který popisuje vstupy, výstupy a použ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 pro požadavek http.

httpMethod?: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.httpMethod

inputs

Vstupy dovedností mohou být sloupec ve zdrojové datové sadě nebo výstup nadřazené dovednosti.

inputs: InputFieldMappingEntry[]

Hodnota vlastnosti

InputFieldMappingEntry[]

Zděděno zWebApiSkill.inputs

name

Název dovednosti, který ji v sadě dovedností jednoznačně identifikuje. Dovednost, která nemá definovaný žádný název, bude mít v poli dovedností výchozí název indexu založeného na hodnotě 1, kterému předchází znak #.

name?: string

Hodnota vlastnosti

string

Zděděno zWebApiSkill.name

outputs

Výstupem dovednosti je buď pole ve vyhledávacím indexu, nebo hodnota, která může být zpracována 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