@azure-rest/ai-inference package
Schnittstellen
ChatChoiceOutput |
Die Darstellung eines einzelnen Eingabeaufforderungsabschlusses als Teil einer gesamter Chatabschlussanfrage.
Im Allgemeinen werden |
ChatCompletionsNamedToolChoice |
Eine Toolauswahl eines bestimmten benannten Funktionstools, das Chat-Fertigstellungen auf die Verwendung der benannten Funktion beschränkt. |
ChatCompletionsNamedToolChoiceFunction |
Eine Toolauswahl eines bestimmten benannten Funktionstools, das Chat-Fertigstellungen auf die Verwendung der benannten Funktion beschränkt. |
ChatCompletionsOutput |
Darstellung der Antwortdaten aus einer Chatabschlussanfrage. Fertigstellungen unterstützen eine Vielzahl von Aufgaben und generieren Text, der von bereitgestellten Eingabeaufforderungsdaten fortgesetzt oder "abgeschlossen" wird. |
ChatCompletionsResponseFormatJsonObject |
Ein Antwortformat für Chatabschlusse, das Die Antworten auf das Senden gültiger JSON-Objekte beschränkt. Beachten Sie, dass Zum Aktivieren des JSON-Modus einige KI-Modelle möglicherweise auch erfordern, dass Sie das Modell anweisen, JSON über ein System oder eine Benutzernachricht zu erstellen. |
ChatCompletionsResponseFormatJsonSchema |
Ein Antwortformat für Chatabschlusse, das Antworten auf das Senden gültiger JSON-Objekte beschränkt, wobei ein vom Aufrufer angegebenes JSON-Schema angegeben ist. |
ChatCompletionsResponseFormatJsonSchemaDefinition |
Definiert das Antwortformat für Chatabschlusse als JSON mit einem bestimmten Schema. Das KI-Modell muss beim Generieren von Fertigstellungen dieses Schemas einhalten. |
ChatCompletionsResponseFormatParent |
Stellt das Format dar, das das Modell ausgeben muss. Verwenden Sie diese Option, um den JSON-Modus anstelle des Standardtextmodus zu aktivieren. Beachten Sie, dass Zum Aktivieren des JSON-Modus einige KI-Modelle möglicherweise auch erfordern, dass Sie das Modell anweisen, JSON über ein System oder eine Benutzernachricht zu erstellen. |
ChatCompletionsResponseFormatText |
Ein Antwortformat für Chatabschlusse, das Textantworten ausgibt. Dies ist das Standardantwortformat. |
ChatCompletionsToolCall |
Ein Vom KI-Modell angeforderter Funktionstoolaufruf. |
ChatCompletionsToolCallOutput |
Ein Vom KI-Modell angeforderter Funktionstoolaufruf. |
ChatCompletionsToolDefinition |
Die Definition eines Chatabschlusstools, das eine Funktion aufrufen kann. |
ChatMessageContentItemParent |
Eine abstrakte Darstellung eines strukturierten Inhaltselements in einer Chatnachricht. |
ChatMessageImageContentItem |
Ein strukturiertes Chatinhaltselement, das einen Bildverweis enthält. |
ChatMessageImageUrl |
Ein Internetspeicherort, von dem das Modell ein Bild abrufen kann. |
ChatMessageTextContentItem |
Ein strukturiertes Chatinhaltselement, das Nur-Text enthält. |
ChatRequestAssistantMessage |
Eine Chatnachricht zur Anforderung, die Antwort oder Aktion des Assistenten darstellt. |
ChatRequestMessageParent |
Eine abstrakte Darstellung einer Chatnachricht, wie in einer Anforderung angegeben. |
ChatRequestSystemMessage |
Eine Chatnachricht mit Systemanweisungen, die beeinflussen, wie das Modell eine Antwort auf Chatabschlusse generiert. |
ChatRequestToolMessage |
Eine Chatnachricht zur Anforderung, die die angeforderte Ausgabe eines konfigurierten Tools darstellt. |
ChatRequestUserMessage |
Eine Chatnachricht zur Anforderung, die Benutzereingaben an den Assistenten darstellt. |
ChatResponseMessageOutput |
Eine Darstellung einer Chatnachricht, die in einer Antwort empfangen wurde. |
CompletionsUsageOutput |
Darstellung der Tokenanzahl, die für eine Abschlussanforderung verarbeitet wurde. Anzahl berücksichtigt alle Token über Eingabeaufforderungen, Auswahlmöglichkeiten, Wahlvarianten, best_of Generationen und andere Verbraucher hinweg. |
EmbeddingItemOutput |
Darstellung eines einzelnen Einbettungsvergleichs. |
EmbeddingsResultOutput |
Darstellung der Antwortdaten aus einer Einbettungsanforderung. Einbettungen messen die Beziehung von Textzeichenfolgen und werden häufig für Such-, Clustering-, Empfehlungen und andere ähnliche Szenarien verwendet. |
EmbeddingsUsageOutput |
Messung der Anzahl der token, die in dieser Anforderung und Antwort verwendet werden. |
FunctionCall |
Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie vom Modell generiert. |
FunctionCallOutput |
Der Name und die Argumente einer Funktion, die aufgerufen werden soll, wie vom Modell generiert. |
FunctionDefinition |
Die Definition einer vom Aufrufer angegebenen Funktion, die Chatabschlusse als Reaktion auf übereinstimmende Benutzereingaben aufrufen kann. |
GetChatCompletions | |
GetChatCompletions200Response |
Die Anforderung ist erfolgreich. |
GetChatCompletionsBodyParam | |
GetChatCompletionsDefaultHeaders | |
GetChatCompletionsDefaultResponse | |
GetChatCompletionsHeaderParam | |
GetChatCompletionsHeaders | |
GetEmbeddings | |
GetEmbeddings200Response |
Die Anforderung ist erfolgreich. |
GetEmbeddingsBodyParam | |
GetEmbeddingsDefaultHeaders | |
GetEmbeddingsDefaultResponse | |
GetEmbeddingsHeaderParam | |
GetEmbeddingsHeaders | |
GetImageEmbeddings | |
GetImageEmbeddings200Response |
Die Anforderung ist erfolgreich. |
GetImageEmbeddingsBodyParam | |
GetImageEmbeddingsDefaultHeaders | |
GetImageEmbeddingsDefaultResponse | |
GetImageEmbeddingsHeaderParam | |
GetImageEmbeddingsHeaders | |
GetModelInfo | |
GetModelInfo200Response |
Die Anforderung ist erfolgreich. |
GetModelInfoDefaultHeaders | |
GetModelInfoDefaultResponse | |
ImageEmbeddingInput |
Stellt ein Bild mit optionalem Text dar. |
ModelClientOptions |
Die optionalen Parameter für den Client |
ModelInfoOutput |
Stellt einige grundlegende Informationen zum KI-Modell dar. |
Routes |
Typaliase
ChatCompletionsResponseFormat |
Stellt das Format dar, das das Modell ausgeben muss. Verwenden Sie diese Option, um den JSON-Modus anstelle des Standardtextmodus zu aktivieren. Beachten Sie, dass Zum Aktivieren des JSON-Modus einige KI-Modelle möglicherweise auch erfordern, dass Sie das Modell anweisen, JSON über ein System oder eine Benutzernachricht zu erstellen. |
ChatCompletionsToolChoicePreset |
Alias für ChatCompletionsToolChoicePreset |
ChatMessageContentItem |
Eine abstrakte Darstellung eines strukturierten Inhaltselements in einer Chatnachricht. |
ChatMessageImageDetailLevel |
Alias für ChatMessageImageDetailLevel |
ChatRequestMessage |
Eine abstrakte Darstellung einer Chatnachricht, wie in einer Anforderung angegeben. |
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 |
Functions
Details zur Funktion
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Initialisieren einer neuen Instanz von ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClient
Parameter
- endpointParam
-
string
Der Parameter endpointParam
- credentials
Eindeutige Identifizierung von Clientanmeldeinformationen
- options
- ModelClientOptions
der Parameter für alle optionalen Parameter
Gibt zurück
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response
Parameter
Gibt zurück
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response
Parameter
Gibt zurück
response
Azure SDK for JavaScript