@azure-rest/ai-inference package
Rozhraní
| ChatChoiceOutput |
Reprezentace jednoho dokončení výzvy jako součást celkové žádosti o dokončení chatu.
Obecně platí, že |
| ChatCompletionsNamedToolChoice |
Výběr nástroje konkrétního pojmenovaného nástroje funkce, který omezí dokončení chatu na používání pojmenované funkce. |
| ChatCompletionsNamedToolChoiceFunction |
Výběr nástroje konkrétního pojmenovaného nástroje funkce, který omezí dokončení chatu na používání pojmenované funkce. |
| ChatCompletionsOutput |
Reprezentace dat odpovědí z žádosti o dokončení chatu Dokončení podporují širokou škálu úkolů a generují text, který pokračuje od nebo "dokončených" zadaných dat výzvy. |
| ChatCompletionsResponseFormatJsonObject |
Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON. Všimněte si, že pokud chcete povolit režim JSON, některé modely AI můžou také vyžadovat, abyste model instruoval, aby vytvořil JSON prostřednictvím systémové nebo uživatelské zprávy. |
| ChatCompletionsResponseFormatJsonSchema |
Formát odpovědi pro dokončování chatu, který omezuje odpovědi na generování platných objektů JSON se schématem JSON určeným volajícím. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
Definuje formát odpovědi pro dokončování chatu jako JSON s daným schématem. Model AI bude muset při generování dokončení dodržovat toto schéma. |
| ChatCompletionsResponseFormatParent |
Představuje formát, který musí model vypíše. Tuto možnost použijte k povolení režimu JSON místo výchozího textového režimu. Všimněte si, že pokud chcete povolit režim JSON, některé modely AI můžou také vyžadovat, abyste model instruoval, aby vytvořil JSON prostřednictvím systémové nebo uživatelské zprávy. |
| ChatCompletionsResponseFormatText |
Formát odpovědi pro dokončování chatu, který generuje textové odpovědi. Toto je výchozí formát odpovědi. |
| ChatCompletionsToolCall |
Volání nástroje funkcí požadované modelem AI |
| ChatCompletionsToolCallOutput |
Volání nástroje funkcí požadované modelem AI |
| ChatCompletionsToolDefinition |
Definice nástroje pro dokončování chatu, který může volat funkci. |
| ChatMessageContentItemParent |
Abstraktní reprezentace položky strukturovaného obsahu v chatové zprávě. |
| ChatMessageImageContentItem |
Položka obsahu strukturovaného chatu obsahující odkaz na obrázek |
| ChatMessageImageUrl |
Umístění na internetu, ze kterého může model načíst obrázek. |
| ChatMessageTextContentItem |
Položka obsahu strukturovaného chatu obsahující prostý text. |
| ChatRequestAssistantMessage |
Žádost o chatovou zprávu představující odpověď nebo akci od asistenta. |
| ChatRequestMessageParent |
Abstraktní reprezentace chatové zprávy, jak je uvedeno v požadavku. |
| ChatRequestSystemMessage |
Požadovaná zpráva chatu obsahující systémové pokyny, které ovlivňují, jak model vygeneruje odpověď na dokončení chatu. |
| ChatRequestToolMessage |
Žádost o chatovou zprávu představující požadovaný výstup z nakonfigurovaného nástroje. |
| ChatRequestUserMessage |
Žádost o chatovou zprávu představující vstup uživatele asistentovi. |
| ChatResponseMessageOutput |
Reprezentace chatové zprávy jako přijatá v odpovědi |
| CompletionsUsageOutput |
Reprezentace počtu tokenů zpracovaných pro žádost o dokončení Počty berou v úvahu všechny tokeny napříč výzvami, volbami, alternativami voleb, best_of generacemi a dalšími uživateli. |
| EmbeddingItemOutput |
Reprezentace jednoho porovnání souvisejících vlastností pro vložení |
| EmbeddingsResultOutput |
Reprezentace dat odpovědi z požadavku vkládání Vkládání měří související textových řetězců a běžně se používají pro vyhledávání, clustering, doporučení a další podobné scénáře. |
| EmbeddingsUsageOutput |
Měření množství tokenů použitých v tomto požadavku a odpovědi |
| FunctionCall |
Název a argumenty funkce, které by se měly volat, jak je vygeneroval model. |
| FunctionCallOutput |
Název a argumenty funkce, které by se měly volat, jak je vygeneroval model. |
| FunctionDefinition |
Definice funkce zadané volajícího, která může dokončení chatu vyvolat v reakci na odpovídající vstup uživatele. |
| GetChatCompletions | |
| GetChatCompletions200Response |
Požadavek byl úspěšný. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
Požadavek byl úspěšný. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
Požadavek byl úspěšný. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
Požadavek byl úspěšný. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
Představuje obrázek s volitelným textem. |
| ModelClientOptions |
Volitelné parametry klienta |
| ModelInfoOutput |
Představuje některé základní informace o modelu AI. |
| Routes | |
Aliasy typu
| ChatCompletionsResponseFormat |
Představuje formát, který musí model vypíše. Tuto možnost použijte k povolení režimu JSON místo výchozího textového režimu. Všimněte si, že pokud chcete povolit režim JSON, některé modely AI můžou také vyžadovat, abyste model instruoval, aby vytvořil JSON prostřednictvím systémové nebo uživatelské zprávy. |
| ChatCompletionsToolChoicePreset |
Alias pro ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
Abstraktní reprezentace položky strukturovaného obsahu v chatové zprávě. |
| ChatMessageImageDetailLevel |
Alias pro ChatMessageImageDetailLevel |
| ChatRequestMessage |
Abstraktní reprezentace chatové zprávy, jak je uvedeno v požadavku. |
| ChatRole |
Alias pro ChatRole |
| ChatRoleOutput |
Alias pro ChatRoleOutput |
| CompletionsFinishReasonOutput |
Alias pro CompletionsFinishReasonOutput |
| EmbeddingEncodingFormat |
Alias pro EmbeddingEncodingFormat |
| EmbeddingInputType |
Alias pro EmbeddingInputType |
| ExtraParameters |
Alias pro ExtraParameters |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
Alias pro ModelTypeOutput |
Funkce
Podrobnosti funkce
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Inicializace nové instance ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClientParametry
- endpointParam
-
string
Parametr endpointParam
- credentials
jedinečně identifikovat přihlašovací údaje klienta
- options
- ModelClientOptions
parametr pro všechny volitelné parametry
Návraty
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): responseParametry
Návraty
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): responseParametry
Návraty
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): responseParametry
Návraty
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): responseParametry
Návraty
response
Azure SDK for JavaScript