Delen via


@azure-rest/ai-inference package

Interfaces

ChatChoiceOutput

De weergave van één promptvoltooiing als onderdeel van een algemene aanvraag voor het voltooien van chats. Over het algemeen worden n keuzes gegenereerd per opgegeven prompt met een standaardwaarde van 1. Tokenlimieten en andere instellingen kunnen het aantal gegenereerde keuzes beperken.

ChatCompletionsNamedToolChoice

Een hulpprogrammaselectie van een specifiek benoemd functieprogramma waarmee chatvoltooiingen worden beperkt tot het gebruik van de benoemde functie.

ChatCompletionsNamedToolChoiceFunction

Een hulpprogrammaselectie van een specifiek benoemd functieprogramma waarmee chatvoltooiingen worden beperkt tot het gebruik van de benoemde functie.

ChatCompletionsOutput

Weergave van de antwoordgegevens van een aanvraag voor het voltooien van chats. Voltooiingen ondersteunen een groot aantal taken en genereren tekst die wordt voortgezet van of voltooide promptgegevens.

ChatCompletionsResponseFormatJsonObject

Een antwoordindeling voor chatvoltooiingen waarmee reacties worden beperkt tot het verzenden van geldige JSON-objecten. Als u de JSON-modus wilt inschakelen, moet u voor sommige AI-modellen mogelijk ook het model instrueren om JSON te produceren via een systeem- of gebruikersbericht.

ChatCompletionsResponseFormatJsonSchema

Een antwoordindeling voor chatvoltooiingen waarmee reacties worden beperkt tot het verzenden van geldige JSON-objecten, met een JSON-schema dat is opgegeven door de beller.

ChatCompletionsResponseFormatJsonSchemaDefinition

Hiermee definieert u de antwoordindeling voor chatvoltooiingen als JSON met een bepaald schema. Het AI-model moet voldoen aan dit schema bij het genereren van voltooiingen.

ChatCompletionsResponseFormatParent

Vertegenwoordigt de indeling die het model moet uitvoeren. Gebruik deze optie om de JSON-modus in te schakelen in plaats van de standaardtekstmodus. Als u de JSON-modus wilt inschakelen, moet u voor sommige AI-modellen mogelijk ook het model instrueren om JSON te produceren via een systeem- of gebruikersbericht.

ChatCompletionsResponseFormatText

Een antwoordindeling voor chatvoltooiingen waarmee tekstantwoorden worden verzonden. Dit is de standaardopmaak voor antwoorden.

ChatCompletionsToolCall

Een functiehulpprogramma-aanroep aangevraagd door het AI-model.

ChatCompletionsToolCallOutput

Een functiehulpprogramma-aanroep aangevraagd door het AI-model.

ChatCompletionsToolDefinition

De definitie van een hulpprogramma voor chatvoltooiingen waarmee een functie kan worden aangeroepen.

ChatMessageAudioDataContentItem

Een gestructureerd chatinhoudsitem voor audio-inhoud die wordt doorgegeven als met base64 gecodeerde gegevens.

ChatMessageAudioUrlContentItem

Een gestructureerd chatinhoudsitem voor audio-inhoud die als URL is doorgegeven.

ChatMessageContentItemParent

Een abstracte weergave van een gestructureerd inhoudsitem in een chatbericht.

ChatMessageImageContentItem

Een gestructureerd chatinhoudsitem met een afbeeldingsreferentie.

ChatMessageImageUrl

Een internetlocatie van waaruit het model een afbeelding kan ophalen.

ChatMessageInputAudio

De details van de invoeraudiogegevens.

ChatMessageInputAudioUrl

De details van de audio-URL.

ChatMessageTextContentItem

Een gestructureerd chatinhoudsitem met tekst zonder opmaak.

ChatRequestAssistantMessage

Een chatbericht aanvragen dat antwoord of actie van de assistent vertegenwoordigt.

ChatRequestDeveloperMessage

Een chatbericht voor aanvragen met instructies voor ontwikkelaars die van invloed zijn op hoe het model een antwoord op voltooiing van chats genereert. Sommige AI-modellen ondersteunen een ontwikkelaarsbericht in plaats van een systeembericht.

ChatRequestMessageParent

Een abstracte weergave van een chatbericht zoals opgegeven in een aanvraag.

ChatRequestSystemMessage

Een aanvraagchatbericht met systeeminstructies die van invloed zijn op de wijze waarop het model een antwoord op voltooiing van een chat genereert.

ChatRequestToolMessage

Een chatbericht voor aanvragen dat de aangevraagde uitvoer van een geconfigureerd hulpprogramma vertegenwoordigt.

ChatRequestUserMessage

Een chatbericht aanvragen dat gebruikersinvoer aan de assistent vertegenwoordigt.

ChatResponseMessageOutput

Een weergave van een chatbericht zoals ontvangen in een antwoord.

CompletionsUsageOutput

Weergave van het aantal tokens dat is verwerkt voor een voltooiingsaanvraag. Aantallen houden rekening met alle tokens voor prompts, keuzes, keuze-alternatieven, best_of generaties en andere consumenten.

EmbeddingItemOutput

Weergave van één insluitingsvergelijking.

EmbeddingsResultOutput

Weergave van de antwoordgegevens van een insluitingsaanvraag. Met insluitingen worden de gerelateerdheid van teksttekenreeksen gemeten en worden vaak gebruikt voor zoeken, clusteren, aanbevelingen en andere vergelijkbare scenario's.

EmbeddingsUsageOutput

Meting van de hoeveelheid tokens die in deze aanvraag en reactie worden gebruikt.

ErrorModel

Het foutobject.

FunctionCall

De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.

FunctionCallOutput

De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.

FunctionDefinition

De definitie van een door een beller opgegeven functie die chatvoltooiingen kan aanroepen als reactie op overeenkomende gebruikersinvoer.

GetChatCompletions
GetChatCompletions200Response

De aanvraag is voltooid.

GetChatCompletionsBodyParam
GetChatCompletionsDefaultHeaders
GetChatCompletionsDefaultResponse
GetChatCompletionsHeaderParam
GetChatCompletionsHeaders
GetEmbeddings
GetEmbeddings200Response

De aanvraag is voltooid.

GetEmbeddingsBodyParam
GetEmbeddingsDefaultHeaders
GetEmbeddingsDefaultResponse
GetEmbeddingsHeaderParam
GetEmbeddingsHeaders
GetImageEmbeddings
GetImageEmbeddings200Response

De aanvraag is voltooid.

GetImageEmbeddingsBodyParam
GetImageEmbeddingsDefaultHeaders
GetImageEmbeddingsDefaultResponse
GetImageEmbeddingsHeaderParam
GetImageEmbeddingsHeaders
GetModelInfo
GetModelInfo200Response

De aanvraag is voltooid.

GetModelInfoDefaultHeaders
GetModelInfoDefaultResponse
ImageEmbeddingInput

Vertegenwoordigt een afbeelding met optionele tekst.

ModelClientOptions

De optionele parameters voor de client

ModelInfoOutput

Vertegenwoordigt enkele basisinformatie over het AI-model.

Routes

Type-aliassen

AudioContentFormat

Alias voor AudioContentFormat

ChatCompletionsResponseFormat

Vertegenwoordigt de indeling die het model moet uitvoeren. Gebruik deze optie om de JSON-modus in te schakelen in plaats van de standaardtekstmodus. Als u de JSON-modus wilt inschakelen, moet u voor sommige AI-modellen mogelijk ook het model instrueren om JSON te produceren via een systeem- of gebruikersbericht.

ChatCompletionsToolChoicePreset

Alias voor ChatCompletionsToolChoicePreset

ChatMessageContentItem

Een abstracte weergave van een gestructureerd inhoudsitem in een chatbericht.

ChatMessageImageDetailLevel

Alias voor ChatMessageImageDetailLevel

ChatRequestMessage

Een abstracte weergave van een chatbericht zoals opgegeven in een aanvraag.

ChatRole

Alias voor ChatRole

ChatRoleOutput

Alias voor ChatRoleOutput

CompletionsFinishReasonOutput

Alias voor CompletionsFinishReasonOutput

EmbeddingEncodingFormat

Alias voor EmbeddingEncodingFormat

EmbeddingInputType

Alias voor EmbeddingInputType

ExtraParameters

Alias voor ExtraParameters

GetChatCompletionsParameters
GetEmbeddingsParameters
GetImageEmbeddingsParameters
GetModelInfoParameters
ModelClient
ModelTypeOutput

Alias voor ModelTypeOutput

Functies

default(string, TokenCredential | KeyCredential, ModelClientOptions)

Een nieuw exemplaar van ModelClient initialiseren

isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)

Functiedetails

default(string, TokenCredential | KeyCredential, ModelClientOptions)

Een nieuw exemplaar van ModelClient initialiseren

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClient

Parameters

endpointParam

string

Het parametereindpuntParam

credentials

TokenCredential | KeyCredential

clientreferenties uniek identificeren

options
ModelClientOptions

de parameter voor alle optionele parameters

Retouren

isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)

function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response

Parameters

Retouren

response

isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)

function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response

Parameters

Retouren

response

isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)

function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response

Parameters

Retouren

response

isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)

function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response

Parameters

Retouren

response