@azure-rest/ai-inference package
Gränssnitt
| ChatChoiceOutput |
Representationen av en enskild fråga slutförs som en del av en övergripande begäran om att chatten ska slutföras.
I allmänhet genereras |
| ChatCompletionsNamedToolChoice |
Ett verktygsval av ett specifikt, namngivet funktionsverktyg som begränsar chattens slutförande till att använda den namngivna funktionen. |
| ChatCompletionsNamedToolChoiceFunction |
Ett verktygsval av ett specifikt, namngivet funktionsverktyg som begränsar chattens slutförande till att använda den namngivna funktionen. |
| ChatCompletionsOutput |
Representation av svarsdata från en begäran om att chatten ska slutföras. Slutföranden stöder en mängd olika uppgifter och genererar text som fortsätter från eller "slutför" angivna promptdata. |
| ChatCompletionsResponseFormatJsonObject |
Ett svarsformat för chattavslutningar som begränsar svar till att generera giltiga JSON-objekt. Observera att för att aktivera JSON-läge kan vissa AI-modeller också kräva att du instruerar modellen att producera JSON via ett system- eller användarmeddelande. |
| ChatCompletionsResponseFormatJsonSchema |
Ett svarsformat för chattavslut som begränsar svar till att generera giltiga JSON-objekt, med ett JSON-schema som angetts av anroparen. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
Definierar svarsformatet för chattavslut som JSON med ett visst schema. AI-modellen måste följa det här schemat när du genererar slutföranden. |
| ChatCompletionsResponseFormatParent |
Representerar det format som modellen måste mata ut. Använd detta för att aktivera JSON-läge i stället för standardtextläget. Observera att för att aktivera JSON-läge kan vissa AI-modeller också kräva att du instruerar modellen att producera JSON via ett system- eller användarmeddelande. |
| ChatCompletionsResponseFormatText |
Ett svarsformat för chattavslutningar som genererar textsvar. Det här är standardsvarsformatet. |
| ChatCompletionsToolCall |
Ett funktionsverktygsanrop som begärts av AI-modellen. |
| ChatCompletionsToolCallOutput |
Ett funktionsverktygsanrop som begärts av AI-modellen. |
| ChatCompletionsToolDefinition |
Definitionen av ett verktyg för chattavslut som kan anropa en funktion. |
| ChatMessageContentItemParent |
En abstrakt representation av ett strukturerat innehållsobjekt i ett chattmeddelande. |
| ChatMessageImageContentItem |
Ett strukturerat chattinnehållsobjekt som innehåller en bildreferens. |
| ChatMessageImageUrl |
En internetplats från vilken modellen kan hämta en avbildning. |
| ChatMessageTextContentItem |
Ett strukturerat chattinnehållsobjekt som innehåller oformaterad text. |
| ChatRequestAssistantMessage |
Ett chattmeddelande för begäran som representerar svar eller åtgärd från assistenten. |
| ChatRequestMessageParent |
En abstrakt representation av ett chattmeddelande enligt en begäran. |
| ChatRequestSystemMessage |
Ett chattmeddelande för begäran som innehåller systeminstruktioner som påverkar hur modellen genererar ett svar om chattens slutförande. |
| ChatRequestToolMessage |
Ett chattmeddelande för begäran som representerar begärda utdata från ett konfigurerat verktyg. |
| ChatRequestUserMessage |
Ett begärandechattmeddelande som representerar användarens indata till assistenten. |
| ChatResponseMessageOutput |
En representation av ett chattmeddelande som tas emot i ett svar. |
| CompletionsUsageOutput |
Representation av antalet token som bearbetats för en slutförandebegäran. Antal överväger alla token i fråga, val, alternativ, best_of generationer och andra konsumenter. |
| EmbeddingItemOutput |
Representation av en enda jämförelse av inbäddningsrelaterade inbäddningar. |
| EmbeddingsResultOutput |
Representation av svarsdata från en inbäddningsbegäran. Inbäddningar mäter relaterade textsträngar och används ofta för sökning, klustring, rekommendationer och andra liknande scenarier. |
| EmbeddingsUsageOutput |
Mätning av mängden token som används i den här begäran och svaret. |
| FunctionCall |
Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. |
| FunctionCallOutput |
Namnet och argumenten för en funktion som ska anropas, som genereras av modellen. |
| FunctionDefinition |
Definitionen av en anropare-angiven funktion som chatten slutför kan anropa som svar på matchande användarindata. |
| GetChatCompletions | |
| GetChatCompletions200Response |
Begäran har slutförts. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
Begäran har slutförts. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
Begäran har slutförts. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
Begäran har slutförts. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
Representerar en bild med valfri text. |
| ModelClientOptions |
Valfria parametrar för klienten |
| ModelInfoOutput |
Representerar grundläggande information om AI-modellen. |
| Routes | |
Typalias
| ChatCompletionsResponseFormat |
Representerar det format som modellen måste mata ut. Använd detta för att aktivera JSON-läge i stället för standardtextläget. Observera att för att aktivera JSON-läge kan vissa AI-modeller också kräva att du instruerar modellen att producera JSON via ett system- eller användarmeddelande. |
| ChatCompletionsToolChoicePreset |
Alias för ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
En abstrakt representation av ett strukturerat innehållsobjekt i ett chattmeddelande. |
| ChatMessageImageDetailLevel |
Alias för ChatMessageImageDetailLevel |
| ChatRequestMessage |
En abstrakt representation av ett chattmeddelande enligt en begäran. |
| ChatRole |
Alias för ChatRole |
| ChatRoleOutput |
Alias för ChatRoleOutput |
| CompletionsFinishReasonOutput |
Alias för CompletionsFinishReasonOutput |
| EmbeddingEncodingFormat |
Alias för EmbeddingEncodingFormat |
| EmbeddingInputType |
Alias för EmbeddingInputType |
| ExtraParameters |
Alias för ExtraParameters |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
Alias för ModelTypeOutput |
Funktioner
Funktionsinformation
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Initiera en ny instans av ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClientParametrar
- endpointParam
-
string
ParameterslutpunktenParam
- credentials
unikt identifiera klientautentiseringsuppgifter
- options
- ModelClientOptions
parametern för alla valfria parametrar
Returer
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): responseParametrar
Returer
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): responseParametrar
Returer
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): responseParametrar
Returer
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): responseParametrar
Returer
response
Azure SDK for JavaScript