Delen via

Get Chat Completions - Get Chat Completions

Service:
AI Foundry
API-versie:
2024-05-01-preview

Hiermee worden chatvoltooiingen voor de opgegeven chatberichten ontvangen. Voltooiingen ondersteunen een groot aantal taken en genereren tekst die wordt voortgezet van of voltooide promptgegevens. De methode maakt een REST API-aanroep naar de /chat/completions route op het opgegeven eindpunt.

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview

URI-parameters

Name In Vereist Type Description
resource
 path True

string

De resourcenaam van Azure AI Services, bijvoorbeeld 'my-resource'
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
extra-parameters

ExtraParameters

Hiermee bepaalt u wat er gebeurt als extra parameters, die niet zijn gedefinieerd door de REST API, worden doorgegeven in de nettolading van de JSON-aanvraag. Hiermee stelt u de HTTP-aanvraagheader in extra-parameters.

Aanvraagbody

Name Vereist Type Description
messages True ChatRequestMessage[]:

De verzameling contextberichten die zijn gekoppeld aan deze chat-voltooiingsaanvraag. Normaal gebruik begint met een chatbericht voor de systeemrol die instructies biedt voor het gedrag van de assistent, gevolgd door afwisselende berichten tussen de rollen Gebruiker en Assistent.
frequency_penalty

number (float)

minimum: -2
maximum: 2

Een waarde die van invloed is op de kans dat gegenereerde tokens worden weergegeven op basis van hun cumulatieve frequentie in gegenereerde tekst. Positieve waarden zorgen ervoor dat tokens minder waarschijnlijk worden weergegeven als hun frequentie toeneemt en de kans vermindert dat het model dezelfde exacte instructies herhaalt. Ondersteund bereik is [-2, 2].
max_tokens

integer (int32)

minimum: 0

Het maximum aantal tokens dat moet worden gegenereerd.
modalities

ChatCompletionsModality[]

De modaliteiten die het model mag gebruiken voor het antwoord op het voltooien van de chat. De standaard modaliteit is text. Het aangeven van een niet-ondersteunde modaliteitscombinatie resulteert in een 422-fout.
model

string

Id van het specifieke AI-model dat moet worden gebruikt, als er meer dan één model beschikbaar is op het eindpunt.
presence_penalty

number (float)

minimum: -2
maximum: 2

Een waarde die de kans beïnvloedt dat gegenereerde tokens worden weergegeven op basis van hun bestaande aanwezigheid in gegenereerde tekst. Met positieve waarden worden tokens minder waarschijnlijk weergegeven wanneer ze al bestaan en vergroten de kans dat het model nieuwe onderwerpen uitvoert. Ondersteund bereik is [-2, 2].
response_format ChatCompletionsResponseFormat:

Een object dat de indeling aangeeft die het model moet uitvoeren.

Instelling voor { "type": "json_schema", "json_schema": {...} } maakt gestructureerde uitvoer mogelijk die ervoor zorgt dat het model overeenkomt met het opgegeven JSON-schema.

Als u de instelling voor { "type": "json_object" } de JSON-modus inschakelt, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie max_tokens is overschreden of dat het gesprek de maximale contextlengte heeft overschreden.
seed

integer (int64)

Indien opgegeven, doet het systeem er alles aan om een steekproef te nemen op een deterministische wijze, zodat herhaalde aanvragen met dezelfde seed en parameters hetzelfde resultaat moeten retourneren. Determinisme is niet gegarandeerd.
stop

string[]

Een verzameling tekstreeksen die het genereren van voltooiingen beëindigen.
stream

boolean

Een waarde die aangeeft of chatvoltooiingen moeten worden gestreamd voor deze aanvraag.
temperature

number (float)

minimum: 0
maximum: 1

De steekproeftemperatuur die moet worden gebruikt om de schijnbare creativiteit van gegenereerde voltooiingen te regelen. Hogere waarden zorgen ervoor dat uitvoer willekeuriger wordt, terwijl lagere waarden resultaten meer gericht en deterministisch maken. Het wordt niet aanbevolen om temperatuur en top_p te wijzigen voor dezelfde voltooiingsaanvraag als de interactie van deze twee instellingen is moeilijk te voorspellen. Ondersteund bereik is [0, 1].
tool_choice

Indien opgegeven, configureert het model welke van de beschikbare hulpprogramma's die het kan gebruiken voor het antwoord op het voltooien van de chat.
tools

ChatCompletionsToolDefinition[]

Een lijst met hulpprogramma's die het model kan aanvragen om aan te roepen. Op dit moment worden alleen functies ondersteund als hulpprogramma. Het model kan reageren met een aanvraag voor een functieoproep en de invoerargumenten voor die functie opgeven in JSON-indeling.
top_p

number (float)

minimum: 0
maximum: 1

Een alternatief voor steekproeven met temperatuur genaamd kernsampling. Deze waarde zorgt ervoor dat het model rekening houdt met de resultaten van tokens met de opgegeven waarschijnlijkheidsmassa. Een voorbeeld: een waarde van 0,15 zorgt ervoor dat alleen de tokens die de top 15% van waarschijnlijkheidsmassa bevatten, worden overwogen. Het wordt niet aanbevolen om temperatuur en top_p te wijzigen voor dezelfde voltooiingsaanvraag als de interactie van deze twee instellingen is moeilijk te voorspellen. Ondersteund bereik is [0, 1].

Antwoorden

Name Type Description
200 OK

ChatCompletions

De aanvraag is voltooid.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Audio modality chat completion
maximum set chat completion
minimum set chat completion

Audio modality chat completion

Voorbeeldaanvraag

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text",
    "audio"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    },
    {
      "role": "assistant",
      "content": null,
      "audio": {
        "id": "abcdef1234"
      }
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    }
  ],
  "frequency_penalty": 0,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "seed": 21,
  "model": "my-model-name"
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1696522361,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16,
    "completion_tokens_details": {
      "audio_tokens": 5,
      "total_tokens": 5
    },
    "prompt_tokens_details": {
      "audio_tokens": 10,
      "cached_tokens": 0
    }
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": null,
        "audio": {
          "id": "abcdef1234",
          "format": "wav",
          "data": "<base64 encoded audio data>",
          "expires_at": 1896522361,
          "transcript": "This is a sample transcript"
        }
      }
    }
  ]
}

maximum set chat completion

Voorbeeldaanvraag

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    },
    {
      "role": "assistant",
      "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594."
    },
    {
      "role": "user",
      "content": "Ist it proved?"
    }
  ],
  "frequency_penalty": 0,
  "stream": true,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "max_tokens": 255,
  "response_format": {
    "type": "text"
  },
  "stop": [
    "<|endoftext|>"
  ],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "my-function-name",
        "description": "A function useful to know if a theroem is proved or not"
      }
    }
  ],
  "seed": 21,
  "model": "my-model-name"
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 18,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16
  },
  "choices": [
    {
      "index": 7,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "yrobmilsrugmbwukmzo",
            "type": "function",
            "function": {
              "name": "my-function-name",
              "arguments": "{ \"arg1\": \"value1\", \"arg2\": \"value2\" }"
            }
          }
        ]
      }
    }
  ]
}

minimum set chat completion

Voorbeeldaanvraag

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview

{
  "messages": [
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    }
  ]
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 205,
    "completion_tokens": 5,
    "total_tokens": 210
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594"
      }
    }
  ]
}

Definities

Name Description
AudioContentFormat

Een weergave van de mogelijke audio-indelingen voor audio.
Azure.Core.Foundations.Error

Het foutobject.
Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
ChatChoice

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.
ChatCompletions

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.
ChatCompletionsAudio

Een weergave van de audio die door het model wordt gegenereerd.
ChatCompletionsModality

De modaliteiten die het model mag gebruiken voor het antwoord op het voltooien van de chat.
ChatCompletionsOptions

De configuratiegegevens voor een aanvraag voor het voltooien van een chatgesprek. 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

De definitie van het vereiste JSON-schema in het antwoord en de bijbehorende metagegevens.
ChatCompletionsResponseFormatText

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

Een functiehulpprogramma-aanroep aangevraagd door het AI-model.
ChatCompletionsToolDefinition

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

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

Een verwijzing naar een audioantwoord dat door het model wordt gegenereerd.
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.
ChatResponseMessage

Een weergave van een chatbericht zoals ontvangen in een antwoord.
ChatRole

Een beschrijving van het beoogde doel van een bericht binnen een chatinteractie.
CompletionsFinishReason

Weergave van de manier waarop een voltooiingsreactie werd afgesloten.
CompletionsUsage

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.
CompletionsUsageDetails

Een uitsplitsing van tokens die worden gebruikt in een voltooiing.
ExtraParameters

Hiermee bepaalt u wat er gebeurt als extra parameters, die niet zijn gedefinieerd door de REST API, worden doorgegeven in de nettolading van de JSON-aanvraag.
FunctionCall

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.
PromptUsageDetails

Een uitsplitsing van tokens die worden gebruikt in de prompt-/chatgeschiedenis.

AudioContentFormat

Inventarisatie

Een weergave van de mogelijke audio-indelingen voor audio.

Waarde Description
wav

Hiermee geeft u audio in WAV-indeling.
mp3

Hiermee geeft u audio in MP3-indeling.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.
details

Azure.Core.Foundations.Error[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie dan het huidige object over de fout.
message

string

Een leesbare weergave van de fout.
target

string

Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name Type Description
error

Azure.Core.Foundations.Error

Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.
innererror

Azure.Core.Foundations.InnerError

Interne fout.

ChatChoice

Object

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.

Name Type Description
finish_reason

CompletionsFinishReason

De reden waarom deze chat is voltooid, is de gegenereerde keuze voltooid.
index

integer (int32)

De geordende index die is gekoppeld aan deze chat-voltooiingskeuze.
message

ChatResponseMessage

Het chatbericht voor een bepaalde chat-voltooiingsprompt.

ChatCompletions

Object

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.

Name Type Description
choices

ChatChoice[]

De verzameling voltooiingskeuzen die zijn gekoppeld aan dit voltooiingsantwoord. 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.
created

integer (unixtime)

De eerste tijdstempel die is gekoppeld aan de generatieactiviteit voor dit voltooiingsantwoord, weergegeven als seconden sinds het begin van het Unix-epoch van 00:00 op 1 januari 1970.
id

string

Een unieke id die aan deze chat is gekoppeld, reageert.
model

string

Het model dat wordt gebruikt voor het voltooien van de chat.
object enum:

chat.completion

Het antwoordobjecttype, dat altijd chat.completionis.
usage

CompletionsUsage

Gebruiksgegevens voor tokens die worden verwerkt en gegenereerd als onderdeel van deze voltooiingsbewerking.

ChatCompletionsAudio

Object

Een weergave van de audio die door het model wordt gegenereerd.

Name Type Description
data

string

Met Base64 gecodeerde audiogegevens
expires_at

integer (unixtime)

De Unix-tijdstempel (in seconden) waarop het audiostuk verloopt en waarnaar niet meer kan worden verwezen door de id in gesprekken met meerdere paden.
format

AudioContentFormat

De indeling van de audio-inhoud. Als er geen indeling is opgegeven, komt deze overeen met de indeling die wordt gebruikt in de invoeraudioaanvraag.
id

string

Unieke id voor het audioantwoord. Deze waarde kan worden gebruikt in chatgeschiedenisberichten in plaats van het volledige audioobject door te geven.
transcript

string

Het transcript van het audiobestand.

ChatCompletionsModality

Inventarisatie

De modaliteiten die het model mag gebruiken voor het antwoord op het voltooien van de chat.

Waarde Description
text

Het model mag alleen tekst genereren.
audio

Het model mag audio genereren.

ChatCompletionsOptions

Object

De configuratiegegevens voor een aanvraag voor het voltooien van een chatgesprek. Voltooiingen ondersteunen een groot aantal taken en genereren tekst die wordt voortgezet van of voltooide promptgegevens.

Name Type Default value Description
frequency_penalty

number (float)

minimum: -2
maximum: 2 		0

Een waarde die van invloed is op de kans dat gegenereerde tokens worden weergegeven op basis van hun cumulatieve frequentie in gegenereerde tekst. Positieve waarden zorgen ervoor dat tokens minder waarschijnlijk worden weergegeven als hun frequentie toeneemt en de kans vermindert dat het model dezelfde exacte instructies herhaalt. Ondersteund bereik is [-2, 2].
max_tokens

integer (int32)

minimum: 0

Het maximum aantal tokens dat moet worden gegenereerd.
messages ChatRequestMessage[]:

De verzameling contextberichten die zijn gekoppeld aan deze chat-voltooiingsaanvraag. Normaal gebruik begint met een chatbericht voor de systeemrol die instructies biedt voor het gedrag van de assistent, gevolgd door afwisselende berichten tussen de rollen Gebruiker en Assistent.
modalities

ChatCompletionsModality[]

De modaliteiten die het model mag gebruiken voor het antwoord op het voltooien van de chat. De standaard modaliteit is text. Het aangeven van een niet-ondersteunde modaliteitscombinatie resulteert in een 422-fout.
model

string

Id van het specifieke AI-model dat moet worden gebruikt, als er meer dan één model beschikbaar is op het eindpunt.
presence_penalty

number (float)

minimum: -2
maximum: 2 		0

Een waarde die de kans beïnvloedt dat gegenereerde tokens worden weergegeven op basis van hun bestaande aanwezigheid in gegenereerde tekst. Met positieve waarden worden tokens minder waarschijnlijk weergegeven wanneer ze al bestaan en vergroten de kans dat het model nieuwe onderwerpen uitvoert. Ondersteund bereik is [-2, 2].
response_format ChatCompletionsResponseFormat:

Een object dat de indeling aangeeft die het model moet uitvoeren.

Instelling voor { "type": "json_schema", "json_schema": {...} } maakt gestructureerde uitvoer mogelijk die ervoor zorgt dat het model overeenkomt met het opgegeven JSON-schema.

Als u de instelling voor { "type": "json_object" } de JSON-modus inschakelt, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is.

Belangrijk: wanneer u de JSON-modus gebruikt, moet u het model ook instrueren om zelf JSON te produceren via een systeem- of gebruikersbericht. Zonder dit kan het model een onverwerkte witruimtestroom genereren totdat de generatie de tokenlimiet bereikt, wat resulteert in een langlopende en schijnbaar 'vastgelopen' aanvraag. Houd er ook rekening mee dat de inhoud van het bericht gedeeltelijk kan worden afgekapt als finish_reason="length", wat aangeeft dat de generatie max_tokens is overschreden of dat het gesprek de maximale contextlengte heeft overschreden.
seed

integer (int64)

Indien opgegeven, doet het systeem er alles aan om een steekproef te nemen op een deterministische wijze, zodat herhaalde aanvragen met dezelfde seed en parameters hetzelfde resultaat moeten retourneren. Determinisme is niet gegarandeerd.
stop

string[]

Een verzameling tekstreeksen die het genereren van voltooiingen beëindigen.
stream

boolean

Een waarde die aangeeft of chatvoltooiingen moeten worden gestreamd voor deze aanvraag.
temperature

number (float)

minimum: 0
maximum: 1 		0.7

De steekproeftemperatuur die moet worden gebruikt om de schijnbare creativiteit van gegenereerde voltooiingen te regelen. Hogere waarden zorgen ervoor dat uitvoer willekeuriger wordt, terwijl lagere waarden resultaten meer gericht en deterministisch maken. Het wordt niet aanbevolen om temperatuur en top_p te wijzigen voor dezelfde voltooiingsaanvraag als de interactie van deze twee instellingen is moeilijk te voorspellen. Ondersteund bereik is [0, 1].
tool_choice

Indien opgegeven, configureert het model welke van de beschikbare hulpprogramma's die het kan gebruiken voor het antwoord op het voltooien van de chat.
tools

ChatCompletionsToolDefinition[]

Een lijst met hulpprogramma's die het model kan aanvragen om aan te roepen. Op dit moment worden alleen functies ondersteund als hulpprogramma. Het model kan reageren met een aanvraag voor een functieoproep en de invoerargumenten voor die functie opgeven in JSON-indeling.
top_p

number (float)

minimum: 0
maximum: 1 		1

Een alternatief voor steekproeven met temperatuur genaamd kernsampling. Deze waarde zorgt ervoor dat het model rekening houdt met de resultaten van tokens met de opgegeven waarschijnlijkheidsmassa. Een voorbeeld: een waarde van 0,15 zorgt ervoor dat alleen de tokens die de top 15% van waarschijnlijkheidsmassa bevatten, worden overwogen. Het wordt niet aanbevolen om temperatuur en top_p te wijzigen voor dezelfde voltooiingsaanvraag als de interactie van deze twee instellingen is moeilijk te voorspellen. Ondersteund bereik is [0, 1].

ChatCompletionsResponseFormatJsonObject

Object

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.

Name Type Description
type string:

json_object

Het type antwoordindeling dat moet worden gebruikt voor het voltooien van chats.

ChatCompletionsResponseFormatJsonSchema

Object

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.

Name Type Description
json_schema

ChatCompletionsResponseFormatJsonSchemaDefinition

De definitie van het vereiste JSON-schema in het antwoord en de bijbehorende metagegevens.
type string:

json_schema

Het type antwoordindeling dat moet worden gebruikt voor het voltooien van chats.

ChatCompletionsResponseFormatJsonSchemaDefinition

Object

De definitie van het vereiste JSON-schema in het antwoord en de bijbehorende metagegevens.

Name Type Default value Description
description

string

Een beschrijving van de antwoordindeling die door het AI-model wordt gebruikt om te bepalen hoe antwoorden in deze indeling moeten worden gegenereerd.
name

string

De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.
schema

De definitie van het JSON-schema
strict

boolean

False

Of u strikte schema-naleving wilt inschakelen bij het genereren van de uitvoer. Als dit is ingesteld op true, volgt het model altijd het exacte schema dat is gedefinieerd in het veld schema. Alleen een subset van het JSON-schema wordt ondersteund wanneer strict wordt true.

ChatCompletionsResponseFormatText

Object

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

Name Type Description
type string:

text

Het type antwoordindeling dat moet worden gebruikt voor het voltooien van chats.

ChatCompletionsToolCall

Object

Een functiehulpprogramma-aanroep aangevraagd door het AI-model.

Name Type Description
function

FunctionCall

De details van de functie-aanroep die is aangevraagd door het AI-model.
id

string

De id van de aanroep van het hulpprogramma.
type enum:

function

Het type aanroep van het hulpprogramma. Op dit moment wordt alleen function ondersteund.

ChatCompletionsToolDefinition

Object

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

Name Type Description
function

FunctionDefinition

De details van de functiedefinitie voor het functiehulpprogramma.
type enum:

function

Het type hulpprogramma. Op dit moment wordt alleen function ondersteund.

ChatRequestAssistantMessage

Object

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

Name Type Description
audio

ChatRequestAudioReference

De audio die wordt gegenereerd door een eerder antwoord in een gesprek met meerdere paden.
content

string

De inhoud van het bericht.
role string:

assistant

De chatrol die aan dit bericht is gekoppeld.
tool_calls

ChatCompletionsToolCall[]

De hulpprogramma-aanroepen die moeten worden opgelost en hun uitvoer moet worden toegevoegd aan volgende invoerberichten voor de aanvraag voor het voltooien van de chat om op te lossen zoals geconfigureerd.

ChatRequestAudioReference

Object

Een verwijzing naar een audioantwoord dat door het model wordt gegenereerd.

Name Type Description
id

string

Unieke id voor het audioantwoord. Deze waarde komt overeen met de id van een eerdere audio-voltooiing.

ChatRequestSystemMessage

Object

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

Name Type Description
content

string

De inhoud van het systeembericht.
role string:

system

De chatrol die aan dit bericht is gekoppeld.

ChatRequestToolMessage

Object

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

Name Type Description
content

string

De inhoud van het bericht.
role string:

tool

De chatrol die aan dit bericht is gekoppeld.
tool_call_id

string

De id van de aanroep van het hulpprogramma die is opgelost door de opgegeven inhoud.

ChatRequestUserMessage

Object

Een chatbericht aanvragen dat gebruikersinvoer aan de assistent vertegenwoordigt.

Name Type Description
content

De inhoud van het gebruikersbericht, met beschikbare invoertypen die variëren per geselecteerd model.
role string:

user

De chatrol die aan dit bericht is gekoppeld.

ChatResponseMessage

Object

Een weergave van een chatbericht zoals ontvangen in een antwoord.

Name Type Description
audio

ChatCompletionsAudio

De audio die door het model wordt gegenereerd als reactie op de berichten als het model is geconfigureerd voor het genereren van audio.
content

string

De inhoud van het bericht.
role

ChatRole

De chatrol die aan het bericht is gekoppeld.
tool_calls

ChatCompletionsToolCall[]

De hulpprogramma-aanroepen die moeten worden opgelost en hun uitvoer moet worden toegevoegd aan volgende invoerberichten voor de aanvraag voor het voltooien van de chat om op te lossen zoals geconfigureerd.

ChatRole

Inventarisatie

Een beschrijving van het beoogde doel van een bericht binnen een chatinteractie.

Waarde Description
system

De rol waarmee het gedrag van de assistent wordt geïnstrueerd of ingesteld.
developer

De rol die instructies biedt voor het model dat prioriteit geeft aan gebruikersberichten.
user

De rol die invoer biedt voor het voltooien van chatgesprekken.
assistant

De rol die antwoorden biedt op door het systeem geïnstrueerde, door de gebruiker gevraagd invoer.
tool

De rol die de activiteit van het extensiehulpprogramma vertegenwoordigt binnen een bewerking voor het voltooien van een chat.

CompletionsFinishReason

Inventarisatie

Weergave van de manier waarop een voltooiingsreactie werd afgesloten.

Waarde Description
stop

Voltooiingen eindigden normaal en bereikten het einde van het genereren van tokens.
length

Voltooiingen uitgeputte beschikbare tokenlimieten voordat het genereren kon worden voltooid.
content_filter

Voltooiingen hebben een antwoord gegenereerd dat is geïdentificeerd als mogelijk gevoelig per beleid voor inhoudsbeheer.
tool_calls

Voltooiing is beëindigd met het model dat een opgegeven hulpprogramma aanroept voor uitvoer.

CompletionsUsage

Object

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.

Name Type Description
completion_tokens

integer (int32)

Het aantal tokens dat wordt gegenereerd voor alle voltooiingsemissies.
completion_tokens_details

CompletionsUsageDetails

Uitsplitsing van tokens die worden gebruikt in een voltooiing.
prompt_tokens

integer (int32)

Het aantal tokens in de opgegeven prompts voor de voltooiingsaanvraag.
prompt_tokens_details

PromptUsageDetails

Uitsplitsing van tokens die worden gebruikt in de prompt-/chatgeschiedenis.
total_tokens

integer (int32)

Het totale aantal tokens dat is verwerkt voor de voltooiingsaanvraag en het antwoord.

CompletionsUsageDetails

Object

Een uitsplitsing van tokens die worden gebruikt in een voltooiing.

Name Type Description
audio_tokens

integer (int32)

Het aantal tokens dat overeenkomt met audio-invoer.
total_tokens

integer (int32)

Het totale aantal tokens dat is verwerkt voor de voltooiingsaanvraag en het antwoord.

ExtraParameters

Inventarisatie

Hiermee bepaalt u wat er gebeurt als extra parameters, die niet zijn gedefinieerd door de REST API, worden doorgegeven in de nettolading van de JSON-aanvraag.

Waarde Description
error

De service treedt op als er extra parameters zijn gedetecteerd in de nettolading van de aanvraag. Dit is de standaardservice.
drop

De service negeert extra parameters (drop) in de nettolading van de aanvraag. Hiermee worden alleen de bekende parameters doorgegeven aan het AI-model van de back-end.
pass-through

De service geeft extra parameters door aan het AI-model van de back-end.

FunctionCall

Object

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

Name Type Description
arguments

string

De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en parameters die niet door uw functieschema zijn gedefinieerd, halluvalideert. Valideer de argumenten in uw code voordat u de functie aanroept.
name

string

De naam van de functie die moet worden aangeroepen.

FunctionDefinition

Object

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

Name Type Description
description

string

Een beschrijving van wat de functie doet. Het model gebruikt deze beschrijving bij het selecteren van de functie en het interpreteren van de parameters.
name

string

De naam van de functie die moet worden aangeroepen.
parameters

De parameters die de functie accepteert, zoals beschreven als een JSON-schemaobject.

PromptUsageDetails

Object

Een uitsplitsing van tokens die worden gebruikt in de prompt-/chatgeschiedenis.

Name Type Description
audio_tokens

integer (int32)

Het aantal tokens dat overeenkomt met audio-invoer.
cached_tokens

integer (int32)

Het totale aantal tokens dat in de cache is opgeslagen.