Azure OpenAI in Microsoft REST API v1 preview-verwijzing voor Foundry Models

In dit artikel vindt u meer informatie over de REST API-eindpunten voor deductie voor Azure OpenAI.

Deductie van het gegevensvlak

De rest van het artikel bevat informatie over de nieuwe versie van de v1 preview-API van de specificatie van de Azure OpenAI-gegevensvlakdeductie. Zie de handleiding voor de API-levenscyclus voor meer informatie.

Als u op zoek bent naar documentatie over de nieuwste versie van de GA API-release van v1, raadpleegt u de meest recente GA-gegevensvlakdeductie-API.

Spraak maken

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Hiermee genereert u tekst-naar-spraak-audio van de invoertekst.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Microsoft Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: multipart/form-data

Naam	Type	Description	Required	Default
Invoer	tekenreeks	De tekst voor het genereren van audio. De maximumlengte is 4096 tekens.	Ja
aanwijzingen	tekenreeks	Beheer de stem van uw gegenereerde audio met aanvullende instructies. Werkt niet met `tts-1` of `tts-1-hd`.	No
model	tekenreeks	Het model dat moet worden gebruikt voor deze tekst-naar-spraak-aanvraag.	Ja
responsformaat	Object	De ondersteunde audio-uitvoerindelingen voor tekst-naar-spraak.	No
speed	number	De snelheid van spraak voor gegenereerde audio. Waarden zijn geldig in het bereik van 0,25 tot 4.0, waarbij 1,0 de standaardwaarden en hogere waarden overeenkomen met snellere spraak.	No	1
stream_format	enum	De indeling waarin de audio moet worden gestreamd. Ondersteunde indelingen zijn `sse` en `audio`. `sse` wordt niet ondersteund voor `tts-1` of `tts-1-hd`. Mogelijke waarden: `sse`, `audio`	No
voice	Object		Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/octet-stream	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Synthetiseert audio van de opgegeven tekst.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

Antwoorden: Statuscode: 200

{
  "body": "101010101"
}

Transcriptie maken

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

Hiermee wordt audio getranscribeerd in de invoertaal.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: multipart/form-data

Naam	Type	Description	Required	Default
chunking_strategy	Object		No
└prefix_padding_ms	integer	De hoeveelheid audio die moet worden opgenomen vóór de gedetecteerde VAD-spraak (in milliseconden).	No	300
└silence_duration_ms	integer	Duur van stilte om spraakstop te detecteren (in milliseconden). Met kortere waarden reageert het model sneller, maar kan het inspringen op korte pauzes van de gebruiker.	No	200
└─ drempelwaarde	number	Gevoeligheidsdrempel (0,0 tot 1.0) voor spraakactiviteitsdetectie. Voor een hogere drempelwaarde is luider geluid nodig om het model te activeren en kan het dus beter presteren in luidruchtige omgevingen.	No	0,5
└type.	enum	Moet zijn ingesteld om handmatig segmenteren in te `server_vad` schakelen met behulp van VAD aan de serverzijde. Mogelijke waarden: `server_vad`	No
bestand	tekenreeks		Ja
filename	tekenreeks	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens.	No
include[]	gegevensreeks	Aanvullende informatie die moet worden opgenomen in het transcriptieantwoord. `logprobs` retourneert de logboekkans van de tokens in het antwoord om inzicht te krijgen in het vertrouwen van het model in de transcriptie. `logprobs`werkt alleen met response_format ingesteld op `json` en alleen met de modellen `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`en `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`.	No
language	tekenreeks	De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1 -indeling (bijvoorbeeld `en`) verbetert de nauwkeurigheid en latentie.	No
model	tekenreeks	Het model dat moet worden gebruikt voor deze transcriptieaanvraag.	No
prompt	tekenreeks	Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet overeenkomen met de audiotaal.	No
responsformaat	Object		No
stream	boolean	Als deze optie is ingesteld op true, worden de antwoordgegevens van het model naar de client gestreamd terwijl deze worden gegenereerd met behulp van door de server verzonden gebeurtenissen. Opmerking: Streaming wordt niet ondersteund voor het `whisper-1` model en wordt genegeerd.	No	Onwaar
Temperatuur	number	De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt.	No	0
timestamp_granularities[]	gegevensreeks	De tijdstempelgranulariteiten die moeten worden ingevuld voor deze transcriptie. `response_format` moet worden ingesteld `verbose_json` op het gebruik van tijdstempelgranulariteiten. Of beide van deze opties worden ondersteund: `word`, of `segment`. Opmerking: er is geen extra latentie voor segmenttijdstempels, maar het genereren van woordtijdstempels zorgt voor extra latentie.	No	['segment']

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureAudioTranscriptionResponse
text/plain	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Hiermee haalt u getranscribeerde tekst en bijbehorende metagegevens op uit de verstrekte gesproken audiogegevens.

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Antwoorden: Statuscode: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Vertaling maken

POST {endpoint}/openai/v1/audio/translations?api-version=preview

Hiermee haalt u getranscribeerde engelse tekst en bijbehorende metagegevens op van opgegeven gesproken audiogegevens.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: multipart/form-data

Naam	Type	Description	Required	Default
bestand	tekenreeks		Ja
filename	tekenreeks	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens	No
model	tekenreeks	Het model dat moet worden gebruikt voor deze vertaalaanvraag.	No
prompt	tekenreeks	Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet in het Engels zijn.	No
responsformaat	Object		No
Temperatuur	number	De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt.	No	0

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureAudioTranslationResponse
text/plain	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Hiermee haalt u getranscribeerde engelse tekst en bijbehorende metagegevens op van opgegeven gesproken audiogegevens.

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Antwoorden: Statuscode: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Chatvoltooiing maken

POST {endpoint}/openai/v1/chat/completions?api-version=preview

Hiermee maakt u een chatvoltooiing.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
audio	Object	Parameters voor audio-uitvoer. Vereist wanneer audio-uitvoer wordt aangevraagd met `modalities: ["audio"]`.	No
└─ formaat	enum	Hiermee geeft u de audio-indeling van de uitvoer. Moet een van `wav`, `mp3`of `flac`,`opus` of `pcm16`. Mogelijke waarden: `wav`, `aac`, `mp3`, `flac`, , `opuspcm16`	No
└─ stem	Object		No
data_sources	gegevensreeks	De gegevensbronnen die moeten worden gebruikt voor de functie On Your Data, exclusief voor Azure OpenAI.	No
frequency_penalty (frequentiebestraffing)	number	Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt.	No	0
function_call	enum	Als u een bepaalde functie opgeeft via dwingt `{"name": "my_function"}` u het model om die functie aan te roepen. Mogelijke waarden: `none`, `auto`	No
functions	gegevensreeks	Afgeschaft ten gunste van `tools`. Een lijst met functies waarvoor het model JSON-invoer kan genereren.	No
logitsvertekening	Object	Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing. Accepteert een JSON-object waarmee tokens (opgegeven door de token-id in de tokenizer) worden toegewezen aan een gekoppelde bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token.	No	Geen
logprobs	boolean	Of u nu logboekkansen van de uitvoertokens wilt retourneren of niet. Indien waar, retourneert u de logboekkans van elk uitvoertoken dat wordt geretourneerd in de van `contentmessage`.	No	Onwaar
max_completion_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens.	No
maximaal_aantal_tokens	integer	Het maximum aantal tokens dat kan worden gegenereerd in de voltooiing van de chat. Deze waarde kan worden gebruikt om de kosten voor tekst te beheren die via DE API wordt gegenereerd. Deze waarde is nu afgeschaft ten gunste van `max_completion_tokens`en is niet compatibel met o1-seriemodellen.	No
Berichten	gegevensreeks	Een lijst met berichten die tot nu toe bestaan uit het gesprek. Afhankelijk van het model dat u gebruikt, worden verschillende berichttypen (modaliteiten) ondersteund, zoals tekst, afbeeldingen en audio.	Ja
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
Modaliteiten	Object	Uitvoertypen die u door het model wilt genereren. De meeste modellen kunnen tekst genereren. Dit is de standaardinstelling: `["text"]` Het `gpt-4o-audio-preview` model kan ook worden gebruikt om audio te genereren. Als u wilt aanvragen dat dit model zowel tekst- als audioantwoorden genereert, kunt u het volgende gebruiken: `["text", "audio"]`	No
model	tekenreeks	De modelimplementatie-id die moet worden gebruikt voor de voltooiingsaanvraag voor chats.	Ja
n	integer	Hoeveel opties voor het voltooien van chats voor elk invoerbericht moeten worden gegenereerd. Houd er rekening mee dat er kosten in rekening worden gebracht op basis van het aantal gegenereerde tokens voor alle opties. `n` Houd `1` rekening met het minimaliseren van de kosten.	No	1
parallel_gereedschapsoproepen	Object	Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma.	No
prediction	Object	Basisweergave van voorspelde uitvoer van een model.	No
└type.	OpenAI.ChatOutputPredictionType		No
aanwezigheid_boete	number	Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten.	No	0
inspanning bij redeneren	Object	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
responsformaat	Object		No
└type.	enum	Mogelijke waarden: `text`, `json_objectjson_schema`	No
seed	integer	Deze functie bevindt zich in de bètaversie. Indien opgegeven, zal ons systeem een best inspanning leveren om de steekproef deterministisch uit te voeren, zodat herhaalde aanvragen met hetzelfde `seed` en parameters hetzelfde resultaat moeten retourneren. Determinisme is niet gegarandeerd en u moet verwijzen naar de `system_fingerprint` antwoordparameter om wijzigingen in de back-end te controleren.	No
stop	Object	Niet ondersteund met de nieuwste redeneringsmodellen `o3` en `o4-mini`. Maximaal vier reeksen waarbij de API stopt met het genereren van verdere tokens. De geretourneerde tekst bevat niet de stopvolgorde.	No
store	boolean	Of de uitvoer van deze chatvoltooiingsaanvraag al dan niet moet worden opgeslagen voor gebruik in modeldestillatie- of evaluatieproducten.	No	Onwaar
stream	boolean	Als deze optie is ingesteld op true, worden de antwoordgegevens van het model naar de client gestreamd terwijl deze worden gegenereerd met behulp van door de server verzonden gebeurtenissen.	No	Onwaar
stream_options	Object	Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt `stream: true`.	No
└include_usage	boolean	Als dit is ingesteld, wordt er vóór het `data: [DONE]` bericht een extra segment gestreamd. Het `usage` veld in dit segment toont de gebruiksstatistieken van tokens voor de hele aanvraag en het `choices` veld is altijd een lege matrix. Alle andere segmenten bevatten ook een `usage` veld, maar met een null-waarde. OPMERKING: Als de stream wordt onderbroken, ontvangt u mogelijk niet het uiteindelijke gebruikssegment dat het totale tokengebruik voor de aanvraag bevat.	No
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen. Het opgeven van een bepaald hulpprogramma via `{"type": "function", "function": {"name": "my_function"}}` dwingt het model om dat hulpprogramma aan te roepen. `none` is de standaardinstelling wanneer er geen hulpprogramma's aanwezig zijn. `auto` is de standaardinstelling als er hulpprogramma's aanwezig zijn.	No
tools	gegevensreeks	Een lijst met hulpprogramma's die het model kan aanroepen. Op dit moment worden alleen functies ondersteund als hulpprogramma. Gebruik dit om een lijst met functies op te geven waarvoor het model JSON-invoer kan genereren. Maximaal 128 functies worden ondersteund.	No
top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No	1
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik.	No
user_security_context	AzureUserSecurityContext	De beveiligingscontext van de gebruiker bevat verschillende parameters die de toepassing zelf beschrijven en de eindgebruiker die met de toepassing communiceert. Deze velden helpen uw beveiligingsteams om beveiligingsincidenten te onderzoeken en te beperken door een uitgebreide benadering te bieden voor het beveiligen van uw AI-toepassingen. Meer informatie over het beveiligen van AI-toepassingen met behulp van Microsoft Defender voor Cloud.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Hiermee maakt u een voltooiing voor de opgegeven prompt, parameters en het gekozen model.

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Antwoorden: Statuscode: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Embedding creëren

POST {endpoint}/openai/v1/embeddings?api-version=preview

Hiermee maakt u een insluitvector die de invoertekst vertegenwoordigt.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
dimensions	integer	Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Alleen ondersteund in `text-embedding-3` en latere modellen.	No
encoding_format	enum	De indeling waarin de insluitingen moeten worden geretourneerd. Kan een van `float` beide zijn of `base64`. Mogelijke waarden: `float`, `base64`	No
Invoer	tekenreeks of matrix		Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de insluitingsaanvraag.	Ja
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.CreateEmbeddingResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Retourneer de insluitingen voor een bepaalde prompt.

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

Antwoorden: Statuscode: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Lijst evaluaties

GET {endpoint}/openai/v1/evals?api-version=preview

Lijst met evaluaties voor een project.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
after	zoekopdracht	No	tekenreeks	Id voor de laatsteval van de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Een limiet voor het aantal evals dat moet worden geretourneerd in één pagineringsreactie.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`	Sorteervolgorde voor evals op tijdstempel. Gebruiken `asc` voor oplopende volgorde of `desc` voor aflopende volgorde.
sorteren_op	zoekopdracht	No	tekenreeks Mogelijke waarden: `created_at`, `updated_at`	Evals kunnen worden besteld op aanmaaktijd of laatst bijgewerkte tijd. Gebruik `created_at` deze functie voor aanmaaktijd of `updated_at` voor de laatst bijgewerkte tijd.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Createeval

POST {endpoint}/openai/v1/evals?api-version=preview

Maak de structuur van een evaluatie die kan worden gebruikt om de prestaties van een model te testen.

Een evaluatie is een set testcriteria en een gegevensbron. Nadat u een evaluatie hebt gemaakt, kunt u deze uitvoeren op verschillende modellen en modelparameters. We ondersteunen verschillende typen graders en gegevensbronnen.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
gegevensbron_configuratie	Object		Ja
└type.	OpenAI.EvalDataSourceConfigType		No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de evaluatie.	No
statuscode	enum	Mogelijke waarden: `201`	Ja
testing_criteria	gegevensreeks	Een lijst met graders voor alle evaluatieuitvoeringen in deze groep. Graders kunnen verwijzen naar variabelen in de gegevensbron met dubbele accolades, zoals `{{item.variable_name}}`. Als u naar de uitvoer van het model wilt verwijzen, gebruikt u de `sample` naamruimte (ie, `{{sample.output_text}}`).	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

eval ophalen

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Haal een evaluatie op met de bijbehorende id. Hiermee wordt een evaluatie opgehaald op basis van de id.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Evaluatie bijwerken

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Selecteer, veranderlijke eigenschappen van een opgegeven evaluatie bijwerken.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
metadata	OpenAI.MetadataPropertyForRequest	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks		No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Eval verwijderen

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Een opgegeven evaluatie verwijderen.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	Object

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Eval-uitvoeringen ophalen

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Haal een lijst met uitvoeringen voor een opgegeven evaluatie op.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks
after	zoekopdracht	No	tekenreeks
limit	zoekopdracht	No	integer
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`
status	zoekopdracht	No	tekenreeks Mogelijke waarden: `queued`, `in_progress`, `completed`, , `canceledfailed`

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalRunList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Eval-uitvoering maken

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Maak een nieuwe evaluatieuitvoering, met het begin van het beoordelingsproces.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
gegevensbron	Object		Ja
└type.	OpenAI.EvalRunDataSourceType		No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de uitvoering.	No

Responses

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Eval-uitvoering ophalen

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Haal een specifieke evaluatie op die wordt uitgevoerd op basis van de id.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks
run_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Evaluatieuitvoering annuleren

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Annuleer een specifieke evaluatieuitvoering op basis van de bijbehorende id.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks
run_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

Verwijder een specifieke evaluatie die wordt uitgevoerd op basis van de bijbehorende id.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks
run_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	Object

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Uitvoeritems voor eval-uitvoering ophalen

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

Haal een lijst met uitvoeritems op voor een opgegeven evaluatieuitvoering.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks
run_id	path	Ja	tekenreeks
after	zoekopdracht	No	tekenreeks
limit	zoekopdracht	No	integer
status	zoekopdracht	No	tekenreeks Mogelijke waarden: `fail`, `pass`
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalRunOutputItemList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Uitvoeritem voor eval-uitvoering ophalen

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

Haal een specifiek uitvoeritem op uit een evaluatie die wordt uitgevoerd op basis van de id.

OPMERKING: Deze Azure OpenAI-API is in preview en kan worden gewijzigd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Ja	tekenreeks Mogelijke waarden: `preview`	Hiermee kunt u toegang krijgen tot AOAI Evals, een preview-functie. Voor deze functie moet de header 'aoai-evals' worden ingesteld op 'preview'.
eval_id	path	Ja	tekenreeks
run_id	path	Ja	tekenreeks
uitvoer_item_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.EvalRunOutputItem

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Een bestand maken

POST {endpoint}/openai/v1/files?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: multipart/form-data

Naam	Type	Description	Required
verloopt_na	Object		Ja
└─ Anker	AzureFileExpiryAnchor		No
└─ seconden	integer		No
bestand	tekenreeks		Ja
purpose	enum	Het beoogde doel van het geüploade bestand. Een van: - `assistants`Wordt gebruikt in de Assistent-API - `batch`: Gebruikt in de Batch-API - `fine-tune`: Gebruikt voor het afstemmen - `evals`: Gebruikt voor devalgegevenssets Mogelijke waarden: `assistants`, `batch`, , `fine-tuneevals`	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureOpenAIFile

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

POST {endpoint}/openai/v1/files?api-version=preview

Bestanden in een lijst weergeven

GET {endpoint}/openai/v1/files?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
purpose	zoekopdracht	No	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureListFilesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Bestand ophalen

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
file_id	path	Ja	tekenreeks	De id van het bestand dat voor deze aanvraag moet worden gebruikt.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureOpenAIFile

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Bestand verwijderen

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
file_id	path	Ja	tekenreeks	De id van het bestand dat voor deze aanvraag moet worden gebruikt.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.DeleteFileResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Download bestand

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
file_id	path	Ja	tekenreeks	De id van het bestand dat voor deze aanvraag moet worden gebruikt.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/octet-stream	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

Voer een cijfer uit.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
Grader	Object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Ja
└calculate_output	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	No
└evaluation_metric	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	No
└* graders	Object		No
└image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└input.	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└model.	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	No
└─naam	tekenreeks	De naam van de cijferaar.	No
└─ bewerking	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ bereik	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ Referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	No
└─sampling_params		De steekproefparameters voor het model.	No
└* bron	tekenreeks	De broncode van het Python-script.	No
└type.	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No
item		Het gegevenssetitem dat aan de grader is verstrekt. Deze wordt gebruikt om de `item` naamruimte te vullen.	No
model_sample	tekenreeks	Het modelvoorbeeld dat moet worden geëvalueerd. Deze waarde wordt gebruikt om de `sample` naamruimte te vullen. De `output_json` variabele wordt ingevuld als het modelvoorbeeld een geldige JSON-tekenreeks is.	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.RunGraderResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Grader valideren

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

Valideer een cijfer.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
Grader	Object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Ja
└calculate_output	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	No
└evaluation_metric	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	No
└* graders	Object		No
└image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└input.	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└model.	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	No
└─naam	tekenreeks	De naam van de cijferaar.	No
└─ bewerking	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ bereik	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ Referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	No
└─sampling_params		De steekproefparameters voor het model.	No
└* bron	tekenreeks	De broncode van het Python-script.	No
└type.	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ValidateGraderResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Taak voor het afstemmen maken

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Hiermee maakt u een taak voor het afstemmen van het proces voor het maken van een nieuw model op basis van een bepaalde gegevensset.

Antwoord bevat details van de enqueued taak, inclusief taakstatus en de naam van de nauwkeurig afgestemde modellen zodra deze zijn voltooid.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
hyperparameters (instellingen die een model beïnvloeden)	Object	De hyperparameters die worden gebruikt voor de afstemmingstaak. Deze waarde is nu afgeschaft ten gunste van `method`en moet worden doorgegeven onder de `method` parameter.	No
└ batch_size	enum	Mogelijke waarden: `auto`	No
└learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
└n_epochs	enum	Mogelijke waarden: `auto`	No
integraties	gegevensreeks	Een lijst met integraties waarmee u uw taak kunt verfijnen.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	tekenreeks (zie geldige modellen hieronder)	De naam van het model om af te stemmen.	Ja
seed	integer	Het zaad bepaalt de reproduceerbaarheid van de taak. Het doorgeven van dezelfde seed- en taakparameters moet dezelfde resultaten opleveren, maar kan in zeldzame gevallen verschillen. Als er geen seed is opgegeven, wordt er een voor u gegenereerd.	No
achtervoegsel	tekenreeks	Een tekenreeks van maximaal 64 tekens die wordt toegevoegd aan de aangepaste modelnaam. Een van 'custom-model-name' produceert bijvoorbeeld `suffix` een modelnaam zoals `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	No	Geen
training_file	tekenreeks	De id van een geüpload bestand dat trainingsgegevens bevat. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. Daarnaast moet u uw bestand uploaden met het doel `fine-tune`. De inhoud van het bestand moet verschillen, afhankelijk van of het model gebruikmaakt van de chat, voltooiingsindeling of als de methode voor het afstemmen gebruikmaakt van de voorkeursindeling.	Ja
validatiebestand	tekenreeks	De id van een geüpload bestand dat validatiegegevens bevat. Als u dit bestand opgeeft, worden de gegevens gebruikt om periodiek validatiegegevens te genereren tijdens het afstemmen. Deze metrische gegevens kunnen worden weergegeven in het resultatenbestand voor het afstemmen van de resultaten. Dezelfde gegevens mogen niet aanwezig zijn in zowel trein- als validatiebestanden. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. U moet uw bestand uploaden met het doel `fine-tune`.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Gepagineerde taken weergeven

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

De afstemmingstaken van uw organisatie vermelden

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
after	zoekopdracht	No	tekenreeks	Id voor de laatste taak uit de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal taakafstemmingen dat moet worden opgehaald.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Taak voor afstemmen ophalen

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

Krijg informatie over een afstemmingstaak.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
fine_tuning_job_id	path	Ja	tekenreeks	De id van de taak voor het afstemmen.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Taak voor het afstemmen annuleren

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

Onmiddellijk een taak voor het afstemmen annuleren.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
fine_tuning_job_id	path	Ja	tekenreeks	De id van de taak voor het afstemmen om te annuleren.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Controlepunten voor taakafstemming weergeven

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

Vermeld de controlepunten voor een taak voor het afstemmen.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
fine_tuning_job_id	path	Ja	tekenreeks	De id van de taak voor het afstemmen van controlepunten.
after	zoekopdracht	No	tekenreeks	Id voor de laatste controlepunt-id van de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal controlepunten dat moet worden opgehaald.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Afstemmingsgebeurtenissen weergeven

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

Statusupdates ophalen voor een taak voor het afstemmen van de taak.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
fine_tuning_job_id	path	Ja	tekenreeks	De id van de taak voor het afstemmen van gebeurtenissen.
after	zoekopdracht	No	tekenreeks	Id voor de laatste gebeurtenis uit de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal gebeurtenissen dat moet worden opgehaald.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Taak voor het afstemmen onderbreken

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

Een taak verfijnen.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
fine_tuning_job_id	path	Ja	tekenreeks	De id van de taak voor het afstemmen om te onderbreken.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Taak voor afstemmen hervatten

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

Een onderbroken taak hervatten.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
fine_tuning_job_id	path	Ja	tekenreeks	De id van de taak voor het afstemmen om te hervatten.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Afbeeldingsbewerking maken

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: multipart/form-data

Naam	Type	Description	Required	Default
achtergrond	enum	Hiermee kunt u transparantie instellen voor de achtergrond van de gegenereerde installatiekopieën. Deze parameter wordt alleen ondersteund voor `gpt-image-1` modellen. Moet een van `transparent`, `opaque` of `auto` (standaardwaarde) zijn. Wanneer `auto` het model wordt gebruikt, wordt automatisch de beste achtergrond voor de afbeelding bepaald. Als `transparent`de uitvoerindeling transparantie moet ondersteunen, moet deze worden ingesteld op `png` (standaardwaarde) of `webp`. Mogelijke waarden: `transparent`, `opaqueauto`	No
afbeelding	tekenreeks of matrix		Ja
mask	tekenreeks		No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor de bewerking voor het bewerken van afbeeldingen.	Ja
n	integer	Het aantal afbeeldingen dat moet worden gegenereerd. Moet tussen 1 en 10 zijn.	No	1
uitvoercompressie	integer	Het compressieniveau (0-100%) voor de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen met de `webp` of `jpeg` uitvoerindelingen en wordt standaard ingesteld op 100.	No	100
uitvoerformaat	enum	De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen. Moet een van `png`, `jpeg`of `webp`. De standaardwaarde is `png`. Mogelijke waarden: `png`, `jpegwebp`	No
prompt	tekenreeks	Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 1000 tekens voor `dall-e-2`en 32000 tekens voor `gpt-image-1`-seriemodellen.	Ja
kwaliteit	enum	De kwaliteit van de afbeelding die wordt gegenereerd. `high`en `mediumlow` worden alleen ondersteund voor `gpt-image-1`-series-modellen. `dall-e-2` ondersteunt `standard` alleen kwaliteit. Standaard ingesteld op `auto`. Mogelijke waarden: `standard`, `low`, `medium`, , `highauto`	No
responsformaat	enum	De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Moet een van `url` of `b64_json`. URL's zijn slechts 60 minuten geldig nadat de afbeelding is gegenereerd. Deze parameter wordt alleen ondersteund voor `dall-e-2`, omdat `gpt-image-1`-series-modellen altijd base64-gecodeerde afbeeldingen retourneren. Mogelijke waarden: `url`, `b64_json`	No
size	enum	De grootte van de gegenereerde afbeeldingen. Moet een van `1024x1024`, `1536x1024` (liggend), `1024x1536` (staand) of `auto` (standaardwaarde) zijn voor `gpt-image-1`-seriemodellen, en een van `256x256`, `512x512`of `1024x1024` voor `dall-e-2`. Mogelijke waarden: `256x256`, `512x512`, `1024x1024`, `1536x1024`, , `1024x1536auto`	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureImagesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Createimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
achtergrond	enum	Hiermee kunt u transparantie instellen voor de achtergrond van de gegenereerde installatiekopieën. Deze parameter wordt alleen ondersteund voor `gpt-image-1` modellen. Moet een van `transparent`, `opaque` of `auto` (standaardwaarde) zijn. Wanneer `auto` het model wordt gebruikt, wordt automatisch de beste achtergrond voor de afbeelding bepaald. Als `transparent`de uitvoerindeling transparantie moet ondersteunen, moet deze worden ingesteld op `png` (standaardwaarde) of `webp`. Mogelijke waarden: `transparent`, `opaqueauto`	No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor het genereren van installatiekopieën.	Ja
moderation	enum	Het inhoudsbeheerniveau beheren voor afbeeldingen die worden gegenereerd door `gpt-image-1`-seriemodellen. Moet voor minder beperkend filteren of `low` (standaardwaarde) zijn`auto`. Mogelijke waarden: `low`, `auto`	No
n	integer	Het aantal afbeeldingen dat moet worden gegenereerd. Moet tussen 1 en 10 zijn. Voor `dall-e-3`, wordt alleen `n=1` ondersteund.	No	1
uitvoercompressie	integer	Het compressieniveau (0-100%) voor de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen met de `webp` of `jpeg` uitvoerindelingen en wordt standaard ingesteld op 100.	No	100
uitvoerformaat	enum	De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen. Moet een van `png`, `jpeg`of `webp`. Mogelijke waarden: `png`, `jpegwebp`	No
prompt	tekenreeks	Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 32000 tekens voor `gpt-image-1`-seriemodellen, 1000 tekens voor `dall-e-2` en 4000 tekens voor `dall-e-3`.	Ja
kwaliteit	enum	De kwaliteit van de afbeelding die wordt gegenereerd. - `auto` (standaardwaarde) selecteert automatisch de beste kwaliteit voor het opgegeven model. - `high`en `mediumlow` worden ondersteund voor `gpt-image-1`-series-modellen. - `hd` en `standard` worden ondersteund voor `dall-e-3`. - `standard` is de enige optie voor `dall-e-2`. Mogelijke waarden: `standard`, `hd`, `low`, `medium`, , `highauto`	No
responsformaat	enum	De indeling waarin gegenereerde afbeeldingen met `dall-e-2` en `dall-e-3` worden geretourneerd. Moet een van `url` of `b64_json`. URL's zijn slechts 60 minuten geldig nadat de afbeelding is gegenereerd. Deze parameter wordt niet ondersteund voor `gpt-image-1`-seriemodellen die altijd base64-gecodeerde afbeeldingen retourneren. Mogelijke waarden: `url`, `b64_json`	No
size	enum	De grootte van de gegenereerde afbeeldingen. Moet een van `1024x1024`, `1536x1024` (liggend), `1024x1536` (staand) of `auto` (standaardwaarde) zijn voor `gpt-image-1`-seriemodellen, een van `256x256`, `512x512`of voor `1024x1024`, en `dall-e-2` een van `1024x1024`, `1792x1024`of `1024x1792` voor `dall-e-3`. Mogelijke waarden: `auto`, `1024x1024`, `1536x1024`, `1024x1536`, `256x256`, , `512x5121792x10241024x1792`	No
Stijl	enum	De stijl van de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor `dall-e-3`. Moet een van `vivid` of `natural`. Levendig zorgt ervoor dat het model leunt op het genereren van hyper-echte en dramatische afbeeldingen. Natuurlijk zorgt ervoor dat het model natuurlijkere, minder hyper-echte afbeeldingen produceert. Mogelijke waarden: `vivid`, `natural`	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureImagesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Hiermee maakt u installatiekopieën op basis van een prompt.

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Antwoorden: Statuscode: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Modellen weergeven

GET {endpoint}/openai/v1/models?api-version=preview

Een lijst met de momenteel beschikbare modellen en bevat basisinformatie over elk model, zoals de eigenaar en beschikbaarheid.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListModelsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Model ophalen

GET {endpoint}/openai/v1/models/{model}?api-version=preview

Hiermee haalt u een modelexemplaren op, met basisinformatie over het model, zoals de eigenaar en machtigingen.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
model	path	Ja	tekenreeks	De id van het model dat voor deze aanvraag moet worden gebruikt.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.Model

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Antwoord maken

POST {endpoint}/openai/v1/responses?api-version=preview

Hiermee maakt u een modelantwoord.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
include	gegevensreeks	Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn: - `code_interpreter_call.outputs`: Bevat de uitvoer van de uitvoering van Python-code in het code-interpreter-hulpprogramma aanroepitems. - `computer_call_output.output.image_url`: Neem afbeeldings-URL's op uit de uitvoer van de computeroproep. - `file_search_call.results`: Neem de zoekresultaten van de aanroep van het zoekprogramma voor bestanden op. - `message.input_image.image_url`: Neem afbeeldings-URL's op uit het invoerbericht. - `message.output_text.logprobs`: Neem logprobs op met assistentberichten. - `reasoning.encrypted_content`: Bevat een versleutelde versie van redeneringstokens in itemuitvoer met redenering. Hierdoor kunnen redeneringsitems worden gebruikt in gesprekken met meerdere paden wanneer de antwoorden-API staatloos wordt gebruikt (zoals wanneer de `store` parameter is ingesteld `false`op, of wanneer een organisatie is ingeschreven in het retentieprogramma voor gegevens nul).	No
Invoer	tekenreeks of matrix		No
aanwijzingen	tekenreeks	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
max_gereedschap_aanroepen	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	Ja
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
previous_response_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
prompt	Object	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* id	tekenreeks	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└* variabelen	OpenAI.ResponsePromptVariables	Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere antwoordinvoertypen, zoals afbeeldingen of bestanden.	No
└─ versie	tekenreeks	Optionele versie van de promptsjabloon.	No
reasoning	Object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
└─generate_summary	enum	Afgeschaft: gebruik `summary` in plaats daarvan. Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
Samenvatting └─	enum	Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
store	boolean	Of het gegenereerde modelantwoord moet worden opgeslagen voor later ophalen via API.	No	True
stream	boolean	Als deze optie is ingesteld op true, worden de antwoordgegevens van het model naar de client gestreamd terwijl deze worden gegenereerd met behulp van door de server verzonden gebeurtenissen.	No	Onwaar
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No	1
tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Object	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen.	No
└type.	OpenAI.ToolChoiceObjectType	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.	No
tools	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. Jij kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI die de mogelijkheden van het model uitbreiden, zoals het zoeken naar bestanden. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u worden gedefinieerd, zodat het model uw eigen code kan aanroepen.	No
top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No	1
truncation	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeld

Een modelantwoord maken

POST {endpoint}/openai/v1/responses?api-version=preview

Ontvang reactie

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Haalt een modelantwoord op met de opgegeven id.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Ja	tekenreeks
include[]	zoekopdracht	No	gegevensreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AzureResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Antwoord verwijderen

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Hiermee verwijdert u een antwoord op id.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	Object

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Invoeritems weergeven

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

Retourneert een lijst met invoeritems voor een bepaald antwoord.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Ja	tekenreeks
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`	Sorteer de volgorde op de `created_at` tijdstempel van de objecten. `asc` voor oplopende volgorde en`desc` voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `after` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `before` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ResponseItemList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Lijstvectorarchieven

GET {endpoint}/openai/v1/vector_stores?api-version=preview

Retourneert een lijst met vectorarchieven.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`	Sorteer de volgorde op de `created_at` tijdstempel van de objecten. `asc` voor oplopende volgorde en`desc` voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `after` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `before` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListVectorStoresResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector store maken

POST {endpoint}/openai/v1/vector_stores?api-version=preview

Hiermee maakt u een vectorarchief.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
chunking_strategy	Object	De standaardstrategie. Deze strategie maakt momenteel gebruik van een `max_chunk_size_tokens` van `800` en `chunk_overlap_tokens` van `400`.	No
└* statisch	OpenAI.StaticChunkingStrategy		No
└type.	enum	Altijd `static`. Mogelijke waarden: `static`	No
verloopt_na	OpenAI.VectorStoreExpirationAfter	Het verloopbeleid voor een vectorarchief.	No
file_ids	gegevensreeks	Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van het vectorarchief.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Voorbeelden

Voorbeeldbestand is niet gevonden: ./examples/vector_stores.json

Vectorarchief ophalen

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Hiermee haalt u een vectorarchief op.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief dat moet worden opgehaald.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vectorarchief wijzigen

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Hiermee wijzigt u een vectorarchief.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief dat moet worden gewijzigd.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
verloopt_na	Object	Het verloopbeleid voor een vectorarchief.	No
└─ Anker	enum	Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: `last_active_at`. Mogelijke waarden: `last_active_at`	No
└ dagen	integer	Het aantal dagen na de ankertijd dat het vectorarchief verloopt.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van het vectorarchief.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vectorarchief verwijderen

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Een vectorarchief verwijderen.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief dat moet worden verwijderd.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.DeleteVectorStoreResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector Store-bestandsbatch maken

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

Maak een bestandsbatch voor vectoropslag.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waarvoor een bestandsbatch moet worden gemaakt.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de `auto` strategie gebruikt.	No
file_ids	gegevensreeks	Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector Store-bestandsbatch ophalen

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

Hiermee haalt u een bestandsbatch van het vectorarchief op.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waartoe de bestandsbatch behoort.
batch_id	path	Ja	tekenreeks	De id van de bestandsbatch die wordt opgehaald.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector Store-bestandsbatch annuleren

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

Annuleer een bestandsbatch voor het vectorarchief. Hiermee wordt geprobeerd de verwerking van bestanden in deze batch zo snel mogelijk te annuleren.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waartoe de bestandsbatch behoort.
batch_id	path	Ja	tekenreeks	De id van de bestandsbatch die moet worden geannuleerd.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Bestanden weergeven in vector store batch

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

Retourneert een lijst met vectoropslagbestanden in een batch.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waartoe de bestandsbatch behoort.
batch_id	path	Ja	tekenreeks	De id van de bestandsbatch waartoe de bestanden behoren.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`	Sorteer de volgorde op de `created_at` tijdstempel van de objecten. `asc` voor oplopende volgorde en`desc` voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `after` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `before` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen.
filter	zoekopdracht	No		Filteren op bestandsstatus. Een van`in_progress`, `completed`, `failed`, . `cancelled`

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListVectorStoreFilesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Bestanden voor lijstvectoropslag

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Hiermee wordt een lijst met vectoropslagbestanden geretourneerd.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waartoe de bestanden behoren.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`	Sorteer de volgorde op de `created_at` tijdstempel van de objecten. `asc` voor oplopende volgorde en`desc` voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `after` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep na=obj_foo worden opgenomen om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `before` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een lijstaanvraag indient en 100 objecten ontvangt die eindigen op obj_foo, kan de volgende aanroep vóór=obj_foo worden opgenomen om de vorige pagina van de lijst op te halen.
filter	zoekopdracht	No		Filteren op bestandsstatus. Een van`in_progress`, `completed`, `failed`, . `cancelled`

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.ListVectorStoreFilesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector Store-bestand maken

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Maak een vectorarchiefbestand door een bestand toe te voegen aan een vectorarchief.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waarvoor een bestand moet worden gemaakt.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de `auto` strategie gebruikt.	No
file_id	tekenreeks	Een bestands-id die door het vectorarchief moet worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreFileObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector Store-bestand ophalen

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Hiermee haalt u een vectorarchiefbestand op.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waartoe het bestand behoort.
file_id	path	Ja	tekenreeks	De id van het bestand dat wordt opgehaald.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreFileObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Bestandskenmerken van vector store bijwerken

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks
file_id	path	Ja	tekenreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.VectorStoreFileObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Vector Store-bestand verwijderen

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Een vectorarchiefbestand verwijderen. Hiermee wordt het bestand uit het vectorarchief verwijderd, maar het bestand zelf wordt niet verwijderd. Als u het bestand wilt verwijderen, gebruikt u het eindpunt van het bestand verwijderen.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
vector_store_id	path	Ja	tekenreeks	De id van het vectorarchief waartoe het bestand behoort.
file_id	path	Ja	tekenreeks	De id van het te verwijderen bestand.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	OpenAI.DeleteVectorStoreFileResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureErrorResponse

Taken voor het genereren van video's - Maken

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Hiermee maakt u een nieuwe taak voor het genereren van video's.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Aanvraaglichaam

Inhoudstype: toepassing/json

Naam	Type	Description	Required	Default
height	integer	De hoogte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja
model	tekenreeks	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Ja
n_seconds	integer	De duur van de videogeneratietaak. Moet tussen 1 en 20 seconden zijn.	No	5
n_variants	integer	Het aantal video's dat moet worden gemaakt als varianten voor deze taak. Moet tussen 1 en 5 zijn. Kleinere afmetingen maken meer varianten mogelijk.	No	1
prompt	tekenreeks	De prompt voor deze videogeneratietaak.	Ja
width	integer	De breedte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja

Aanvraaglichaam

Inhoudstype: multipart/form-data

Naam	Type	Description	Required	Default
files	gegevensreeks		Ja
height	integer	De hoogte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja
inpaint_items	gegevensreeks	Optionele inpainting-items voor deze videogeneratietaak.	No
model	tekenreeks	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Ja
n_seconds	integer	De duur van de videogeneratietaak. Moet tussen 1 en 20 seconden zijn.	No	5
n_variants	integer	Het aantal video's dat moet worden gemaakt als varianten voor deze taak. Moet tussen 1 en 5 zijn. Kleinere afmetingen maken meer varianten mogelijk.	No	1
prompt	tekenreeks	De prompt voor deze videogeneratietaak.	Ja
width	integer	De breedte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	VideoGenerationJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Voorbeelden

Voorbeeldbestand is niet gevonden: ./examples/create_video_generation_job_simple.json

Taken voor het genereren van video's - Lijst

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Een lijst met taken voor het genereren van video's.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
voordat	zoekopdracht	No	tekenreeks
after	zoekopdracht	No	tekenreeks
limit	zoekopdracht	Ja	integer
statuses	zoekopdracht	No	gegevensreeks

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	VideoGenerationJobList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Voorbeelden

Voorbeeldbestand is niet gevonden: ./examples/get_video_generation_job_list.json

Taken voor het genereren van video's - Ophalen

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Hiermee worden eigenschappen van een videogeneratietaak opgehaald.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
job-id	path	Ja	tekenreeks	De id van de taak voor het genereren van video's die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	VideoGenerationJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Voorbeelden

Voorbeeldbestand is niet gevonden: ./examples/get_video_generation_job.json

Taken voor het genereren van video's - Verwijderen

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Hiermee verwijdert u een taak voor het genereren van video's.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
job-id	path	Ja	tekenreeks	De id van de taak voor het genereren van video's die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Videogeneraties - Get

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Hiermee haalt u een videogeneratie op id op.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Ja	tekenreeks	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	VideoGeneration

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Voorbeelden

Voorbeeldbestand is niet gevonden: ./examples/get_video_generation.json

Videogeneraties - Miniatuur ophalen

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Hiermee haalt u een miniatuur van de gegenereerde video-inhoud op.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Ja	tekenreeks	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
afbeelding/jpg	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Videogeneraties - Video-inhoud ophalen

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Haalt de gegenereerde video-inhoud op.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Ja	tekenreeks	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.
kwaliteit	zoekopdracht	No

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
video/mp4	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Videogeneraties - Alleen videocontent-headers ophalen

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Haalt headers op voor de gegenereerde video-inhoud.

URI-parameters

Naam	In	Required	Type	Description
endpoint	path	Ja	tekenreeks URL	Ondersteunde Azure OpenAI-eindpunten (protocol en hostnaam, bijvoorbeeld: `https://aoairesource.openai.azure.com`. Vervang 'aoairesource' door uw Azure OpenAI-resourcenaam). https://{your-resource-name}.openai.azure.com
api-versie	zoekopdracht	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Ja	tekenreeks	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.
kwaliteit	zoekopdracht	No

Koptekst van aanvraag

Gebruik verificatie op basis van tokens of API-sleutel. Verificatie met verificatie op basis van tokens wordt aanbevolen en veiliger.

Naam	Required	Type	Description
Autorisatie	True	tekenreeks	Voorbeeld:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` To genereer een verificatietoken met behulp van Azure CLI: `az account get-access-token --resource https://cognitiveservices.azure.com` Type: oauth2 Autorisatie-URL: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` Scope: `https://ai.azure.com/.default`
API-sleutel	True	tekenreeks	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

Definieert de mogelijke descriptors voor beschikbare antwoorden voor audiobewerkingen.

Property	Value
Description	Definieert de mogelijke descriptors voor beschikbare antwoorden voor audiobewerkingen.
Typ	tekenreeks
waarden	`transcribe` `translate`

AudioTranslationSegment

Uitgebreide informatie over één segment van vertaalde audiogegevens. Segmenten vertegenwoordigen over het algemeen ongeveer 5-10 seconden spraak. Segmentgrenzen komen meestal voor tussen woorden, maar niet noodzakelijkerwijs zinnen.

Naam	Type	Description	Required
avg_logprob	number	De gemiddelde logboekkans die aan dit audiosegment is gekoppeld.	Ja
compression_ratio	number	De compressieverhouding van dit audiosegment.	Ja
einde	number	Het tijdstip waarop dit segment eindigde ten opzichte van het begin van de vertaalde audio.	Ja
identiteitskaart	integer	De op 0 gebaseerde index van dit segment binnen een vertaling.	Ja
no_speech_prob	number	De kans op geen spraakdetectie binnen dit audiosegment.	Ja
seek	integer	De zoekpositie die is gekoppeld aan de verwerking van dit audiosegment. Zoekposities worden uitgedrukt als honderdsten van seconden. Het model kan verschillende segmenten verwerken vanaf één zoekpositie, dus terwijl de zoekpositie nooit een later tijdstip vertegenwoordigt dan het begin van het segment, kan het begin van het segment een aanzienlijk latere tijd vertegenwoordigen dan de bijbehorende zoekpositie van het segment.	Ja
start	number	Het tijdstip waarop dit segment begon ten opzichte van het begin van de vertaalde audio.	Ja
Temperatuur	number	De temperatuurscore die aan dit audiosegment is gekoppeld.	Ja
tekst	tekenreeks	De vertaalde tekst die deel uitmaakte van dit audiosegment.	Ja
tokens	gegevensreeks	De token-id's die overeenkomen met de vertaalde tekst in dit audiosegment.	Ja

AzureAIFoundryModelsApiVersion

Property	Value
Typ	tekenreeks
waarden	`v1` `preview`

AzureAudioTranscriptionResponse

Resultaatinformatie voor een bewerking waarmee gesproken audio in geschreven tekst is getranscribeerd.

Naam	Type	Description	Required
duration	number	De totale duur van de audio die is verwerkt om bijbehorende transcriptiegegevens te produceren.	No
language	tekenreeks	De gesproken taal die is gedetecteerd in de getranscribeerde audiogegevens. Dit wordt uitgedrukt als een ISO-639-1-taalcode van twee letters, zoals 'en' of 'fr'.	No
segments	gegevensreeks	Een verzameling informatie over de timing, waarschijnlijkheden en andere details van elk verwerkt audiosegment.	No
taak	Object	Definieert de mogelijke descriptors voor beschikbare antwoorden voor audiobewerkingen.	No
tekst	tekenreeks	De getranscribeerde tekst voor de opgegeven audiogegevens.	Ja
words	gegevensreeks	Een verzameling informatie over de timing van elk verwerkt woord.	No

AzureAudioTranslationResponse

Resultaatinformatie voor een bewerking waarmee gesproken audio in geschreven tekst is vertaald.

Naam	Type	Description	Required
duration	number	De totale duur van de audio die is verwerkt voor het produceren van begeleidende vertaalgegevens.	No
language	tekenreeks	De gesproken taal die is gedetecteerd in de vertaalde audiogegevens. Dit wordt uitgedrukt als een ISO-639-1-taalcode van twee letters, zoals 'en' of 'fr'.	No
segments	gegevensreeks	Een verzameling informatie over de timing, waarschijnlijkheden en andere details van elk verwerkt audiosegment.	No
taak	Object	Definieert de mogelijke descriptors voor beschikbare antwoorden voor audiobewerkingen.	No
tekst	tekenreeks	De vertaalde tekst voor de opgegeven audiogegevens.	Ja

AzureChatCompletionResponseMessage

Het uitgebreide antwoordmodelonderdeel voor antwoordberichten voor chatvoltooiing in de Azure OpenAI-service. Dit model voegt ondersteuning toe voor chatberichtcontext, die wordt gebruikt door de functie On Your Data voor intentie, bronvermeldingen en andere informatie met betrekking tot het ophalen van uitgebreide generatie.

Naam	Type	Description	Required
annotations	gegevensreeks	Aantekeningen voor het bericht, indien van toepassing, zoals bij het gebruik van het webzoekprogramma.	No
audio	Object	Als de modaliteit van de audio-uitvoer wordt aangevraagd, bevat dit object gegevens over het audioantwoord van het model.	No
└* gegevens	tekenreeks	Met Base64 gecodeerde audiobytes die door het model zijn gegenereerd, in de indeling die is opgegeven in de aanvraag.	No
└─ vervalt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer dit audioantwoord niet langer toegankelijk is op de server voor gebruik in gesprekken met meerdere paden.	No
└* id	tekenreeks	Unieke id voor dit audioantwoord.	No
└* transcriptie	tekenreeks	Transcriptie van de audio die door het model wordt gegenereerd.	No
inhoud	tekenreeks	De inhoud van het bericht.	Ja
context	Object	Een extra eigenschap die is toegevoegd aan antwoordberichten over chatvoltooiing, geproduceerd door de Azure OpenAI-service bij gebruik van extensiegedrag. Dit omvat intentie- en bronvermeldingsgegevens uit de functie On Your Data.	No
└all_retrieved_documents	Object	Samenvattingsinformatie over documenten die zijn opgehaald door de bewerking voor het ophalen van gegevens.	No
└chunk_id	tekenreeks	De segment-id voor de bronvermelding.	No
└* inhoud	tekenreeks	De inhoud van de bronvermelding.	No
└gegevensbron_index	integer	De index van de gegevensbron die wordt gebruikt voor het ophalen.	No
└─ bestandspad	tekenreeks	Het bestandspad voor de bronvermelding.	No
└ filter_reason	enum	Indien van toepassing, geeft u aan waarom het document is gefilterd. Mogelijke waarden: `score`, `rerank`	No
└originele_zoekscore	number	De oorspronkelijke zoekscore voor het ophalen.	No
└ rerank_score	number	De rerankscore voor het ophalen.	No
└─ zoekopdrachten	gegevensreeks	De zoekquery's die worden uitgevoerd om documenten op te halen.	No
└─ Titel	tekenreeks	De titel voor de bronvermelding.	No
URL └*	tekenreeks	De URL van de bronvermelding.	No
└* bronvermeldingen	gegevensreeks	De bronvermeldingen die worden geproduceerd door het ophalen van gegevens.	No
└intentie.	tekenreeks	De gedetecteerde intentie uit de chatgeschiedenis, die wordt gebruikt om de gesprekscontext tussen interacties te dragen	No
function_call	Object	Afgeschaft en vervangen door `tool_calls`. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.	No
└; argumenten	tekenreeks		No
└─naam	tekenreeks		No
reasoning_content	tekenreeks	Een Azure-specifieke extensieeigenschap met gegenereerde redeneringsinhoud van ondersteunde modellen.	No
weigering	tekenreeks	Het weigeringsbericht dat door het model is gegenereerd.	Ja
role	enum	De rol van de auteur van dit bericht. Mogelijke waarden: `assistant`	Ja
tool_calls	ChatCompletionMessageToolCallsItem	De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen.	No

AzureChatCompletionStreamResponseDelta

Het uitgebreide antwoordmodel voor een streaming-chatantwoordbericht op de Azure OpenAI-service. Dit model voegt ondersteuning toe voor chatberichtcontext, die wordt gebruikt door de functie On Your Data voor intentie, bronvermeldingen en andere informatie met betrekking tot het ophalen van uitgebreide generatie.

Naam	Type	Description	Required
audio	Object		No
└* gegevens	tekenreeks		No
└─ vervalt_op	integer		No
└* id	tekenreeks		No
└* transcriptie	tekenreeks		No
inhoud	tekenreeks	De inhoud van het segmentbericht.	No
context	Object	Een extra eigenschap die is toegevoegd aan antwoordberichten over chatvoltooiing, geproduceerd door de Azure OpenAI-service bij gebruik van extensiegedrag. Dit omvat intentie- en bronvermeldingsgegevens uit de functie On Your Data.	No
└all_retrieved_documents	Object	Samenvattingsinformatie over documenten die zijn opgehaald door de bewerking voor het ophalen van gegevens.	No
└chunk_id	tekenreeks	De segment-id voor de bronvermelding.	No
└* inhoud	tekenreeks	De inhoud van de bronvermelding.	No
└gegevensbron_index	integer	De index van de gegevensbron die wordt gebruikt voor het ophalen.	No
└─ bestandspad	tekenreeks	Het bestandspad voor de bronvermelding.	No
└ filter_reason	enum	Indien van toepassing, geeft u aan waarom het document is gefilterd. Mogelijke waarden: `score`, `rerank`	No
└originele_zoekscore	number	De oorspronkelijke zoekscore voor het ophalen.	No
└ rerank_score	number	De rerankscore voor het ophalen.	No
└─ zoekopdrachten	gegevensreeks	De zoekquery's die worden uitgevoerd om documenten op te halen.	No
└─ Titel	tekenreeks	De titel voor de bronvermelding.	No
URL └*	tekenreeks	De URL van de bronvermelding.	No
└* bronvermeldingen	gegevensreeks	De bronvermeldingen die worden geproduceerd door het ophalen van gegevens.	No
└intentie.	tekenreeks	De gedetecteerde intentie uit de chatgeschiedenis, die wordt gebruikt om de gesprekscontext tussen interacties te dragen	No
function_call	Object	Afgeschaft en vervangen door `tool_calls`. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.	No
└; argumenten	tekenreeks		No
└─naam	tekenreeks		No
reasoning_content	tekenreeks	Een Azure-specifieke extensieeigenschap met gegenereerde redeneringsinhoud van ondersteunde modellen.	No
weigering	tekenreeks	Het weigeringsbericht dat door het model is gegenereerd.	No
role	Object	De rol van de auteur van een bericht	No
tool_calls	gegevensreeks		No

AzureChatDataSource

Een weergave van configuratiegegevens voor één Azure OpenAI-chatgegevensbron. Dit wordt gebruikt door een aanvraag voor het voltooien van chats die Azure OpenAI-chatextensies moeten gebruiken om het antwoordgedrag te verbeteren. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.

Onderscheid maken voor AzureChatDataSource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`azure_search`	AzureSearchChatDataSource
`azure_cosmos_db`	AzureCosmosDBChatDataSource
`elasticsearch`	ElasticsearchChatDataSource
`pinecone`	PineconeChatDataSource
`mongo_db`	MongoDBChatDataSource

Naam	Type	Description	Required	Default
type	Object		Ja

AzureChatDataSourceAccessTokenAuthenticationOptions

Naam	Type	Description	Required	Default
access_token	tekenreeks		Ja
type	enum	Mogelijke waarden: `access_token`	Ja

AzureChatDataSourceApiKeyAuthenticationOptions

Naam	Type	Description	Required	Default
sleutel	tekenreeks		Ja
type	enum	Mogelijke waarden: `api_key`	Ja

AzureChatDataSourceAuthenticationOptions

Discriminator voor AzureChatDataSourceAuthenticationOptions

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`system_assigned_managed_identity`	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
`access_token`	AzureChatDataSourceAccessTokenAuthenticationOptions
`connection_string`	AzureChatDataSourceConnectionStringAuthenticationOptions
`key_and_key_id`	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
`username_and_password`	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Naam	Type	Description	Required	Default
type	AzureChatDataSourceAuthenticationOptionsType		Ja

AzureChatDataSourceAuthenticationOptionsType

Property	Value
Typ	tekenreeks
waarden	`api_key` `username_and_password` `connection_string` `key_and_key_id` `encoded_api_key` `access_token` `system_assigned_managed_identity` `user_assigned_managed_identity`

AzureChatDataSourceConnectionStringAuthenticationOptions

Naam	Type	Description	Required	Default
connection_string	tekenreeks		Ja
type	enum	Mogelijke waarden: `connection_string`	Ja

AzureChatDataSourceDeploymentNameVectorizationSource

Vertegenwoordigt een vectorisatiebron die interne serviceaanroepen uitvoert op basis van een Azure OpenAI-implementatie van het insluitmodel. In tegenstelling tot de vectorisatiebron op basis van eindpunten, moet een vectorisatiebron op basis van een implementatienaam deel uitmaken van dezelfde Azure OpenAI-resource, maar kan zelfs in particuliere netwerken worden gebruikt.

Naam	Type	Description	Required
implementatienaam	tekenreeks	De insluitmodelimplementatie die moet worden gebruikt voor vectorisatie. Deze implementatie moet zich in dezelfde Azure OpenAI-resource bevinden als de modelimplementatie die wordt gebruikt voor het voltooien van chats.	Ja
dimensions	integer	Het aantal dimensies dat moet worden aangevraagd voor insluitingen. Alleen ondersteund in 'text-embedding-3' en latere modellen.	No
type	enum	De type-id, altijd 'deployment_name' voor dit vectorisatiebrontype. Mogelijke waarden: `deployment_name`	Ja

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Naam	Type	Description	Required	Default
encoded_api_key	tekenreeks		Ja
type	enum	Mogelijke waarden: `encoded_api_key`	Ja

AzureChatDataSourceEndpointVectorizationSource

Vertegenwoordigt een vectorisatiebron die openbare serviceaanroepen uitvoert op basis van een Azure OpenAI-implementatie van het insluitmodel.

Naam	Type	Description	Required
authentication	Object		Ja
└ access_token	tekenreeks		No
└─ sleutel	tekenreeks		No
└type.	enum	Mogelijke waarden: `access_token`	No
dimensions	integer	Het aantal dimensies dat moet worden aangevraagd voor insluitingen. Alleen ondersteund in 'text-embedding-3' en latere modellen.	No
endpoint	tekenreeks	Hiermee geeft u de URL van het broneindpunt op waaruit insluitingen moeten worden opgehaald. Deze moet de volgende indeling hebben: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. De queryparameter api-versie is niet toegestaan.	Ja
type	enum	De type-id, altijd 'eindpunt' voor dit vectorisatiebrontype. Mogelijke waarden: `endpoint`	Ja

AzureChatDataSourceIntegratedVectorizationSource

Vertegenwoordigt een geïntegreerde vectorisatiebron zoals gedefinieerd in de ondersteunende zoekresource.

Naam	Type	Description	Required	Default
type	enum	De type-id, altijd 'geïntegreerd' voor dit vectorisatiebrontype. Mogelijke waarden: `integrated`	Ja

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Naam	Type	Description	Required
sleutel	tekenreeks		Ja
key_id	tekenreeks		Ja
type	enum	Mogelijke waarden: `key_and_key_id`	Ja

AzureChatDataSourceModelIdVectorizationSource

Vertegenwoordigt een vectorisatiebron die service-aanroepen uitvoert op basis van een id van het zoekservicemodel. Dit brontype wordt momenteel alleen ondersteund door Elasticsearch.

Naam	Type	Description	Required	Default
model_id	tekenreeks	De build-id van het insluitmodel dat moet worden gebruikt voor vectorisatie.	Ja
type	enum	De type-id, altijd 'model_id' voor dit vectorisatiebrontype. Mogelijke waarden: `model_id`	Ja

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `system_assigned_managed_identity`	Ja

AzureChatDataSourceType

Property	Value
Typ	tekenreeks
waarden	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Naam	Type	Description	Required	Default
managed_identity_resource_id	tekenreeks		Ja
type	enum	Mogelijke waarden: `user_assigned_managed_identity`	Ja

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Naam	Type	Description	Required
password	tekenreeks		Ja
type	enum	Mogelijke waarden: `username_and_password`	Ja
username	tekenreeks		Ja

AzureChatDataSourceVectorizationSource

Een weergave van een gegevensvectorisatiebron die kan worden gebruikt als een insluitresource met een gegevensbron.

Discriminator voor AzureChatDataSourceVectorizationSource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChatDataSourceModelIdVectorizationSource

Naam	Type	Description	Required	Default
type	Object		Ja

AzureChatDataSourceVectorizationSourceType

Property	Value
Typ	tekenreeks
waarden	`endpoint` `deployment_name` `model_id` `integrated`

AzureChatMessageContext

Een extra eigenschap die is toegevoegd aan antwoordberichten over chatvoltooiing, geproduceerd door de Azure OpenAI-service bij gebruik van extensiegedrag. Dit omvat intentie- en bronvermeldingsgegevens uit de functie On Your Data.

Naam	Type	Description	Required
all_retrieved_documents	Object	Samenvattingsinformatie over documenten die zijn opgehaald door de bewerking voor het ophalen van gegevens.	No
└chunk_id	tekenreeks	De segment-id voor de bronvermelding.	No
└* inhoud	tekenreeks	De inhoud van de bronvermelding.	No
└gegevensbron_index	integer	De index van de gegevensbron die wordt gebruikt voor het ophalen.	No
└─ bestandspad	tekenreeks	Het bestandspad voor de bronvermelding.	No
└ filter_reason	enum	Indien van toepassing, geeft u aan waarom het document is gefilterd. Mogelijke waarden: `score`, `rerank`	No
└originele_zoekscore	number	De oorspronkelijke zoekscore voor het ophalen.	No
└ rerank_score	number	De rerankscore voor het ophalen.	No
└─ zoekopdrachten	gegevensreeks	De zoekquery's die worden uitgevoerd om documenten op te halen.	No
└─ Titel	tekenreeks	De titel voor de bronvermelding.	No
URL └*	tekenreeks	De URL van de bronvermelding.	No
Citaten	gegevensreeks	De bronvermeldingen die worden geproduceerd door het ophalen van gegevens.	No
bedoeling	tekenreeks	De gedetecteerde intentie uit de chatgeschiedenis, die wordt gebruikt om de gesprekscontext tussen interacties te dragen	No

AzureContentFilterBlocklistResult

Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.

Naam	Type	Description	Required	Default
details	gegevensreeks	De paren van afzonderlijke bloklijst-id's en of ze hebben geresulteerd in een filteractie.	No
filtered	boolean	Een waarde die aangeeft of een van de gedetailleerde bloklijsten heeft geresulteerd in een filteractie.	Ja

AzureContentFilterCompletionTextSpan

Een weergave van een reeks voltooiingsteksten die worden gebruikt door Azure Resultaten van openAI-inhoudsfilters.

Naam	Type	Description	Required	Default
completion_end_offset	integer	Verschuiving van het eerste UTF32-codepunt dat wordt uitgesloten van het bereik. Dit veld is altijd gelijk aan completion_start_offset voor lege spanten. Dit veld is altijd groter dan completion_start_offset voor niet-lege spanten.	Ja
completion_start_offset	integer	Verschuiving van het UTF32-codepunt dat begint met het bereik.	Ja

AzureContentFilterCompletionTextSpanDetectionResult

Naam	Type	Description	Required
details	gegevensreeks	Gedetailleerde informatie over de gedetecteerde voltooiingstekst omvat.	Ja
detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Ja
filtered	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Ja

AzureContentFilterCustomTopicResult

Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.

Naam	Type	Description	Required	Default
details	gegevensreeks	De paren van afzonderlijke onderwerp-id's en of ze worden gedetecteerd.	No
filtered	boolean	Een waarde die aangeeft of een van de gedetailleerde onderwerpen heeft geresulteerd in een filteractie.	Ja

AzureContentFilterDetectionResult

Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.

Naam	Type	Description	Required	Default
detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Ja
filtered	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Ja

AzureContentFilterImagePromptResults

Een inhoudsfilterresultaat voor de invoeraanvraaginhoud van een afbeeldingsgeneratiebewerking.

Naam	Type	Description	Required
custom_blocklists	Object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└─ details weergeven	gegevensreeks	De paren van afzonderlijke bloklijst-id's en of ze hebben geresulteerd in een filteractie.	No
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde bloklijsten heeft geresulteerd in een filteractie.	No
aangepaste_onderwerpen	Object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details weergeven	gegevensreeks	De paren van afzonderlijke onderwerp-id's en of ze worden gedetecteerd.	No
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde onderwerpen heeft geresulteerd in een filteractie.	No
jailbreak	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	Ja
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
profanity	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No

AzureContentFilterImageResponseResults

Een inhoudsfilterresultaat voor de uitvoerantwoordinhoud van een afbeeldingsgeneratiebewerking.

Naam	Type	Description	Required
hate	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
self_harm	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
sexual	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
violence	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No

AzureContentFilterResultForChoice

Een inhoudsfilterresultaat voor één antwoorditem dat wordt geproduceerd door een generatief AI-systeem.

Naam	Type	Description	Required
custom_blocklists	Object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└─ details weergeven	gegevensreeks	De paren van afzonderlijke bloklijst-id's en of ze hebben geresulteerd in een filteractie.	No
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde bloklijsten heeft geresulteerd in een filteractie.	No
aangepaste_onderwerpen	Object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details weergeven	gegevensreeks	De paren van afzonderlijke onderwerp-id's en of ze worden gedetecteerd.	No
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde onderwerpen heeft geresulteerd in een filteractie.	No
error	Object	Indien aanwezig, details over een fout waardoor het filteren van inhoud niet kan worden voltooid.	No
└* code	integer	Een afzonderlijke, machineleesbare code die aan de fout is gekoppeld.	No
└• bericht	tekenreeks	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	No
hate	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
profanity	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
protected_material_code	Object	Een detectieresultaat waarmee een overeenkomst wordt beschreven op basis van gelicentieerde code of ander beveiligd bronmateriaal.	No
└─ bronvermelding	Object	Indien beschikbaar, worden de bronvermeldingsgegevens beschreven die de bijbehorende licentie en de locatie ervan beschrijven.	No
└* URL	tekenreeks	De URL die is gekoppeld aan de licentie.	No
└• licentie	tekenreeks	De naam of id van de licentie die is gekoppeld aan de detectie.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
protected_material_text	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
self_harm	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
sexual	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No

AzureContentFilterResultForPrompt

Een inhoudsfilterresultaat dat is gekoppeld aan één invoerpromptitem in een generatief AI-systeem.

Naam	Type	Description	Required
content_filter_results	Object	De details van de inhoudsfiltercategorie voor het resultaat.	No
└custom_blocklists	Object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└─ details weergeven	gegevensreeks	De paren van afzonderlijke bloklijst-id's en of ze hebben geresulteerd in een filteractie.	No
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde bloklijsten heeft geresulteerd in een filteractie.	No
└custom_topics	Object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details weergeven	gegevensreeks	De paren van afzonderlijke onderwerp-id's en of ze worden gedetecteerd.	No
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde onderwerpen heeft geresulteerd in een filteractie.	No
└─ fout	Object	Indien aanwezig, details over een fout waardoor het filteren van inhoud niet kan worden voltooid.	No
└* code	integer	Een afzonderlijke, machineleesbare code die aan de fout is gekoppeld.	No
└• bericht	tekenreeks	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	No
└─ haat	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
└indirecte_aanval	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
└* jailbreak	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
└* grof taalgebruik	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No
└zelfbeschadiging	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
└* seksueel	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
└* geweld	Object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
prompt_index	integer	De index van de invoerprompt die is gekoppeld aan de bijbehorende resultaatcategorieën voor inhoudsfilters.	No

AzureContentFilterSeverityResult

Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gefilterd en wat het kwalitatieve ernstniveau van de inhoud was, zoals geëvalueerd op basis van de inhoudsfilterconfiguratie voor de categorie.

Naam	Type	Description	Required	Default
filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	Ja
severity	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	Ja

AzureCosmosDBChatDataSource

Vertegenwoordigt een gegevensbronconfiguratie die gebruikmaakt van een Azure CosmosDB-resource.

Naam	Type	Description	Required	Default
parameters	Object	De parameterinformatie voor het beheren van het gebruik van de Azure CosmosDB-gegevensbron.	Ja
└allow_partial_result	boolean	Als deze optie is ingesteld op true, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle gedeeltelijke query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt.	No	Onwaar
└* verificatie	AzureChatDataSourceConnectionStringAuthenticationOptions		No
└─container_name	tekenreeks		No
└database_name	tekenreeks		No
└embedding_dependency	AzureChatDataSourceVectorizationSource	Een weergave van een gegevensvectorisatiebron die kan worden gebruikt als een insluitresource met een gegevensbron.	No
└fields_mapping	Object		No
└content_fields	gegevensreeks		No
└─content_fields_separator	tekenreeks		No
└filepath_field	tekenreeks		No
└title_field	tekenreeks		No
└url_field	tekenreeks		No
└vector_fields	gegevensreeks		No
└─ binnen_het_bereik	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└include_contexts	gegevensreeks	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['bronvermeldingen', 'intentie']
└index_name	tekenreeks		No
└max_search_queries	integer	Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Het systeem zal standaard een automatische beslissing nemen.	No
└* striktheid	integer	De geconfigureerde striktheid van het filteren op zoekrelevantie. Hogere strengheid zal de precisie verhogen, maar een lagere terugroeping van het antwoord.	No
└top_n_documents	integer	Het geconfigureerde aantal documenten dat moet worden weergegeven in de query.	No
type	enum	De gediscrimineerde type-id, die altijd 'azure_cosmos_db' is. Mogelijke waarden: `azure_cosmos_db`	Ja

AzureCreateChatCompletionRequest

Het uitgebreide aanvraagmodel voor chatvoltooiingen voor de Azure OpenAI-service. Hiermee wordt de mogelijkheid toegevoegd om gegevensbronnen te bieden voor de functie On Your Data.

Naam	Type	Description	Required	Default
audio	Object	Parameters voor audio-uitvoer. Vereist wanneer audio-uitvoer wordt aangevraagd met `modalities: ["audio"]`.	No
└─ formaat	enum	Hiermee geeft u de audio-indeling van de uitvoer. Moet een van`wav`, `mp3`, `flac`, of `opus`.`pcm16` Mogelijke waarden: `wav`, `aac`, `mp3`, `flac`, , `opuspcm16`	No
└─ stem	Object		No
data_sources	gegevensreeks	De gegevensbronnen die moeten worden gebruikt voor de functie On Your Data, exclusief voor Azure OpenAI.	No
frequency_penalty (frequentiebestraffing)	number	Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van hun bestaande frequentie in de tekst, waardoor de kans dat het model dezelfde regelzin herhaalt, afneemt.	No	0
function_call	enum	Als u een bepaalde functie opgeeft via dwingt `{"name": "my_function"}` u het model om die functie aan te roepen. Mogelijke waarden: `none`, `auto`	No
functions	gegevensreeks	Afgeschaft ten gunste van `tools`. Een lijst met functies waarvoor het model JSON-invoer kan genereren.	No
logitsvertekening	Object	Wijzig de kans dat opgegeven tokens worden weergegeven in de voltooiing. Accepteert een JSON-object waarmee tokens (opgegeven door de token-id in de tokenizer) worden toegewezen aan een gekoppelde bias-waarde van -100 tot 100. Wiskundig wordt de vooroordelen toegevoegd aan de logboeken die door het model worden gegenereerd voordat ze worden genomen. Het exacte effect verschilt per model, maar waarden tussen -1 en 1 moeten de kans op selectie verkleinen of vergroten; waarden zoals -100 of 100 moeten resulteren in een verbod of exclusieve selectie van het relevante token.	No	Geen
logprobs	boolean	Of u nu logboekkansen van de uitvoertokens wilt retourneren of niet. Indien waar, retourneert u de logboekkans van elk uitvoertoken dat wordt geretourneerd in de van `contentmessage`.	No	Onwaar
max_completion_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens.	No
maximaal_aantal_tokens	integer	Het maximum aantal tokens dat kan worden gegenereerd in de voltooiing van de chat. Deze waarde kan worden gebruikt om de kosten voor tekst te beheren die via DE API wordt gegenereerd. Deze waarde is nu afgeschaft ten gunste van `max_completion_tokens`en is niet compatibel met o1-seriemodellen.	No
Berichten	gegevensreeks	Een lijst met berichten die tot nu toe bestaan uit het gesprek. Afhankelijk van het model dat u gebruikt, worden verschillende berichttypen (modaliteiten) ondersteund, zoals tekst, afbeeldingen en audio.	Ja
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
Modaliteiten	Object	Uitvoertypen die u door het model wilt genereren. De meeste modellen kunnen tekst genereren. Dit is de standaardinstelling: `["text"]` Het `gpt-4o-audio-preview` model kan ook worden gebruikt om audio te genereren. Als u wilt aanvragen dat dit model zowel tekst- als audioantwoorden genereert, kunt u het volgende gebruiken: `["text", "audio"]`	No
model	tekenreeks	De modelimplementatie-id die moet worden gebruikt voor de voltooiingsaanvraag voor chats.	Ja
n	integer	Hoeveel opties voor het voltooien van chats voor elk invoerbericht moeten worden gegenereerd. Houd er rekening mee dat er kosten in rekening worden gebracht op basis van het aantal gegenereerde tokens voor alle opties. `n` Houd `1` rekening met het minimaliseren van de kosten.	No	1
parallel_gereedschapsoproepen	Object	Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma.	No
prediction	Object	Basisweergave van voorspelde uitvoer van een model.	No
└type.	OpenAI.ChatOutputPredictionType		No
aanwezigheid_boete	number	Getal tussen -2.0 en 2.0. Positieve waarden bestraffen nieuwe tokens op basis van of ze tot nu toe worden weergegeven in de tekst, waardoor de kans op het model groter wordt om over nieuwe onderwerpen te praten.	No	0
inspanning bij redeneren	Object	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
responsformaat	Object		No
└type.	enum	Mogelijke waarden: `text`, `json_objectjson_schema`	No
seed	integer	Deze functie bevindt zich in de bètaversie. Indien opgegeven, zal ons systeem een best inspanning leveren om de steekproef deterministisch uit te voeren, zodat herhaalde aanvragen met hetzelfde `seed` en parameters hetzelfde resultaat moeten retourneren. Determinisme is niet gegarandeerd en u moet verwijzen naar de `system_fingerprint` antwoordparameter om wijzigingen in de back-end te controleren.	No
stop	Object	Niet ondersteund met de nieuwste redeneringsmodellen `o3` en `o4-mini`. Maximaal vier reeksen waarbij de API stopt met het genereren van verdere tokens. De geretourneerde tekst bevat niet de stopvolgorde.	No
store	boolean	Of de uitvoer van deze chatvoltooiingsaanvraag al dan niet moet worden opgeslagen voor gebruik in modeldestillatie of evals producten.	No	Onwaar
stream	boolean	Als deze optie is ingesteld op true, worden de antwoordgegevens van het model naar de client gestreamd terwijl deze worden gegenereerd met behulp van door de server verzonden gebeurtenissen.	No	Onwaar
stream_options	Object	Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt `stream: true`.	No
└include_usage	boolean	Als dit is ingesteld, wordt er vóór het `data: [DONE]` bericht een extra segment gestreamd. Het `usage` veld in dit segment toont de gebruiksstatistieken van tokens voor de hele aanvraag en het `choices` veld is altijd een lege matrix. Alle andere segmenten bevatten ook een `usage` veld, maar met een null-waarde. OPMERKING: Als de stream wordt onderbroken, ontvangt u mogelijk niet het uiteindelijke gebruikssegment dat het totale tokengebruik voor de aanvraag bevat.	No
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen. Het opgeven van een bepaald hulpprogramma via `{"type": "function", "function": {"name": "my_function"}}` dwingt het model om dat hulpprogramma aan te roepen. `none` is de standaardinstelling wanneer er geen hulpprogramma's aanwezig zijn. `auto` is de standaardinstelling als er hulpprogramma's aanwezig zijn.	No
tools	gegevensreeks	Een lijst met hulpprogramma's die het model kan aanroepen. Op dit moment worden alleen functies ondersteund als hulpprogramma. Gebruik dit om een lijst met functies op te geven waarvoor het model JSON-invoer kan genereren. Maximaal 128 functies worden ondersteund.	No
top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No	1
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, die kan helpen bij het bewaken en detecteren van misbruik.	No
user_security_context	AzureUserSecurityContext	De beveiligingscontext van de gebruiker bevat verschillende parameters die de toepassing zelf beschrijven en de eindgebruiker die met de toepassing communiceert. Deze velden helpen uw beveiligingsteams om beveiligingsincidenten te onderzoeken en te beperken door een uitgebreide benadering te bieden voor het beveiligen van uw AI-toepassingen. Meer informatie over het beveiligen van AI-toepassingen met behulp van Microsoft Defender voor Cloud.	No

AzureCreateChatCompletionResponse

Het uitgebreide antwoordmodel voor chatvoltooiing op het hoogste niveau voor de Azure OpenAI-service. Met dit model worden verantwoordelijke AI-inhoudsfilteraantekeningen toegevoegd voor promptinvoer.

Naam	Type	Description	Required
Keuzes	gegevensreeks		Ja
created	integer	De Unix-tijdstempel (in seconden) van het moment waarop de chat is voltooid.	Ja
identiteitskaart	tekenreeks	Een unieke id voor het voltooien van de chat.	Ja
model	tekenreeks	Het model dat wordt gebruikt voor het voltooien van de chat.	Ja
Object	enum	Het objecttype, dat altijd `chat.completion`is. Mogelijke waarden: `chat.completion`	Ja
prompt_filter_results	gegevensreeks	De verantwoordelijke AI-inhoudsfilteraantekeningen die zijn gekoppeld aan promptinvoer in voltooiingen van chats.	No
system_fingerprint	tekenreeks	Deze vingerafdruk vertegenwoordigt de back-endconfiguratie waarmee het model wordt uitgevoerd. Kan worden gebruikt in combinatie met de `seed` aanvraagparameter om te begrijpen wanneer er back-endwijzigingen zijn aangebracht die van invloed kunnen zijn op determinisme.	No
gebruik	OpenAI.CompletionUsage	Gebruiksstatistieken voor de voltooiingsaanvraag.	No

AzureCreateChatCompletionStreamResponse

Naam	Type	Description	Required	Default
Keuzes	gegevensreeks	Een lijst met opties voor chatvoltooiing. Kan meer dan één element bevatten als `n` deze groter is dan 1. Kan ook leeg zijn voor het laatste segment als u instelt `stream_options: {"include_usage": true}`.	Ja
content_filter_results	AzureContentFilterResultForChoice	Een inhoudsfilterresultaat voor één antwoorditem dat wordt geproduceerd door een generatief AI-systeem.	No
created	integer	De Unix-tijdstempel (in seconden) van het moment waarop de chat is voltooid. Elk segment heeft dezelfde tijdstempel.	Ja
delta	AzureChatCompletionStreamResponseDelta	Het uitgebreide antwoordmodel voor een streaming-chatantwoordbericht op de Azure OpenAI-service. Dit model voegt ondersteuning toe voor chatberichtcontext, die wordt gebruikt door de functie On Your Data voor intentie, bronvermeldingen en andere informatie met betrekking tot het ophalen van uitgebreide generatie.	No
identiteitskaart	tekenreeks	Een unieke id voor het voltooien van de chat. Elk segment heeft dezelfde id.	Ja
model	tekenreeks	Het model om de voltooiing te genereren.	Ja
Object	enum	Het objecttype, dat altijd `chat.completion.chunk`is. Mogelijke waarden: `chat.completion.chunk`	Ja
system_fingerprint	tekenreeks	Deze vingerafdruk vertegenwoordigt de back-endconfiguratie waarmee het model wordt uitgevoerd. Kan worden gebruikt in combinatie met de `seed` aanvraagparameter om te begrijpen wanneer er back-endwijzigingen zijn aangebracht die van invloed kunnen zijn op determinisme.	No
gebruik	Object	Gebruiksstatistieken voor de voltooiingsaanvraag.	No
└completion_tokens	integer	Aantal tokens in de gegenereerde voltooiing.	No	0
└─ completion-tokens-details	Object	Uitsplitsing van tokens die worden gebruikt in een voltooiing.	No
└geaccepteerde_voorspellingstokens	integer	Wanneer u voorspelde uitvoer gebruikt, wordt het aantal tokens in de voorspelling weergegeven in de voltooiing.	No	0
└ audio_tokens	integer	Audio-invoertokens die door het model worden gegenereerd.	No	0
└─ redeneertokens	integer	Tokens die door het model worden gegenereerd voor redenering.	No	0
└rejected_prediction_tokens	integer	Wanneer u voorspelde uitvoer gebruikt, wordt het aantal tokens in de voorspelling weergegeven dat niet in de voltooiing is weergegeven. Net als met redeneringstokens worden deze tokens echter nog steeds meegeteld in de totale voltooiingstokens voor facturerings-, uitvoer- en contextvensterlimieten.	No	0
└prompt_tokens	integer	Aantal tokens in de prompt.	No	0
└prompt_tokens_details	Object	Uitsplitsing van tokens die in de prompt worden gebruikt.	No
└ audio_tokens	integer	Audio-invoertokens aanwezig in de prompt.	No	0
└ cached_tokens	integer	Tokens in de cache die aanwezig zijn in de prompt.	No	0
└ totaal tokens	integer	Het totale aantal tokens dat wordt gebruikt in de aanvraag (prompt + voltooiing).	No	0

AzureCreateEmbeddingRequest

Naam	Type	Description	Required
dimensions	integer	Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Alleen ondersteund in `text-embedding-3` en latere modellen.	No
encoding_format	enum	De indeling waarin de insluitingen moeten worden geretourneerd. Kan een van `float` beide zijn of `base64`. Mogelijke waarden: `float`, `base64`	No
Invoer	tekenreeks of matrix		Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de insluitingsaanvraag.	Ja
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateFileRequestMultiPart

Naam	Type	Description	Required
verloopt_na	Object		Ja
└─ Anker	AzureFileExpiryAnchor		No
└─ seconden	integer		No
bestand	tekenreeks		Ja
purpose	enum	Het beoogde doel van het geüploade bestand. Een van: - `assistants`Wordt gebruikt in de Assistent-API - `batch`: gebruikt in de Batch-API - `fine-tune`: Wordt gebruikt voor het afstemmen - `evals`: Wordt gebruikt voor devalgegevenssets. Mogelijke waarden: `assistants`, `batch`, , `fine-tuneevals`	Ja

AzureCreateImageEditRequestMultiPart

Naam	Type	Description	Required	Default
achtergrond	enum	Hiermee kunt u transparantie instellen voor de achtergrond van de gegenereerde installatiekopieën. Deze parameter wordt alleen ondersteund voor `gpt-image-1` modellen. Moet een van `transparent`, `opaque` of `auto` (standaardwaarde) zijn. Wanneer `auto` het model wordt gebruikt, wordt automatisch de beste achtergrond voor de afbeelding bepaald. Als `transparent`de uitvoerindeling transparantie moet ondersteunen, moet deze worden ingesteld op `png` (standaardwaarde) of `webp`. Mogelijke waarden: `transparent`, `opaqueauto`	No
afbeelding	tekenreeks of matrix		Ja
mask	tekenreeks		No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor de bewerking voor het bewerken van afbeeldingen.	Ja
n	integer	Het aantal afbeeldingen dat moet worden gegenereerd. Moet tussen 1 en 10 zijn.	No	1
uitvoercompressie	integer	Het compressieniveau (0-100%) voor de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen met de `webp` of `jpeg` uitvoerindelingen en wordt standaard ingesteld op 100.	No	100
uitvoerformaat	enum	De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen. Moet een van `png`, `jpeg`of `webp`. De standaardwaarde is `png`. Mogelijke waarden: `png`, `jpegwebp`	No
prompt	tekenreeks	Een tekstbeschrijving van de gewenste afbeelding(en). De maximale lengte is 1000 tekens voor `dall-e-2`en 32000 tekens voor `gpt-image-1`-seriemodellen.	Ja
kwaliteit	enum	De kwaliteit van de afbeelding die wordt gegenereerd. `high`en `mediumlow` worden alleen ondersteund voor `gpt-image-1`-series-modellen. `dall-e-2` ondersteunt `standard` alleen kwaliteit. Standaard ingesteld op `auto`. Mogelijke waarden: `standard`, `low`, `medium`, , `highauto`	No
responsformaat	enum	De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Moet een van `url` of `b64_json`. URL's zijn slechts 60 minuten geldig nadat de afbeelding is gegenereerd. Deze parameter wordt alleen ondersteund voor `dall-e-2`, omdat `gpt-image-1`-series-modellen altijd base64-gecodeerde afbeeldingen retourneren. Mogelijke waarden: `url`, `b64_json`	No
size	enum	De grootte van de gegenereerde afbeeldingen. Moet een van `1024x1024`, `1536x1024` (liggend), `1024x1536` (staand) of `auto` (standaardwaarde) zijn voor `gpt-image-1`-seriemodellen, en een van `256x256`, `512x512`of `1024x1024` voor `dall-e-2`. Mogelijke waarden: `256x256`, `512x512`, `1024x1024`, `1536x1024`, , `1024x1536auto`	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateImageRequest

Naam	Type	Description	Required	Default
achtergrond	enum	Hiermee kunt u transparantie instellen voor de achtergrond van de gegenereerde installatiekopieën. Deze parameter wordt alleen ondersteund voor `gpt-image-1` modellen. Moet een van `transparent`, `opaque` of `auto` (standaardwaarde) zijn. Wanneer `auto` het model wordt gebruikt, wordt automatisch de beste achtergrond voor de afbeelding bepaald. Als `transparent`de uitvoerindeling transparantie moet ondersteunen, moet deze worden ingesteld op `png` (standaardwaarde) of `webp`. Mogelijke waarden: `transparent`, `opaqueauto`	No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor het genereren van installatiekopieën.	Ja
moderation	enum	Het inhoudsbeheerniveau beheren voor afbeeldingen die worden gegenereerd door `gpt-image-1`-seriemodellen. Moet voor minder beperkend filteren of `low` (standaardwaarde) zijn`auto`. Mogelijke waarden: `low`, `auto`	No
n	integer	Het aantal afbeeldingen dat moet worden gegenereerd. Moet tussen 1 en 10 zijn. Voor `dall-e-3`, wordt alleen `n=1` ondersteund.	No	1
uitvoercompressie	integer	Het compressieniveau (0-100%) voor de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen met de `webp` of `jpeg` uitvoerindelingen en wordt standaard ingesteld op 100.	No	100
uitvoerformaat	enum	De indeling waarin de gegenereerde afbeeldingen worden geretourneerd. Deze parameter wordt alleen ondersteund voor `gpt-image-1`-series-modellen. Moet een van `png`, `jpeg`of `webp`. Mogelijke waarden: `png`, `jpegwebp`	No
prompt	tekenreeks	Een tekstbeschrijving van de gewenste afbeelding(en).	Ja
kwaliteit	enum	De kwaliteit van de afbeelding die wordt gegenereerd. - `auto` (standaardwaarde) selecteert automatisch de beste kwaliteit voor het opgegeven model. - `high`en `mediumlow` worden ondersteund voor `gpt-image-1`-series-modellen. - `hd` en `standard` worden ondersteund voor `dall-e-3`. - `standard` is de enige optie voor `dall-e-2`. Mogelijke waarden: `standard`, `hd`, `low`, `medium`, , `highauto`	No
responsformaat	enum	De indeling waarin gegenereerde afbeeldingen met `dall-e-2` en `dall-e-3` worden geretourneerd. Moet een van `url` of `b64_json`. URL's zijn slechts 60 minuten geldig nadat de afbeelding is gegenereerd. Deze parameter wordt niet ondersteund voor `gpt-image-1`-seriemodellen die altijd base64-gecodeerde afbeeldingen retourneren. Mogelijke waarden: `url`, `b64_json`	No
size	enum	De grootte van de gegenereerde afbeeldingen. Moet een van `1024x1024`, `1536x1024` (liggend), `1024x1536` (staand) of `auto` (standaardwaarde) zijn voor `gpt-image-1`-seriemodellen, een van `256x256`, `512x512`of voor `1024x1024`, en `dall-e-2` een van `1024x1024`, `1792x1024`of `1024x1792` voor `dall-e-3`. Mogelijke waarden: `auto`, `1024x1024`, `1536x1024`, `1024x1536`, `256x256`, , `512x5121792x10241024x1792`	No
Stijl	enum	De stijl van de gegenereerde afbeeldingen. Deze parameter wordt alleen ondersteund voor `dall-e-3`. Moet een van `vivid` of `natural`. Levendig zorgt ervoor dat het model leunt op het genereren van hyper-echte en dramatische afbeeldingen. Natuurlijk zorgt ervoor dat het model natuurlijkere, minder hyper-echte afbeeldingen produceert. Mogelijke waarden: `vivid`, `natural`	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateResponse

Naam	Type	Description	Required	Default
achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
include	gegevensreeks	Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn: - `code_interpreter_call.outputs`: Bevat de uitvoer van de uitvoering van Python-code in het code-interpreter-hulpprogramma aanroepitems. - `computer_call_output.output.image_url`: Neem afbeeldings-URL's op uit de uitvoer van de computeroproep. - `file_search_call.results`: Neem de zoekresultaten van de aanroep van het zoekprogramma voor bestanden op. - `message.input_image.image_url`: Neem afbeeldings-URL's op uit het invoerbericht. - `message.output_text.logprobs`: Neem logprobs op met assistentberichten. - `reasoning.encrypted_content`: Bevat een versleutelde versie van redeneringstokens in itemuitvoer met redenering. Hierdoor kunnen redeneringsitems worden gebruikt in gesprekken met meerdere paden wanneer de antwoorden-API staatloos wordt gebruikt (zoals wanneer de `store` parameter is ingesteld `false`op, of wanneer een organisatie is ingeschreven in het retentieprogramma voor gegevens nul).	No
Invoer	tekenreeks of matrix		No
aanwijzingen	tekenreeks	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
max_gereedschap_aanroepen	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	Ja
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
previous_response_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
prompt	Object	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* id	tekenreeks	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└* variabelen	OpenAI.ResponsePromptVariables	Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.	No
└─ versie	tekenreeks	Optionele versie van de promptsjabloon.	No
reasoning	Object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
└─generate_summary	enum	Afgeschaft: gebruik `summary` in plaats daarvan. Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
Samenvatting └─	enum	Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
store	boolean	Of het gegenereerde modelantwoord moet worden opgeslagen voor later ophalen via API.	No	True
stream	boolean	Als deze optie is ingesteld op true, worden de antwoordgegevens van het model naar de client gestreamd terwijl deze worden gegenereerd met behulp van door de server verzonden gebeurtenissen.	No	Onwaar
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No	1
tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Object	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen.	No
└type.	OpenAI.ToolChoiceObjectType	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.	No
tools	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI die de mogelijkheden van het model uitbreiden, zoals het zoeken naar bestanden. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u worden gedefinieerd, zodat het model uw eigen code kan aanroepen.	No
top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No	1
truncation	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateSpeechRequestMultiPart

Een weergave van de aanvraagopties waarmee het gedrag van een tekst-naar-spraak-bewerking wordt bepaald.

Naam	Type	Description	Required	Default
Invoer	tekenreeks	De tekst voor het genereren van audio. De maximumlengte is 4096 tekens.	Ja
aanwijzingen	tekenreeks	Beheer de stem van uw gegenereerde audio met aanvullende instructies. Werkt niet met `tts-1` of `tts-1-hd`.	No
model	tekenreeks	Het model dat moet worden gebruikt voor deze tekst-naar-spraak-aanvraag.	Ja
responsformaat	Object	De ondersteunde audio-uitvoerindelingen voor tekst-naar-spraak.	No
speed	number	De snelheid van spraak voor gegenereerde audio. Waarden zijn geldig in het bereik van 0,25 tot 4.0, waarbij 1,0 de standaardwaarden en hogere waarden overeenkomen met snellere spraak.	No	1
stream_format	enum	De indeling waarin de audio moet worden gestreamd. Ondersteunde indelingen zijn `sse` en `audio`. `sse` wordt niet ondersteund voor `tts-1` of `tts-1-hd`. Mogelijke waarden: `sse`, `audio`	No
voice	Object		Ja

AzureCreateTranscriptionRequestMultiPart

De configuratiegegevens voor een aanvraag voor audiotranscriptie.

Naam	Type	Description	Required	Default
chunking_strategy	Object		No
└prefix_padding_ms	integer	De hoeveelheid audio die moet worden opgenomen vóór de gedetecteerde VAD-spraak (in milliseconden).	No	300
└silence_duration_ms	integer	Duur van stilte om spraakstop te detecteren (in milliseconden). Met kortere waarden reageert het model sneller, maar kan het inspringen op korte pauzes van de gebruiker.	No	200
└─ drempelwaarde	number	Gevoeligheidsdrempel (0,0 tot 1.0) voor spraakactiviteitsdetectie. Voor een hogere drempelwaarde is luider geluid nodig om het model te activeren en kan het dus beter presteren in luidruchtige omgevingen.	No	0,5
└type.	enum	Moet zijn ingesteld om handmatig segmenteren in te `server_vad` schakelen met behulp van VAD aan de serverzijde. Mogelijke waarden: `server_vad`	No
bestand	tekenreeks		Ja
filename	tekenreeks	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens.	No
include[]	gegevensreeks	Aanvullende informatie die moet worden opgenomen in het transcriptieantwoord. `logprobs` retourneert de logboekkans van de tokens in het antwoord om inzicht te krijgen in het vertrouwen van het model in de transcriptie. `logprobs`werkt alleen met response_format ingesteld op `json` en alleen met de modellen `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`en `gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15`.	No
language	tekenreeks	De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1 -indeling (bijvoorbeeld `en`) verbetert de nauwkeurigheid en latentie.	No
model	tekenreeks	Het model dat moet worden gebruikt voor deze transcriptieaanvraag.	No
prompt	tekenreeks	Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet overeenkomen met de audiotaal.	No
responsformaat	Object		No
stream	boolean	Als deze optie is ingesteld op true, worden de antwoordgegevens van het model naar de client gestreamd terwijl deze worden gegenereerd met behulp van door de server verzonden gebeurtenissen. Opmerking: Streaming wordt niet ondersteund voor het `whisper-1` model en wordt genegeerd.	No	Onwaar
Temperatuur	number	De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt.	No	0
timestamp_granularities[]	gegevensreeks	De tijdstempelgranulariteiten die moeten worden ingevuld voor deze transcriptie. `response_format` moet worden ingesteld `verbose_json` op het gebruik van tijdstempelgranulariteiten. Of beide van deze opties worden ondersteund: `word`, of `segment`. Opmerking: er is geen extra latentie voor segmenttijdstempels, maar het genereren van woordtijdstempels zorgt voor extra latentie.	No	['segment']

AzureCreateTranslationRequestMultiPart

De configuratiegegevens voor een aanvraag voor audiotranscriptie.

Naam	Type	Description	Required	Default
bestand	tekenreeks		Ja
filename	tekenreeks	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens	No
model	tekenreeks	Het model dat moet worden gebruikt voor deze vertaalaanvraag.	No
prompt	tekenreeks	Een optionele tekst om de stijl van het model te begeleiden of door te gaan met een vorig audiosegment. De prompt moet in het Engels zijn.	No
responsformaat	Object		No
Temperatuur	number	De steekproeftemperatuur, tussen 0 en 1. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Als dit is ingesteld op 0, gebruikt het model logboekkans om de temperatuur automatisch te verhogen totdat bepaalde drempelwaarden worden bereikt.	No	0

AzureErrorResponse

Naam	Type	Description	Required
error	Object	De foutdetails.	No
└* code	tekenreeks	De unieke, door de machine gegenereerde id voor de fout.	No
└─inner_error			No
└• bericht	tekenreeks	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	No
└* param	tekenreeks	Indien van toepassing, de aanvraaginvoerparameter die is gekoppeld aan de fout	No
└type.	enum	Het objecttype, altijd 'error'. Mogelijke waarden: `error`	No

AzureEvalAPICompletionsSamplingParams

Naam	Type	Required
parallel_gereedschapsoproepen	boolean	No
responsformaat	OpenAI.ResponseTextFormatConfiguration	No
tools	gegevensreeks	No

AzureEvalAPIModelSamplingParams

Naam	Type	Description	Required
maximaal_aantal_tokens	integer	Het maximum aantal tokens in de gegenereerde uitvoer.	No
inspanning bij redeneren	enum	Hiermee bepaalt u het niveau van de redenering die tijdens het genereren wordt toegepast. Mogelijke waarden: `low`, `mediumhigh`	No
seed	integer	Een seed-waarde om de willekeurigheid tijdens steekproeven te initialiseren.	No
Temperatuur	number	Een hogere temperatuur verhoogt de willekeurigheid in de uitvoer.	No
top_p	number	Een alternatief voor temperatuur voor kernmonsters; 1.0 bevat alle tokens.	No

AzureEvalAPIResponseSamplingParams

Naam	Type	Required
parallel_gereedschapsoproepen	boolean	No
responsformaat	OpenAI.ResponseTextFormatConfiguration	No
tools	gegevensreeks	No

AzureFileExpiryAnchor

Property	Value
Typ	tekenreeks
waarden	`created_at`

AzureFineTuneReinforcementMethod

Naam	Type	Description	Required
Grader	Object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Ja
└calculate_output	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	No
└evaluation_metric	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	No
└* graders	Object		No
└input.	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└model.	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	No
└─naam	tekenreeks	De naam van de cijferaar.	No
└─ bewerking	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ bereik	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ Referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	No
└─sampling_params		De steekproefparameters voor het model.	No
└type.	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuneReinforcementHyperparameters	De hyperparameters die worden gebruikt voor de versterkingsafstemmingstaak.	No
responsformaat	Object		No
└json_schema	Object	JSON-schema voor de antwoordindeling	No
└type.	enum	Type antwoordindeling. Mogelijke waarden: `json_schema`	No

AzureImage

Naam	Type	Description	Required
b64_json	tekenreeks	De met base64 gecodeerde JSON van de gegenereerde installatiekopieën. Standaardwaarde voor `gpt-image-1`-seriemodellen en alleen aanwezig als `response_format` deze is ingesteld `b64_json` op en `dall-e-2dall-e-3`.	No
content_filter_results	AzureContentFilterImageResponseResults	Een inhoudsfilterresultaat voor de uitvoerantwoordinhoud van een afbeeldingsgeneratiebewerking.	Ja
prompt_filter_results	AzureContentFilterImagePromptResults	Een inhoudsfilterresultaat voor de invoeraanvraaginhoud van een afbeeldingsgeneratiebewerking.	Ja
gewijzigde_opdracht	tekenreeks	Alleen `dall-e-3` de herziene prompt die is gebruikt om de afbeelding te genereren.	No
URL	tekenreeks	Wanneer u `dall-e-2` deze gebruikt of `dall-e-3`, wordt de URL van de gegenereerde installatiekopieën `response_format` ingesteld `url` op (standaardwaarde). Niet ondersteund voor `gpt-image-1`-seriemodellen.	No

AzureImagesResponse

Naam	Type	Description	Required
achtergrond	enum	ALLEEN GPT-image-1: de achtergrondparameter die wordt gebruikt voor het genereren van de installatiekopieën. `transparent`Of `opaque` . Mogelijke waarden: `transparent`, `opaque`	No
created	integer	De Unix-tijdstempel (in seconden) van het moment waarop de installatiekopieën zijn gemaakt.	Ja
Gegevens	gegevensreeks		No
uitvoerformaat	enum	De uitvoerindeling van de generatie van de installatiekopieën. Ofwel `png`, `webp`of `jpeg`. Mogelijke waarden: `png`, `webpjpeg`	No
kwaliteit	enum	De kwaliteit van de gegenereerde afbeelding. Ofwel `low`, `medium`of `high`. Mogelijke waarden: `low`, `mediumhigh`	No
size	enum	De grootte van de gegenereerde installatiekopieën. Ofwel `1024x1024`, `1024x1536`of `1536x1024`. Mogelijke waarden: `1024x1024`, `1024x15361536x1024`	No
gebruik	Object	Alleen voor `gpt-image-1`modellen uit de reeks worden de gebruiksgegevens van het token voor het genereren van de installatiekopieën gebruikt.	No
└input_tokens	integer	Het aantal tokens (afbeeldingen en tekst) in de invoerprompt.	No
└─input_tokens_details	Object	De invoertokens gedetailleerde informatie voor het genereren van afbeeldingen.	No
└image_tokens	integer	Het aantal afbeeldingstokens in de invoerprompt.	No
└text_tokens	integer	Het aantal teksttokens in de invoerprompt.	No
└output_tokens	integer	Het aantal installatiekopieën in de uitvoerafbeelding.	No
└ totaal tokens	integer	Het totale aantal tokens (afbeeldingen en tekst) dat wordt gebruikt voor het genereren van afbeeldingen.	No

AzureListFilesResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks		Ja
first_id	tekenreeks		Ja
heeft_meer	boolean		Ja
last_id	tekenreeks		Ja
Object	enum	Mogelijke waarden: `list`	Ja

AzureOpenAIFile

Naam	Type	Description	Required
bytes	integer	De grootte van het bestand, in bytes.	Ja
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor het moment waarop het bestand is gemaakt.	Ja
verloopt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer het bestand verloopt.	No
filename	tekenreeks	De naam van het bestand.	Ja
identiteitskaart	tekenreeks	De bestands-id waarnaar kan worden verwezen in de API-eindpunten.	Ja
Object	enum	Het objecttype, dat altijd `file`is. Mogelijke waarden: `file`	Ja
purpose	enum	Het beoogde doel van het bestand. Ondersteunde waarden zijn`assistants`, `assistants_output`, , `batch`en `batch_outputfine-tunefine-tune-results`. Mogelijke waarden: `assistants`, `assistants_output`, `batch`, `batch_output`, , `fine-tunefine-tune-resultsevals`	Ja
status	enum	Mogelijke waarden: `uploaded`, `pending`, `running`, `processed`, , `errordeletingdeleted`	Ja
statusgegevens	tekenreeks	Deprecated. Zie het `error` veld op `fine_tuning.job`voor meer informatie over waarom de validatie van een trainingsbestand is mislukt.	No

AzureOpenAIVideoGenerationErrorResponse

Naam	Type	Description	Required
code	tekenreeks	De unieke, door de machine gegenereerde id voor de fout.	No
inner_error	Object	Indien van toepassing, een upstream-fout die deze fout heeft veroorzaakt.	No
└* code	enum	De code die is gekoppeld aan de interne fout. Mogelijke waarden: `ResponsibleAIPolicyViolation`	No
└error_details		De details van het inhoudsfilterresultaat die zijn gekoppeld aan de interne fout.	No
└revised_prompt	tekenreeks	Indien van toepassing, wordt de wijzigingsprompt gebruikt voor het genereren.	No
message	tekenreeks	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	No
param	tekenreeks	Indien van toepassing, de aanvraaginvoerparameter die is gekoppeld aan de fout	No
type	tekenreeks	Indien van toepassing, is het nummer van de invoerregel gekoppeld aan de fout.	No

AzureResponse

Naam	Type	Description	Required	Default
achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
aangemaakt_op	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Ja
error	Object	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Ja
└* code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	No
└• bericht	tekenreeks	Een door mensen leesbare beschrijving van de fout.	No
identiteitskaart	tekenreeks	Unieke id voor dit antwoord.	Ja
incomplete_details	Object	Details over waarom het antwoord onvolledig is.	Ja
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
aanwijzingen	tekenreeks of matrix		Ja
max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
max_gereedschap_aanroepen	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
model	tekenreeks	Het model dat wordt gebruikt om dit antwoord te genereren.	Ja
Object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Ja
uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	Ja
output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Ja	True
previous_response_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
prompt	Object	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* id	tekenreeks	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└* variabelen	OpenAI.ResponsePromptVariables	Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.	No
└─ versie	tekenreeks	Optionele versie van de promptsjabloon.	No
reasoning	Object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
└─generate_summary	enum	Afgeschaft: gebruik `summary` in plaats daarvan. Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
Samenvatting └─	enum	Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
status	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	Ja
tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Object	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen.	No
└type.	OpenAI.ToolChoiceObjectType	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.	No
tools	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	Ja
truncation	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	Ja

AzureSearchChatDataSource

Vertegenwoordigt een gegevensbronconfiguratie die een Azure zoekresource gebruikt.

Naam	Type	Description	Required	Default
parameters	Object	De parameterinformatie voor het beheren van het gebruik van de Azure Gegevensbron zoeken.	Ja
└allow_partial_result	boolean	Als deze optie is ingesteld op true, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle gedeeltelijke query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt.	No	Onwaar
└* verificatie	Object		No
└ access_token	tekenreeks		No
└─ sleutel	tekenreeks		No
└managed_identity_resource_id	tekenreeks		No
└type.	enum	Mogelijke waarden: `access_token`	No
└embedding_dependency	Object	Vertegenwoordigt een vectorisatiebron die openbare serviceaanroepen uitvoert op basis van een Azure OpenAI-implementatie van het insluitmodel.	No
└* verificatie	AzureChatDataSourceApiKeyAuthenticationOptions of AzureChatDataSourceAccessTokenAuthenticationOptions	Het verificatiemechanisme voor gebruik met de vectorisatiebron op basis van eindpunten. Eindpuntverificatie ondersteunt API-sleutel- en toegangstokenmechanismen.	No
└─deployment_name	tekenreeks	De insluitmodelimplementatie die moet worden gebruikt voor vectorisatie. Deze implementatie moet zich in dezelfde Azure OpenAI-resource bevinden als de modelimplementatie die wordt gebruikt voor het voltooien van chats.	No
Afmetingen	integer	Het aantal dimensies dat moet worden aangevraagd voor insluitingen. Alleen ondersteund in 'text-embedding-3' en latere modellen.	No
└* eindpunt	tekenreeks	Hiermee geeft u de URL van het broneindpunt op waaruit insluitingen moeten worden opgehaald. Deze moet de volgende indeling hebben: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. De queryparameter api-versie is niet toegestaan.	No
└type.	enum	De type-id, altijd 'geïntegreerd' voor dit vectorisatiebrontype. Mogelijke waarden: `integrated`	No
└* eindpunt	tekenreeks	Het absolute eindpuntpad voor de Azure zoekresource die moet worden gebruikt.	No
└fields_mapping	Object	De veldtoewijzingen die moeten worden gebruikt met de Azure zoekresource.	No
└content_fields	gegevensreeks	De namen van indexvelden die als inhoud moeten worden behandeld.	No
└─content_fields_separator	tekenreeks	Het scheidingsteken dat inhoudsvelden moeten gebruiken.	No
└filepath_field	tekenreeks	De naam van het indexveld dat moet worden gebruikt als bestandspad.	No
└ image_vector_fields	gegevensreeks	De namen van velden die afbeeldingsvectorgegevens vertegenwoordigen.	No
└title_field	tekenreeks	De naam van het indexveld dat moet worden gebruikt als titel.	No
└url_field	tekenreeks	De naam van het indexveld dat moet worden gebruikt als URL.	No
└vector_fields	gegevensreeks	De namen van velden die vectorgegevens vertegenwoordigen.	No
└* filter	tekenreeks	Een filter dat moet worden toegepast op de zoekopdracht.	No
└─ binnen_het_bereik	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└include_contexts	gegevensreeks	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['bronvermeldingen', 'intentie']
└index_name	tekenreeks	De naam van de index die moet worden gebruikt, zoals opgegeven in de Azure zoekresource.	No
└max_search_queries	integer	Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Het systeem zal standaard een automatische beslissing nemen.	No
└query_type	enum	Het querytype voor de Azure zoekresource die moet worden gebruikt. Mogelijke waarden: `simple`, `semantic`, `vector`, , `vector_simple_hybridvector_semantic_hybrid`	No
└semantic_configuration	tekenreeks	Aanvullende semantische configuratie voor de query.	No
└* striktheid	integer	De geconfigureerde striktheid van het filteren op zoekrelevantie. Hogere strengheid zal de precisie verhogen, maar een lagere terugroeping van het antwoord.	No
└top_n_documents	integer	Het geconfigureerde aantal documenten dat moet worden weergegeven in de query.	No
type	enum	De gediscrimineerde type-id, die altijd 'azure_search' is. Mogelijke waarden: `azure_search`	Ja

AzureUserSecurityContext

De beveiligingscontext van de gebruiker bevat verschillende parameters die de toepassing zelf beschrijven en de eindgebruiker die met de toepassing communiceert. Deze velden helpen uw beveiligingsteams om beveiligingsincidenten te onderzoeken en te beperken door een uitgebreide benadering te bieden voor het beveiligen van uw AI-toepassingen. Meer informatie over het beveiligen van AI-toepassingen met behulp van Microsoft Defender voor Cloud.

Naam	Type	Description	Required
application_name	tekenreeks	De naam van de toepassing. Gevoelige persoonlijke gegevens mogen niet worden opgenomen in dit veld.	No
end_user_id	tekenreeks	Deze id is de Microsoft Entra ID (voorheen Azure Active Directory) gebruikersobject-id die wordt gebruikt voor het verifiëren van eindgebruikers binnen de generatieve AI-toepassing. Gevoelige persoonlijke gegevens mogen niet worden opgenomen in dit veld.	No
end_user_tenant_id	tekenreeks	De Microsoft 365 tenant-id waartoe de eindgebruiker behoort. Dit is vereist wanneer de generatieve AI-toepassing multitenant is.	No
source_ip	tekenreeks	Legt het IP-adres van de oorspronkelijke client vast.	No

ChatCompletionMessageToolCallsItem

De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen.

Matrix van: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Naam	Type	Description	Required	Default
height	integer	De hoogte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja
model	tekenreeks	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Ja
n_seconds	integer	De duur van de videogeneratietaak. Moet tussen 1 en 20 seconden zijn.	No	5
n_variants	integer	Het aantal video's dat moet worden gemaakt als varianten voor deze taak. Moet tussen 1 en 5 zijn. Kleinere afmetingen maken meer varianten mogelijk.	No	1
prompt	tekenreeks	De prompt voor deze videogeneratietaak.	Ja
width	integer	De breedte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja

CreateVideoGenerationWithMediaRequestMultiPart

De eigenschappen van een aanvraag voor het genereren van videotaken met mediabestanden.

Naam	Type	Description	Required	Default
files	gegevensreeks		Ja
height	integer	De hoogte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja
inpaint_items	gegevensreeks	Optionele inpainting-items voor deze videogeneratietaak.	No
model	tekenreeks	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Ja
n_seconds	integer	De duur van de videogeneratietaak. Moet tussen 1 en 20 seconden zijn.	No	5
n_variants	integer	Het aantal video's dat moet worden gemaakt als varianten voor deze taak. Moet tussen 1 en 5 zijn. Kleinere afmetingen maken meer varianten mogelijk.	No	1
prompt	tekenreeks	De prompt voor deze videogeneratietaak.	Ja
width	integer	De breedte van de video. De volgende afmetingen worden ondersteund: 480x480, 854x480, 720x720, 1280x720, 1080x1080 en 1920x1080 in zowel liggende als staande standen.	Ja

CropBounds

De bijsnijdgrenzen voor een inpainting-item. Hiermee geeft u het gebied op van het media-item dat moet worden gebruikt voor inpainting.

Naam	Type	Description	Required	Default
bottom_fraction	number	De ondergrens van het bijsnijdvak dat is opgegeven als fractie van de hoogte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de hoogte van het oorspronkelijke media-item.	No	1
left_fraction	number	De linkergrens van het bijsnijdvak dat is opgegeven als fractie van de breedte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de breedte van het oorspronkelijke media-item.	No	0
right_fraction	number	De rechtergrens van het bijsnijdvak dat is opgegeven als fractie van de breedte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de breedte van het oorspronkelijke media-item.	No	1
top_fraction	number	De bovengrens van het bijsnijdvak dat is opgegeven als fractie van de hoogte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de hoogte van het oorspronkelijke media-item.	No	0

ElasticsearchChatDataSource

Naam	Type	Description	Required	Default
parameters	Object	De parameterinformatie voor het beheren van het gebruik van de Elasticsearch-gegevensbron.	Ja
└allow_partial_result	boolean	Als deze optie is ingesteld op true, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle gedeeltelijke query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt.	No	Onwaar
└* verificatie	Object		No
└─encoded_api_key	tekenreeks		No
└─ sleutel	tekenreeks		No
└key_id	tekenreeks		No
└type.	enum	Mogelijke waarden: `encoded_api_key`	No
└embedding_dependency	AzureChatDataSourceVectorizationSource	Een weergave van een gegevensvectorisatiebron die kan worden gebruikt als een insluitresource met een gegevensbron.	No
└* eindpunt	tekenreeks		No
└fields_mapping	Object		No
└content_fields	gegevensreeks		No
└─content_fields_separator	tekenreeks		No
└filepath_field	tekenreeks		No
└title_field	tekenreeks		No
└url_field	tekenreeks		No
└vector_fields	gegevensreeks		No
└─ binnen_het_bereik	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└include_contexts	gegevensreeks	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['bronvermeldingen', 'intentie']
└index_name	tekenreeks		No
└max_search_queries	integer	Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Het systeem zal standaard een automatische beslissing nemen.	No
└query_type	enum	Mogelijke waarden: `simple`, `vector`	No
└* striktheid	integer	De geconfigureerde striktheid van het filteren op zoekrelevantie. Hogere strengheid zal de precisie verhogen, maar een lagere terugroeping van het antwoord.	No
└top_n_documents	integer	Het geconfigureerde aantal documenten dat moet worden weergegeven in de query.	No
type	enum	De gediscrimineerde type-id, die altijd 'elasticsearch' is. Mogelijke waarden: `elasticsearch`	Ja

InpaintItem

Een inpainting-item voor een videogeneratietaak. Hiermee geeft u het media-item op dat moet worden gebruikt voor het genereren van video's.

Naam	Type	Description	Required	Default
crop_bounds	Object	De bijsnijdgrenzen voor een inpainting-item. Hiermee geeft u het gebied op van het media-item dat moet worden gebruikt voor inpainting.	No
└bottom_fraction	number	De ondergrens van het bijsnijdvak dat is opgegeven als fractie van de hoogte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de hoogte van het oorspronkelijke media-item.	No	1
└left_fraction	number	De linkergrens van het bijsnijdvak dat is opgegeven als fractie van de breedte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de breedte van het oorspronkelijke media-item.	No	0
└right_fraction	number	De rechtergrens van het bijsnijdvak dat is opgegeven als fractie van de breedte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de breedte van het oorspronkelijke media-item.	No	1
└top_fraction	number	De bovengrens van het bijsnijdvak dat is opgegeven als fractie van de hoogte van het oorspronkelijke media-item. Moet tussen 0,0 en 1,0 zijn. Gebruik bijvoorbeeld 0,5 voor de helft van de hoogte van het oorspronkelijke media-item.	No	0
bestandsnaam	tekenreeks	De bestandsnaam van het media-item. Deze moet overeenkomen met de bestandsnaam van een bestandsbijlage in deze aanvraag.	Ja
frame_index	integer	De frameindex voor dit media-item. Hiermee geeft u het beginframe op in de resulterende gegenereerde video voor dit inpainting-item.	Ja	0
type	Object	Het type van het inpainting-item.	Ja

JobStatus

De status van een videogeneratietaak.

Property	Value
Description	De status van een videogeneratietaak.
Typ	tekenreeks
waarden	`preprocessing` `queued` `running` `processing` `cancelled` `succeeded` `failed`

MediaItemType

Het type van het inpainting-item.

Property	Value
Description	Het type van het inpainting-item.
Typ	tekenreeks
waarden	`image`

MongoDBChatDataSource

Naam	Type	Description	Required	Default
parameters	Object	De parameterinformatie voor het beheren van het gebruik van de MongoDB-gegevensbron.	Ja
└allow_partial_result	boolean	Als deze optie is ingesteld op true, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle gedeeltelijke query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt.	No	Onwaar
└app_name	tekenreeks	De naam van de MongoDB-toepassing.	No
└* verificatie	Object		No
└─ wachtwoord	tekenreeks		No
└type.	enum	Mogelijke waarden: `username_and_password`	No
└gebruikersnaam	tekenreeks		No
└collection_name	tekenreeks	De naam van de MongoDB-verzameling.	No
└database_name	tekenreeks	De naam van de MongoDB-database.	No
└embedding_dependency	Object	Vertegenwoordigt een vectorisatiebron die openbare serviceaanroepen uitvoert op basis van een Azure OpenAI-implementatie van het insluitmodel.	No
└* verificatie	AzureChatDataSourceApiKeyAuthenticationOptions of AzureChatDataSourceAccessTokenAuthenticationOptions	Het verificatiemechanisme voor gebruik met de vectorisatiebron op basis van eindpunten. Eindpuntverificatie ondersteunt API-sleutel- en toegangstokenmechanismen.	No
└─deployment_name	tekenreeks	De insluitmodelimplementatie die moet worden gebruikt voor vectorisatie. Deze implementatie moet zich in dezelfde Azure OpenAI-resource bevinden als de modelimplementatie die wordt gebruikt voor het voltooien van chats.	No
Afmetingen	integer	Het aantal dimensies dat moet worden aangevraagd voor insluitingen. Alleen ondersteund in 'text-embedding-3' en latere modellen.	No
└* eindpunt	tekenreeks	Hiermee geeft u de URL van het broneindpunt op waaruit insluitingen moeten worden opgehaald. Deze moet de volgende indeling hebben: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. De queryparameter api-versie is niet toegestaan.	No
└type.	enum	De type-id, altijd 'deployment_name' voor dit vectorisatiebrontype. Mogelijke waarden: `deployment_name`	No
└* eindpunt	tekenreeks	De naam van het MongoDB-clustereindpunt.	No
└fields_mapping	Object	Veldtoewijzingen die moeten worden toegepast op gegevens die worden gebruikt door de MongoDB-gegevensbron. Houd er rekening mee dat inhouds- en vectorveldtoewijzingen vereist zijn voor MongoDB.	No
└content_fields	gegevensreeks		No
└─content_fields_separator	tekenreeks		No
└filepath_field	tekenreeks		No
└title_field	tekenreeks		No
└url_field	tekenreeks		No
└vector_fields	gegevensreeks		No
└─ binnen_het_bereik	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└include_contexts	gegevensreeks	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['bronvermeldingen', 'intentie']
└index_name	tekenreeks	De naam van de MongoDB-index.	No
└max_search_queries	integer	Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Het systeem zal standaard een automatische beslissing nemen.	No
└* striktheid	integer	De geconfigureerde striktheid van het filteren op zoekrelevantie. Hogere strengheid zal de precisie verhogen, maar een lagere terugroeping van het antwoord.	No
└top_n_documents	integer	Het geconfigureerde aantal documenten dat moet worden weergegeven in de query.	No
type	enum	De gediscrimineerde type-id, die altijd 'mongo_db' is. Mogelijke waarden: `mongo_db`	Ja

OpenAI.Annotation

Discriminator voor OpenAI.Annotatie

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Naam	Type	Description	Required	Default
type	OpenAI.AnnotationType		Ja

OpenAI.AnnotationFileCitation

Een bronvermelding naar een bestand.

Naam	Type	Description	Required
file_id	tekenreeks	De id van het bestand.	Ja
filename	tekenreeks	De bestandsnaam van het geciteerde bestand.	Ja
index	integer	De index van het bestand in de lijst met bestanden.	Ja
type	enum	Het type bronvermelding van het bestand. Altijd `file_citation`. Mogelijke waarden: `file_citation`	Ja

OpenAI.AnnotationFilePath

Een pad naar een bestand.

Naam	Type	Description	Required
file_id	tekenreeks	De id van het bestand.	Ja
index	integer	De index van het bestand in de lijst met bestanden.	Ja
type	enum	Het type van het bestandspad. Altijd `file_path`. Mogelijke waarden: `file_path`	Ja

OpenAI.AnnotationType

Property	Value
Typ	tekenreeks
waarden	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

Een bronvermelding voor een webresource die wordt gebruikt om een modelantwoord te genereren.

Naam	Type	Description	Required
end_index	integer	De index van het laatste teken van de URL-bronvermelding in het bericht.	Ja
start_index	integer	De index van het eerste teken van de URL-bronvermelding in het bericht.	Ja
title	tekenreeks	De titel van de webresource.	Ja
type	enum	Het type URL-bronvermelding. Altijd `url_citation`. Mogelijke waarden: `url_citation`	Ja
URL	tekenreeks	De URL van de webresource.	Ja

OpenAI.ApproximateLocation

Naam	Type	Description	Required
city	tekenreeks		No
country	tekenreeks		No
regio	tekenreeks		No
timezone	tekenreeks		No
type	enum	Mogelijke waarden: `approximate`	Ja

OpenAI.AudioResponseFormat

De indeling van de uitvoer, in een van deze opties: json, text, srt, , verbose_jsonof vtt. Voor gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribeen gpt-4o-mini-transcribe-2025-12-15. De enige ondersteunde indeling is json.

Property	Value
Description	De indeling van de uitvoer, in een van deze opties: `json`, `text`, `srt`, , `verbose_json`of `vtt`. Voor `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, `gpt-4o-mini-transcribe`en `gpt-4o-mini-transcribe-2025-12-15`. De enige ondersteunde indeling is `json`.
Typ	tekenreeks
waarden	`json` `text` `srt` `verbose_json` `vtt`

OpenAI.AutoChunkingStrategyRequestParam

De standaardstrategie. Deze strategie maakt momenteel gebruik van een max_chunk_size_tokens van 800 en chunk_overlap_tokens van 400.

Naam	Type	Description	Required	Default
type	enum	Altijd `auto`. Mogelijke waarden: `auto`	Ja

OpenAI.ChatCompletionFunctionCallOption

Als u een bepaalde functie opgeeft via dwingt {"name": "my_function"} u het model om die functie aan te roepen.

Naam	Type	Description	Required	Default
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Ja

OpenAI.ChatCompletionFunctions

Naam	Type	Description	Required
description	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.	Ja
parameters		De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject. Zie de JSON-schemareferentie voor documentatie over de indeling. Als u `parameters` weglaat, wordt een functie met een lege parameterlijst gedefinieerd.	No

OpenAI.ChatCompletionMessageAudioChunk

Naam	Type	Required
Gegevens	tekenreeks	No
verloopt_op	integer	No
identiteitskaart	tekenreeks	No
transcript	tekenreeks	No

OpenAI.ChatCompletionMessageToolCall

Naam	Type	Description	Required
function	Object	De functie die het model heeft aangeroepen.	Ja
└; argumenten	tekenreeks	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.	No
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	No
identiteitskaart	tekenreeks	De id van de aanroep van het hulpprogramma.	Ja
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Ja

OpenAI.ChatCompletionMessageToolCallChunk

Naam	Type	Description	Required
function	Object		No
└; argumenten	tekenreeks	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.	No
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	No
identiteitskaart	tekenreeks	De id van de aanroep van het hulpprogramma.	No
index	integer		Ja
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	No

OpenAI.ChatCompletionNamedToolChoice

Hiermee geeft u een hulpprogramma op dat het model moet gebruiken. Gebruik dit om het model te dwingen een specifieke functie aan te roepen.

Naam	Type	Description	Required
function	Object		Ja
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	No
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Ja

OpenAI.ChatCompletionRequestAssistantMessage

Berichten die door het model worden verzonden als reactie op gebruikersberichten.

Naam	Type	Description	Required
audio	Object	Gegevens over een eerdere audioreactie van het model.	No
└* id	tekenreeks	Unieke id voor een vorige audioreactie van het model.	No
inhoud	tekenreeks of matrix		No
function_call	Object	Afgeschaft en vervangen door `tool_calls`. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.	No
└; argumenten	tekenreeks		No
└─naam	tekenreeks		No
naam	tekenreeks	Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol.	No
weigering	tekenreeks	Het weigeringsbericht van de assistent.	No
role	enum	De rol van de auteur van berichten, in dit geval `assistant`. Mogelijke waarden: `assistant`	Ja
tool_calls	ChatCompletionMessageToolCallsItem	De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen.	No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Naam	Type	Description	Required
weigering	tekenreeks	Het weigeringsbericht dat door het model is gegenereerd.	Ja
tekst	tekenreeks	De tekstinhoud.	Ja
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `refusal`	Ja

OpenAI.ChatCompletionRequestDeveloperMessage

Door ontwikkelaars verstrekte instructies die het model moet volgen, ongeacht berichten die door de gebruiker worden verzonden. Met o1-modellen en nieuwer developer vervangen berichten de vorige system berichten.

Naam	Type	Description	Required
inhoud	tekenreeks of matrix		Ja
naam	tekenreeks	Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol.	No
role	enum	De rol van de auteur van berichten, in dit geval `developer`. Mogelijke waarden: `developer`	Ja

OpenAI.ChatCompletionRequestFunctionMessage

Naam	Type	Description	Required
inhoud	tekenreeks	De inhoud van het functiebericht.	Ja
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Ja
role	enum	De rol van de auteur van berichten, in dit geval `function`. Mogelijke waarden: `function`	Ja

OpenAI.ChatCompletionRequestMessage

Discriminator voor OpenAI.ChatCompletionRequestMessage

Dit onderdeel maakt gebruik van de eigenschap role om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`system`	OpenAI.ChatCompletionRequestSystemMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage

Naam	Type	Description	Required	Default
inhoud	tekenreeks of matrix		No
role	Object	De rol van de auteur van een bericht	Ja

OpenAI.ChatCompletionRequestMessageContentPart

Discriminator voor OpenAI.ChatCompletionRequestMessageContentPart

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`text`	OpenAI.ChatCompletionRequestMessageContentPartText
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio

Naam	Type	Description	Required	Default
type	OpenAI.ChatCompletionRequestMessageContentPartType		Ja

OpenAI.ChatCompletionRequestMessageContentPartAudio

Naam	Type	Description	Required
input_audio	Object		Ja
└* gegevens	tekenreeks	Met Base64 gecodeerde audiogegevens.	No
└─ formaat	enum	De indeling van de gecodeerde audiogegevens. Ondersteunt momenteel 'wav' en 'mp3'. Mogelijke waarden: `wav`, `mp3`	No
type	enum	Het type inhoudsonderdeel. Altijd `input_audio`. Mogelijke waarden: `input_audio`	Ja

OpenAI.ChatCompletionRequestMessageContentPartFile

Naam	Type	Description	Required
bestand	Object		Ja
└file_data	tekenreeks	De met base64 gecodeerde bestandsgegevens, die worden gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
└─file_id	tekenreeks	De id van een geüpload bestand dat moet worden gebruikt als invoer.	No
└─ Bestandsnaam	tekenreeks	De naam van het bestand, dat wordt gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
type	enum	Het type inhoudsonderdeel. Altijd `file`. Mogelijke waarden: `file`	Ja

OpenAI.ChatCompletionRequestMessageContentPartImage

Naam	Type	Description	Required
image_url	Object		Ja
└─ details	enum	Hiermee geeft u het detailniveau van de afbeelding op. Mogelijke waarden: `auto`, `lowhigh`	No
URL └*	tekenreeks	Een URL van de afbeelding of de met base64 gecodeerde afbeeldingsgegevens.	No
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `image_url`	Ja

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Naam	Type	Description	Required	Default
weigering	tekenreeks	Het weigeringsbericht dat door het model is gegenereerd.	Ja
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `refusal`	Ja

OpenAI.ChatCompletionRequestMessageContentPartText

Naam	Type	Description	Required	Default
tekst	tekenreeks	De tekstinhoud.	Ja
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `text`	Ja

OpenAI.ChatCompletionRequestMessageContentPartType

Property	Value
Typ	tekenreeks
waarden	`text` `file` `input_audio` `image_url` `refusal`

OpenAI.ChatCompletionRequestSystemMessage

Door ontwikkelaars verstrekte instructies die het model moet volgen, ongeacht berichten die door de gebruiker worden verzonden. Gebruik in plaats daarvan voor o1-modellen en nieuwere developer berichten voor dit doel.

Naam	Type	Description	Required
inhoud	tekenreeks of matrix		Ja
naam	tekenreeks	Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol.	No
role	enum	De rol van de auteur van berichten, in dit geval `system`. Mogelijke waarden: `system`	Ja

OpenAI.ChatCompletionRequestSystemMessageContentPart

Verwijzingen: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Naam	Type	Description	Required
inhoud	tekenreeks of matrix		Ja
role	enum	De rol van de auteur van berichten, in dit geval `tool`. Mogelijke waarden: `tool`	Ja
tool_call_id	tekenreeks	De aanroep van het hulpprogramma waarop dit bericht reageert.	Ja

OpenAI.ChatCompletionRequestToolMessageContentPart

Verwijzingen: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Berichten die door een eindgebruiker worden verzonden, met prompts of aanvullende contextinformatie.

Naam	Type	Description	Required
inhoud	tekenreeks of matrix		Ja
naam	tekenreeks	Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol.	No
role	enum	De rol van de auteur van berichten, in dit geval `user`. Mogelijke waarden: `user`	Ja

OpenAI.ChatCompletionRequestUserMessageContentPart

Naam	Type	Description	Required
bestand	Object		Ja
└file_data	tekenreeks	De met base64 gecodeerde bestandsgegevens, die worden gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
└─file_id	tekenreeks	De id van een geüpload bestand dat moet worden gebruikt als invoer.	No
└─ Bestandsnaam	tekenreeks	De naam van het bestand, dat wordt gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
image_url	Object		Ja
└─ details	enum	Hiermee geeft u het detailniveau van de afbeelding op. Mogelijke waarden: `auto`, `lowhigh`	No
URL └*	tekenreeks	Een URL van de afbeelding of de met base64 gecodeerde afbeeldingsgegevens.	No
input_audio	Object		Ja
└* gegevens	tekenreeks	Met Base64 gecodeerde audiogegevens.	No
└─ formaat	enum	De indeling van de gecodeerde audiogegevens. Ondersteunt momenteel 'wav' en 'mp3'. Mogelijke waarden: `wav`, `mp3`	No
tekst	tekenreeks	De tekstinhoud.	Ja
type	enum	Het type inhoudsonderdeel. Altijd `file`. Mogelijke waarden: `file`	Ja

OpenAI.ChatCompletionRole

De rol van de auteur van een bericht

Property	Value
Description	De rol van de auteur van een bericht
Typ	tekenreeks
waarden	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

Opties voor streaming-antwoord. Stel dit alleen in wanneer u instelt stream: true.

Naam	Type	Description	Required	Default
include_usage	boolean	Als dit is ingesteld, wordt er vóór het `data: [DONE]` bericht een extra segment gestreamd. Het `usage` veld in dit segment toont de gebruiksstatistieken van tokens voor de hele aanvraag en het `choices` veld is altijd een lege matrix. Alle andere segmenten bevatten ook een `usage` veld, maar met een null-waarde. OPMERKING: Als de stream wordt onderbroken, ontvangt u mogelijk niet het uiteindelijke gebruikssegment dat het totale tokengebruik voor de aanvraag bevat.	No

OpenAI.ChatCompletionStreamResponseDelta

Een delta voor het voltooien van chats die wordt gegenereerd door gestreamde modelreacties.

Naam	Type	Description	Required
audio	Object		No
└* gegevens	tekenreeks		No
└─ vervalt_op	integer		No
└* id	tekenreeks		No
└* transcriptie	tekenreeks		No
inhoud	tekenreeks	De inhoud van het segmentbericht.	No
function_call	Object	Afgeschaft en vervangen door `tool_calls`. De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.	No
└; argumenten	tekenreeks		No
└─naam	tekenreeks		No
weigering	tekenreeks	Het weigeringsbericht dat door het model is gegenereerd.	No
role	Object	De rol van de auteur van een bericht	No
tool_calls	gegevensreeks		No

OpenAI.ChatCompletionTokenLogprob

Naam	Type	Description	Required
bytes	gegevensreeks	Een lijst met gehele getallen die de UTF-8 bytes vertegenwoordigen van het token. Handig in gevallen waarin tekens worden vertegenwoordigd door meerdere tokens en hun byteweergaven moeten worden gecombineerd om de juiste tekstweergave te genereren. Dit kan zijn `null` als er geen bytes-weergave voor het token is.	Ja
logprob	number	De logboekkans van dit token, als het zich binnen de 20 meest waarschijnlijke tokens bevindt. Anders wordt de waarde `-9999.0` gebruikt om aan te geven dat het token zeer onwaarschijnlijk is.	Ja
token	tekenreeks	Het token.	Ja
top_logprobs	gegevensreeks	Lijst met de meest waarschijnlijke tokens en hun logboekkans, op deze tokenpositie. In zeldzame gevallen kan er minder zijn dan het aantal aangevraagde `top_logprobs` geretourneerde aanvragen.	Ja

OpenAI.ChatCompletionTool

Naam	Type	Description	Required	Default
function	OpenAI.FunctionObject		Ja
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Ja

OpenAI.ChatCompletionToolChoiceOption

Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. none betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. auto betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. required betekent dat het model een of meer hulpprogramma's moet aanroepen. Het opgeven van een bepaald hulpprogramma via {"type": "function", "function": {"name": "my_function"}} dwingt het model om dat hulpprogramma aan te roepen.

none is de standaardinstelling wanneer er geen hulpprogramma's aanwezig zijn. auto is de standaardinstelling als er hulpprogramma's aanwezig zijn.

Naam	Type	Description	Required
function	Object		Ja
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	No
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Ja

OpenAI.ChatOutputPrediction

Basisweergave van voorspelde uitvoer van een model.

Discriminator voor OpenAI.ChatOutputPrediction

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`content`	OpenAI.ChatOutputPredictionContent

Naam	Type	Description	Required	Default
type	OpenAI.ChatOutputPredictionType		Ja

OpenAI.ChatOutputPredictionContent

Statische voorspelde uitvoerinhoud, zoals de inhoud van een tekstbestand dat opnieuw wordt gegenereerd.

Naam	Type	Description	Required	Default
inhoud	tekenreeks of matrix		Ja
type	enum	Het type voorspelde inhoud dat u wilt opgeven. Dit type is momenteel altijd `content`. Mogelijke waarden: `content`	Ja

OpenAI.ChatOutputPredictionType

Property	Value
Typ	tekenreeks
waarden	`content`

OpenAI.ChunkingStrategyRequestParam

De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de auto strategie gebruikt.

Discriminator voor OpenAI.ChunkingStrategyRequestParam

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`static`	OpenAI.StaticChunkingStrategyRequestParam

Naam	Type	Description	Required	Default
type	enum	Het type segmenteringsstrategie. Mogelijke waarden: `auto`, `static`	Ja

OpenAI.ChunkingStrategyResponseParam

Discriminator voor OpenAI.ChunkingStrategyResponseParam

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`other`	OpenAI.OtherChunkingStrategyResponseParam
`static`	OpenAI.StaticChunkingStrategyResponseParam

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `static`, `other`	Ja

OpenAI.CodeInterpreterOutput

Discriminator voor OpenAI.CodeInterpreterOutput

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Naam	Type	Description	Required	Default
type	OpenAI.CodeInterpreterOutputType		Ja

OpenAI.CodeInterpreterOutputImage

De uitvoer van de afbeelding van de code-interpreter.

Naam	Type	Description	Required	Default
type	enum	Het type uitvoer. Altijd 'afbeelding'. Mogelijke waarden: `image`	Ja
URL	tekenreeks	De URL van de uitvoer van de afbeelding van de code-interpreter.	Ja

OpenAI.CodeInterpreterOutputLogs

De logboekuitvoer van de code-interpreter.

Naam	Type	Description	Required	Default
logs	tekenreeks	De logboekuitvoer van de code-interpreter.	Ja
type	enum	Het type uitvoer. Altijd logboeken. Mogelijke waarden: `logs`	Ja

OpenAI.CodeInterpreterOutputType

Property	Value
Typ	tekenreeks
waarden	`logs` `image`

OpenAI.CodeInterpreterTool

Een hulpprogramma dat Python code uitvoert om een antwoord op een prompt te genereren.

Naam	Type	Description	Required
container	Object	Configuratie voor een code-interpretercontainer. Geef desgewenst de id's van de bestanden op waarop de code moet worden uitgevoerd.	Ja
└file_ids	gegevensreeks	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code.	No
└type.	enum	Altijd `auto`. Mogelijke waarden: `auto`	No
type	enum	Het type code-interpreter-hulpprogramma. Altijd `code_interpreter`. Mogelijke waarden: `code_interpreter`	Ja

OpenAI.CodeInterpreterToolAuto

Configuratie voor een code-interpretercontainer. Geef desgewenst de id's van de bestanden op waarop de code moet worden uitgevoerd.

Naam	Type	Description	Required	Default
file_ids	gegevensreeks	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code.	No
type	enum	Altijd `auto`. Mogelijke waarden: `auto`	Ja

OpenAI.CodeInterpreterToolCallItemParam

Een aanroep van een hulpprogramma om code uit te voeren.

Naam	Type	Description	Required
code	tekenreeks	De code die moet worden uitgevoerd of null als deze niet beschikbaar is.	Ja
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Ja
outputs	gegevensreeks	De uitvoer die wordt gegenereerd door de code-interpreter, zoals logboeken of afbeeldingen. Kan null zijn als er geen uitvoer beschikbaar is.	Ja
type	enum	Mogelijke waarden: `code_interpreter_call`	Ja

OpenAI.CodeInterpreterToolCallItemResource

Een aanroep van een hulpprogramma om code uit te voeren.

Naam	Type	Description	Required
code	tekenreeks	De code die moet worden uitgevoerd of null als deze niet beschikbaar is.	Ja
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Ja
outputs	gegevensreeks	De uitvoer die wordt gegenereerd door de code-interpreter, zoals logboeken of afbeeldingen. Kan null zijn als er geen uitvoer beschikbaar is.	Ja
status	enum	Mogelijke waarden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Mogelijke waarden: `code_interpreter_call`	Ja

OpenAI.ComparisonFilter

Een filter dat wordt gebruikt om een opgegeven kenmerksleutel te vergelijken met een bepaalde waarde met behulp van een gedefinieerde vergelijkingsbewerking.

Naam	Type	Description	Required
sleutel	tekenreeks	De sleutel die moet worden vergeleken met de waarde.	Ja
type	enum	Hiermee geeft u de vergelijkingsoperator: `eq`, `ne`, `gt`, `gte`, , `lt`. `lte` - `eq`: is gelijk aan - `ne`: niet gelijk aan - `gt`: groter dan - `gte`: groter dan of gelijk aan - `lt`: kleiner dan - `lte`: kleiner dan of gelijk aan. Mogelijke waarden: `eq`, `ne`, `gt`, `gte`, , `ltlte`	Ja
value	tekenreeks of getal of booleaanse waarde		Ja

OpenAI.CompletionUsage

Gebruiksstatistieken voor de voltooiingsaanvraag.

Naam	Type	Description	Required	Default
completion_tokens	integer	Aantal tokens in de gegenereerde voltooiing.	Ja	0
completion_tokens_details	Object	Uitsplitsing van tokens die worden gebruikt in een voltooiing.	No
└geaccepteerde_voorspellingstokens	integer	Wanneer u voorspelde uitvoer gebruikt, wordt het aantal tokens in de voorspelling weergegeven in de voltooiing.	No	0
└ audio_tokens	integer	Audio-invoertokens die door het model worden gegenereerd.	No	0
└─ redeneertokens	integer	Tokens die door het model worden gegenereerd voor redenering.	No	0
└rejected_prediction_tokens	integer	Wanneer u voorspelde uitvoer gebruikt, wordt het aantal tokens in de voorspelling weergegeven dat niet in de voltooiing is weergegeven. Net als met redeneringstokens worden deze tokens echter nog steeds meegeteld in de totale voltooiingstokens voor facturerings-, uitvoer- en contextvensterlimieten.	No	0
prompt_tokens	integer	Aantal tokens in de prompt.	Ja	0
prompt_tokens_details	Object	Uitsplitsing van tokens die in de prompt worden gebruikt.	No
└ audio_tokens	integer	Audio-invoertokens aanwezig in de prompt.	No	0
└ cached_tokens	integer	Tokens in de cache die aanwezig zijn in de prompt.	No	0
total_tokens	integer	Het totale aantal tokens dat wordt gebruikt in de aanvraag (prompt + voltooiing).	Ja	0

OpenAI.CompoundFilter

Meerdere filters combineren met of andor.

Naam	Type	Description	Required	Default
filters	gegevensreeks	Matrix van filters die moeten worden gecombineerd. Items kunnen `ComparisonFilter` of `CompoundFilter`.	Ja
type	enum	Type bewerking: `and` of `or`. Mogelijke waarden: `and`, `or`	Ja

OpenAI.ComputerAction

Discriminator voor OpenAI.ComputerAction

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

Naam	Type	Description	Required	Default
type	OpenAI.ComputerActionType		Ja

OpenAI.ComputerActionClick

Een klikactie.

Naam	Type	Description	Required
knop	enum	Geeft aan welke muisknop tijdens de klik is ingedrukt. Een van`left`, `right`, `wheel`, of `backforward`. Mogelijke waarden: `left`, `right`, `wheel`, , `backforward`	Ja
type	enum	Hiermee geeft u het gebeurtenistype. Voor een klikactie is deze eigenschap altijd ingesteld op `click`. Mogelijke waarden: `click`	Ja
x	integer	De x-coördinaat waar de klik is opgetreden.	Ja
y	integer	De y-coördinaat waar de klik heeft plaatsgevonden.	Ja

OpenAI.ComputerActionDoubleClick

Een actie met dubbelklikken.

Naam	Type	Description	Required
type	enum	Hiermee geeft u het gebeurtenistype. Voor een actie met dubbelklikken is deze eigenschap altijd ingesteld op `double_click`. Mogelijke waarden: `double_click`	Ja
x	integer	De x-coördinaat waarop het dubbelklikken heeft plaatsgevonden.	Ja
y	integer	De y-coördinaat waar het dubbelklikken heeft plaatsgevonden.	Ja

OpenAI.ComputerActionDrag

Een sleepactie.

Naam	Type	Description	Required	Default
path	gegevensreeks	Een matrix met coördinaten die het pad van de sleepactie vertegenwoordigen. Coördinaten worden weergegeven als een matrix van objecten, bijvoorbeeld`{ x: 100, y: 200 }, { x: 200, y: 300 }`	Ja
type	enum	Hiermee geeft u het gebeurtenistype. Voor een sleepactie is deze eigenschap altijd ingesteld op `drag`. Mogelijke waarden: `drag`	Ja

OpenAI.ComputerActionKeyPress

Een verzameling toetsdrukken die het model wil uitvoeren.

Naam	Type	Description	Required	Default
toetsen/sleutels	gegevensreeks	De toetsencombinatie van het model vraagt om te worden ingedrukt. Dit is een matrix met tekenreeksen die elk een sleutel vertegenwoordigen.	Ja
type	enum	Hiermee geeft u het gebeurtenistype. Voor een toetsdrukactie is deze eigenschap altijd ingesteld op `keypress`. Mogelijke waarden: `keypress`	Ja

OpenAI.ComputerActionMove

Een actie voor het verplaatsen van de muis.

Naam	Type	Description	Required
type	enum	Hiermee geeft u het gebeurtenistype. Voor een verplaatsingsactie is deze eigenschap altijd ingesteld op `move`. Mogelijke waarden: `move`	Ja
x	integer	De x-coördinaat naartoe.	Ja
y	integer	De y-coördinaat naartoe.	Ja

OpenAI.ComputerActionScreenshot

Een schermopnameactie.

Naam	Type	Description	Required	Default
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schermafbeeldingsactie is deze eigenschap altijd ingesteld op `screenshot`. Mogelijke waarden: `screenshot`	Ja

OpenAI.ComputerActionScroll

Een schuifactie.

Naam	Type	Description	Required
scroll_x	integer	De horizontale schuifafstand.	Ja
scroll_y	integer	De verticale schuifafstand.	Ja
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schuifactie is deze eigenschap altijd ingesteld op `scroll`. Mogelijke waarden: `scroll`	Ja
x	integer	De x-coördinaat waar de schuif heeft plaatsgevonden.	Ja
y	integer	De y-coördinaat waar de schuif heeft plaatsgevonden.	Ja

OpenAI.ComputerActionType

Property	Value
Typ	tekenreeks
waarden	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

Een actie om tekst te typen.

Naam	Type	Description	Required	Default
tekst	tekenreeks	De tekst die moet worden getypt.	Ja
type	enum	Hiermee geeft u het gebeurtenistype. Voor een typeactie is deze eigenschap altijd ingesteld op `type`. Mogelijke waarden: `type`	Ja

OpenAI.ComputerActionWait

Een wachtactie.

Naam	Type	Description	Required	Default
type	enum	Hiermee geeft u het gebeurtenistype. Voor een wachtactie is deze eigenschap altijd ingesteld op `wait`. Mogelijke waarden: `wait`	Ja

OpenAI.ComputerToolCallItemParam

Een hulpprogramma-aanroep naar een hulpprogramma voor computergebruik.

Naam	Type	Description	Required
action	OpenAI.ComputerAction		Ja
call_id	tekenreeks	Een id die wordt gebruikt bij het beantwoorden van de aanroep van het hulpprogramma met uitvoer.	Ja
pending_safety_checks	gegevensreeks	De in behandeling zijnde veiligheidscontroles voor de computeroproep.	Ja
type	enum	Mogelijke waarden: `computer_call`	Ja

OpenAI.ComputerToolCallItemResource

Een hulpprogramma-aanroep naar een hulpprogramma voor computergebruik.

Naam	Type	Description	Required
action	OpenAI.ComputerAction		Ja
call_id	tekenreeks	Een id die wordt gebruikt bij het beantwoorden van de aanroep van het hulpprogramma met uitvoer.	Ja
pending_safety_checks	gegevensreeks	De in behandeling zijnde veiligheidscontroles voor de computeroproep.	Ja
status	enum	De status van het item. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Mogelijke waarden: `computer_call`	Ja

OpenAI.ComputerToolCallOutputItemOutput

Discriminator voor OpenAI.ComputerToolCallOutputItemOutput

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Naam	Type	Description	Required	Default
type	OpenAI.ComputerToolCallOutputItemOutputType	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Ja

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Naam	Type	Description	Required
file_id	tekenreeks		No
image_url	tekenreeks		No
type	enum	Mogelijke waarden: `computer_screenshot`	Ja

OpenAI.ComputerToolCallOutputItemOutputType

Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.

Property	Value
Description	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.
Typ	tekenreeks
waarden	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

De uitvoer van een aanroep van een computerhulpprogramma.

Naam	Type	Description	Required
acknowledged_safety_checks	gegevensreeks	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Ja
uitvoer	OpenAI.ComputerToolCallOutputItemOutput		Ja
type	enum	Mogelijke waarden: `computer_call_output`	Ja

OpenAI.ComputerToolCallOutputItemResource

De uitvoer van een aanroep van een computerhulpprogramma.

Naam	Type	Description	Required
acknowledged_safety_checks	gegevensreeks	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Ja
uitvoer	OpenAI.ComputerToolCallOutputItemOutput		Ja
status	enum	De status van het item. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Mogelijke waarden: `computer_call_output`	Ja

OpenAI.ComputerToolCallSafetyCheck

Een veiligheidscontrole in behandeling voor de computeroproep.

Naam	Type	Description	Required
code	tekenreeks	Het type van de in behandeling zijnde veiligheidscontrole.	Ja
identiteitskaart	tekenreeks	De id van de in behandeling zijnde veiligheidscontrole.	Ja
message	tekenreeks	Details over de in behandeling zijnde veiligheidscontrole.	Ja

OpenAI.ComputerUsePreviewTool

Een hulpprogramma waarmee een virtuele computer wordt bestuurd.

Naam	Type	Description	Required
schermhoogte	integer	De hoogte van de computerweergave.	Ja
weergavebreedte	integer	De breedte van de computerweergave.	Ja
environment	enum	Het type computeromgeving dat moet worden gecontroleerd. Mogelijke waarden: `windows`, `mac`, `linux`, , `ubuntubrowser`	Ja
type	enum	Het type hulpprogramma voor computergebruik. Altijd `computer_use_preview`. Mogelijke waarden: `computer_use_preview`	Ja

OpenAI.Coordinate

Een x/y-coördinaatpaar, bijvoorbeeld { x: 100, y: 200 }.

Naam	Type	Description	Required	Default
x	integer	De x-coördinaat.	Ja
y	integer	De y-coördinaat.	Ja

OpenAI.CreateEmbeddingResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks	De lijst met insluitingen die door het model worden gegenereerd.	Ja
model	tekenreeks	De naam van het model dat wordt gebruikt voor het genereren van de insluiting.	Ja
Object	enum	Het objecttype, dat altijd 'list' is. Mogelijke waarden: `list`	Ja
gebruik	Object	De gebruiksgegevens voor de aanvraag.	Ja
└prompt_tokens	integer	Het aantal tokens dat door de prompt wordt gebruikt.	No
└ totaal tokens	integer	Het totale aantal tokens dat door de aanvraag wordt gebruikt.	No

OpenAI.CreateEvalItem

Een chatbericht waaruit de prompt of context bestaat. Kan variabele verwijzingen naar de item naamruimte bevatten, dus {{item.name}}.

Naam	Type	Description	Required
inhoud	tekenreeks of OpenAI.EvalItemContent	Tekstinvoer voor het model- kan sjabloontekenreeksen bevatten.	Ja
role	enum	De rol van de berichtinvoer. Een van`user`, `assistant`, of `systemdeveloper`. Mogelijke waarden: `user`, `assistant`, , `systemdeveloper`	Ja
type	enum	Het type berichtinvoer. Altijd `message`. Mogelijke waarden: `message`	No

OpenAI.CreateEvalRunRequest

Naam	Type	Description	Required
gegevensbron	Object		Ja
└type.	OpenAI.EvalRunDataSourceType		No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de uitvoering.	No

OpenAI.CreateFineTuningJobRequest

Geldige modellen:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Naam	Type	Description	Required	Default
hyperparameters (instellingen die een model beïnvloeden)	Object	De hyperparameters die worden gebruikt voor de afstemmingstaak. Deze waarde is nu afgeschaft ten gunste van `method`en moet worden doorgegeven onder de `method` parameter.	No
└ batch_size	enum	Mogelijke waarden: `auto`	No
└learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
└n_epochs	enum	Mogelijke waarden: `auto`	No
integraties	gegevensreeks	Een lijst met integraties waarmee u uw taak kunt verfijnen.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	tekenreeks (zie geldige modellen hieronder)	De naam van het model om af te stemmen.	Ja
seed	integer	Het zaad bepaalt de reproduceerbaarheid van de taak. Het doorgeven van dezelfde seed- en taakparameters moet dezelfde resultaten opleveren, maar kan in zeldzame gevallen verschillen. Als er geen seed is opgegeven, wordt er een voor u gegenereerd.	No
achtervoegsel	tekenreeks	Een tekenreeks van maximaal 64 tekens die wordt toegevoegd aan de aangepaste modelnaam. Een van 'custom-model-name' produceert bijvoorbeeld `suffix` een modelnaam zoals `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	No	Geen
training_file	tekenreeks	De id van een geüpload bestand dat trainingsgegevens bevat. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. Daarnaast moet u uw bestand uploaden met het doel `fine-tune`. De inhoud van het bestand moet verschillen, afhankelijk van of het model gebruikmaakt van de chat, voltooiingsindeling of als de methode voor het afstemmen gebruikmaakt van de voorkeursindeling.	Ja
validatiebestand	tekenreeks	De id van een geüpload bestand dat validatiegegevens bevat. Als u dit bestand opgeeft, worden de gegevens gebruikt om periodiek validatiegegevens te genereren tijdens het afstemmen. Deze metrische gegevens kunnen worden weergegeven in het resultatenbestand voor het afstemmen van de resultaten. Dezelfde gegevens mogen niet aanwezig zijn in zowel trein- als validatiebestanden. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. U moet uw bestand uploaden met het doel `fine-tune`.	No

OpenAI.CreateFineTuningJobRequestIntegration

Discriminator voor OpenAI.CreateFineTuningJobRequestIntegration

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Naam	Type	Description	Required	Default
type	tekenreeks (zie geldige modellen hieronder)		Ja

OpenAI.CreateFineTuningJobRequestWandbIntegration

Naam	Type	Description	Required
type	enum	Mogelijke waarden: `wandb`	Ja
wandb	Object		Ja
└─ Entiteit	tekenreeks		No
└─naam	tekenreeks		No
└─project	tekenreeks		No
└tags.	gegevensreeks		No

OpenAI.CreateVectorStoreFileBatchRequest

Naam	Type	Description	Required
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de `auto` strategie gebruikt.	No
file_ids	gegevensreeks	Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	Ja

OpenAI.CreateVectorStoreFileRequest

Naam	Type	Description	Required
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	De segmenteringsstrategie die wordt gebruikt om de bestanden te segmenteren. Als deze niet is ingesteld, wordt de `auto` strategie gebruikt.	No
file_id	tekenreeks	Een bestands-id die door het vectorarchief moet worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	Ja

OpenAI.CreateVectorStoreRequest

Naam	Type	Description	Required
chunking_strategy	Object	De standaardstrategie. Deze strategie maakt momenteel gebruik van een `max_chunk_size_tokens` van `800` en `chunk_overlap_tokens` van `400`.	No
└* statisch	OpenAI.StaticChunkingStrategy		No
└type.	enum	Altijd `static`. Mogelijke waarden: `static`	No
verloopt_na	OpenAI.VectorStoreExpirationAfter	Het verloopbeleid voor een vectorarchief.	No
file_ids	gegevensreeks	Een lijst met bestands-id's die door het vectorarchief moeten worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van het vectorarchief.	No

OpenAI.DeleteFileResponse

Naam	Type	Description	Required
verwijderd	boolean		Ja
identiteitskaart	tekenreeks		Ja
Object	enum	Mogelijke waarden: `file`	Ja

OpenAI.DeleteVectorStoreFileResponse

Naam	Type	Description	Required
verwijderd	boolean		Ja
identiteitskaart	tekenreeks		Ja
Object	enum	Mogelijke waarden: `vector_store.file.deleted`	Ja

OpenAI.DeleteVectorStoreResponse

Naam	Type	Description	Required
verwijderd	boolean		Ja
identiteitskaart	tekenreeks		Ja
Object	enum	Mogelijke waarden: `vector_store.deleted`	Ja

OpenAI.Embedding

Vertegenwoordigt een insluitvector die wordt geretourneerd door het insluiten van een eindpunt.

Naam	Type	Description	Required
embedding	matrix of tekenreeks		Ja
index	integer	De index van de insluiting in de lijst met insluitingen.	Ja
Object	enum	Het objecttype, dat altijd 'insluiten' is. Mogelijke waarden: `embedding`	Ja

OpenAI.Eval

Een Eval-object met een configuratie- en testcriteria voor een gegevensbron. Een Eval vertegenwoordigt een taak die moet worden uitgevoerd voor uw LLM-integratie. Vind ik leuk:

De kwaliteit van mijn chatbot verbeteren
Bekijk hoe goed mijn chatbot de klantondersteuning afhandelt
Controleer of o4-mini beter is in mijn usecase dan gpt-4o

Naam	Type	Description	Required	Default
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor het moment waarop de eval is gemaakt.	Ja
gegevensbron_configuratie	Object		Ja
└type.	OpenAI.EvalDataSourceConfigType		No
identiteitskaart	tekenreeks	Unieke id voor de evaluatie.	Ja
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
naam	tekenreeks	De naam van de evaluatie.	Ja
Object	enum	Het objecttype. Mogelijke waarden: `eval`	Ja
testing_criteria	gegevensreeks	Een lijst met testcriteria.	Ja	Geen

OpenAI.EvalApiError

Een object dat een foutbericht weergeeft van de Eval-API.

Naam	Type	Description	Required	Default
code	tekenreeks	De foutcode.	Ja
message	tekenreeks	Het foutbericht.	Ja

OpenAI.EvalCompletionsRunDataSourceParams

Een CompletionsRunDataSource-object met een beschrijving van een modelsamplingconfiguratie.

Naam	Type	Description	Required
invoer_berichten	Object		No
└ item_reference	tekenreeks	Een verwijzing naar een variabele in de `item` naamruimte. 'item.input_trajectory'	No
└─ sjabloon	gegevensreeks	Een lijst met chatberichten die de prompt of context vormen. Kan variabele verwijzingen naar de `item` naamruimte bevatten, dus {{item.name}}.	No
└type.	enum	Het type invoerberichten. Altijd `item_reference`. Mogelijke waarden: `item_reference`	No
model	tekenreeks	De naam van het model dat moet worden gebruikt voor het genereren van voltooiingen (bijvoorbeeld 'o3-mini').	No
sampling_params	AzureEvalAPICompletionsSamplingParams		No
source	Object		Ja
└* inhoud	gegevensreeks	De inhoud van het jsonl-bestand.	No
└ created_after	integer	Een optionele Unix-tijdstempel voor het filteren van items die na deze tijd zijn gemaakt.	No
└created_before	integer	Een optionele Unix-tijdstempel voor het filteren van items die vóór deze tijd zijn gemaakt.	No
└* id	tekenreeks	De id van het bestand.	No
└─ Limiet	integer	Een optioneel maximum aantal te retourneren items.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	Een optioneel model om op te filteren (bijvoorbeeld 'gpt-4o').	No
└type.	enum	Het type bron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	No
type	enum	Het type gegevensbron uitvoeren. Altijd `completions`. Mogelijke waarden: `completions`	Ja

OpenAI.EvalCustomDataSourceConfigParams

Een CustomDataSourceConfig-object dat het schema definieert voor de gegevensbron die wordt gebruikt voor de evaluatieuitvoeringen. Dit schema wordt gebruikt om de vorm van de gegevens te definiëren die:

Wordt gebruikt om uw testcriteria te definiëren en
Welke gegevens zijn vereist bij het maken van een uitvoering

Naam	Type	Description	Required	Default
include_voorbeeldschema	boolean	Of de evaluatie verwacht dat u de voorbeeldnaamruimte vult (bijvoorbeeld door antwoorden van uw gegevensbron te genereren)	No	Onwaar
item-schema	Object	Het json-schema voor elke rij in de gegevensbron.	Ja
type	enum	Het type gegevensbron. Altijd `custom`. Mogelijke waarden: `custom`	Ja

OpenAI.EvalCustomDataSourceConfigResource

Een CustomDataSourceConfig waarmee het schema van uw item en eventueel sample naamruimten wordt opgegeven. Het antwoordschema definieert de vorm van de gegevens:

Wordt gebruikt om uw testcriteria te definiëren en
Welke gegevens zijn vereist bij het maken van een uitvoering

Naam	Type	Description	Required	Default
schema	Object	Het json-schema voor de gegevensbronitems uitvoeren. Leer hier hoe u JSON-schema's bouwt.	Ja
type	enum	Het type gegevensbron. Altijd `custom`. Mogelijke waarden: `custom`	Ja

OpenAI.EvalDataSourceConfigParams

Discriminator voor OpenAI.EvalDataSourceConfigParams

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigParams
`logs`	OpenAI.EvalLogsDataSourceConfigParams
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Naam	Type	Description	Required	Default
type	OpenAI.EvalDataSourceConfigType		Ja

OpenAI.EvalDataSourceConfigResource

Discriminator voor OpenAI.EvalDataSourceConfigResource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigResource
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigResource
`logs`	OpenAI.EvalLogsDataSourceConfigResource

Naam	Type	Description	Required	Default
type	OpenAI.EvalDataSourceConfigType		Ja

OpenAI.EvalDataSourceConfigType

Property	Value
Typ	tekenreeks
waarden	`custom` `logs` `stored_completions`

OpenAI.EvalGraderLabelModelParams

Een LabelModelGrader-object dat gebruikmaakt van een model om labels toe te wijzen aan elk item in de evaluatie.

Naam	Type	Description	Required
Invoer	gegevensreeks	Een lijst met chatberichten die de prompt of context vormen. Kan variabele verwijzingen naar de `item` naamruimte bevatten, dus {{item.name}}.	Ja
labels	gegevensreeks	De labels die moeten worden geclassificeerd voor elk item in de evaluatie.	Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
doorgeven_labels	gegevensreeks	De labels die een doorgevend resultaat aangeven. Moet een subset van labels zijn.	Ja
type	enum	Het objecttype, dat altijd `label_model`is. Mogelijke waarden: `label_model`	Ja

OpenAI.EvalGraderLabelModelResource

Naam	Type	Description	Required
Invoer	gegevensreeks		Ja
labels	gegevensreeks	De labels die aan elk item in de evaluatie moeten worden toegewezen.	Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
doorgeven_labels	gegevensreeks	De labels die een doorgevend resultaat aangeven. Moet een subset van labels zijn.	Ja
type	enum	Het objecttype, dat altijd `label_model`is. Mogelijke waarden: `label_model`	Ja

OpenAI.EvalGraderParams

Discriminator voor OpenAI.EvalGraderParams

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`label_model`	OpenAI.EvalGraderLabelModelParams
`string_check`	OpenAI.EvalGraderStringCheckParams
`text_similarity`	OpenAI.EvalGraderTextSimilarityParams
`python`	OpenAI.EvalGraderPythonParams
`score_model`	OpenAI.EvalGraderScoreModelParams

Naam	Type	Description	Required	Default
type	OpenAI.GraderType		Ja

OpenAI.EvalGraderPythonParams

Naam	Type	Description	Required
image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
naam	tekenreeks	De naam van de cijferaar.	Ja
drempelwaarde overschrijden	number	De drempelwaarde voor de score.	No
source	tekenreeks	De broncode van het Python-script.	Ja
type	enum	Het objecttype, dat altijd `python`is. Mogelijke waarden: `python`	Ja

OpenAI.EvalGraderPythonResource

Naam	Type	Description	Required
image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
naam	tekenreeks	De naam van de cijferaar.	Ja
drempelwaarde overschrijden	number	De drempelwaarde voor de score.	No
source	tekenreeks	De broncode van het Python-script.	Ja
type	enum	Het objecttype, dat altijd `python`is. Mogelijke waarden: `python`	Ja

OpenAI.EvalGraderResource

Discriminator voor OpenAI.EvalGraderResource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`label_model`	OpenAI.EvalGraderLabelModelResource
`text_similarity`	OpenAI.EvalGraderTextSimilarityResource
`python`	OpenAI.EvalGraderPythonResource
`score_model`	OpenAI.EvalGraderScoreModelResource

Naam	Type	Description	Required	Default
type	OpenAI.GraderType		Ja

OpenAI.EvalGraderScoreModelParams

Naam	Type	Description	Required
Invoer	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
drempelwaarde overschrijden	number	De drempelwaarde voor de score.	No
range	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
sampling_params		De steekproefparameters voor het model.	No
type	enum	Het objecttype, dat altijd `score_model`is. Mogelijke waarden: `score_model`	Ja

OpenAI.EvalGraderScoreModelResource

Naam	Type	Description	Required
Invoer	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
drempelwaarde overschrijden	number	De drempelwaarde voor de score.	No
range	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
sampling_params		De steekproefparameters voor het model.	No
type	enum	Het objecttype, dat altijd `score_model`is. Mogelijke waarden: `score_model`	Ja

OpenAI.EvalGraderStringCheckParams

Naam	Type	Description	Required
Invoer	tekenreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
operatie	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	Ja
referentie	tekenreeks	De verwijzingstekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
type	enum	Het objecttype, dat altijd `string_check`is. Mogelijke waarden: `string_check`	Ja

OpenAI.EvalGraderTextSimilarityParams

Naam	Type	Description	Required
evaluatiemaatstaf	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	Ja
Invoer	tekenreeks	De tekst die wordt beoordeeld.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
drempelwaarde overschrijden	number	De drempelwaarde voor de score.	Ja
referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	Ja
type	enum	Het type cijfer. Mogelijke waarden: `text_similarity`	Ja

OpenAI.EvalGraderTextSimilarityResource

Naam	Type	Description	Required
evaluatiemaatstaf	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	Ja
Invoer	tekenreeks	De tekst die wordt beoordeeld.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
drempelwaarde overschrijden	number	De drempelwaarde voor de score.	Ja
referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	Ja
type	enum	Het type cijfer. Mogelijke waarden: `text_similarity`	Ja

OpenAI.EvalItem

Een berichtinvoer voor het model met een rol die de instructies in de volgende hiërarchie aangeeft. Instructies met de developer of system rol hebben voorrang op instructies die met de user rol worden gegeven. Berichten met de assistant rol worden verondersteld te zijn gegenereerd door het model in eerdere interacties.

Naam	Type	Description	Required
inhoud	Object		Ja
└type.	OpenAI.EvalItemContentType		No
role	enum	De rol van de berichtinvoer. Een van`user`, `assistant`, of `systemdeveloper`. Mogelijke waarden: `user`, `assistant`, , `systemdeveloper`	Ja
type	enum	Het type berichtinvoer. Altijd `message`. Mogelijke waarden: `message`	No

OpenAI.EvalItemContent

Discriminator voor OpenAI.EvalItemContent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`input_text`	OpenAI.EvalItemContentInputText
`output_text`	OpenAI.EvalItemContentOutputText

Naam	Type	Description	Required	Default
type	OpenAI.EvalItemContentType		Ja

OpenAI.EvalItemContentInputText

Naam	Type	Description	Required	Default
tekst	tekenreeks		Ja
type	enum	Mogelijke waarden: `input_text`	Ja

OpenAI.EvalItemContentOutputText

Naam	Type	Description	Required	Default
tekst	tekenreeks		Ja
type	enum	Mogelijke waarden: `output_text`	Ja

OpenAI.EvalItemContentType

Property	Value
Typ	tekenreeks
waarden	`input_text` `output_text`

OpenAI.EvalJsonlRunDataSourceParams

Een JsonlRunDataSource-object met dat een JSONL-bestand opgeeft dat overeenkomt met de eval

Naam	Type	Description	Required
source	Object		Ja
└* inhoud	gegevensreeks	De inhoud van het jsonl-bestand.	No
└* id	tekenreeks	De id van het bestand.	No
└type.	enum	Het type jsonl-bron. Altijd `file_id`. Mogelijke waarden: `file_id`	No
type	enum	Het type gegevensbron. Altijd `jsonl`. Mogelijke waarden: `jsonl`	Ja

OpenAI.EvalList

Een object dat een lijst met evals vertegenwoordigt.

Naam	Type	Description	Required
Gegevens	gegevensreeks	Een matrix met evaluatieobjecten.	Ja
first_id	tekenreeks	De id van de eersteval in de gegevensmatrix.	Ja
heeft_meer	boolean	Geeft aan of er meer evaluaties beschikbaar zijn.	Ja
last_id	tekenreeks	De id van de laatsteval in de gegevensmatrix.	Ja
Object	enum	Het type van dit object. Deze is altijd ingesteld op 'list'. Mogelijke waarden: `list`	Ja

OpenAI.EvalLogsDataSourceConfigParams

Een gegevensbronconfiguratie waarmee de metagegevenseigenschap van uw logboekquery wordt opgegeven. Dit zijn meestal metagegevens zoals usecase=chatbot of prompt-version=v2, enzovoort.

Naam	Type	Description	Required	Default
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
type	enum	Het type gegevensbron. Altijd `logs`. Mogelijke waarden: `logs`	Ja

OpenAI.EvalLogsDataSourceConfigResource

Een LogsDataSourceConfig waarmee de metagegevenseigenschap van uw logboekquery wordt opgegeven. Dit zijn meestal metagegevens zoals usecase=chatbot of prompt-version=v2, enzovoort. Het schema dat door deze gegevensbronconfiguratie wordt geretourneerd, wordt gebruikt om te definiëren welke variabelen beschikbaar zijn in uw evaluaties. item en sample beide worden gedefinieerd bij het gebruik van deze configuratie van de gegevensbron.

Naam	Type	Description	Required
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
schema	Object	Het json-schema voor de gegevensbronitems uitvoeren. Leer hier hoe u JSON-schema's bouwt.	Ja
type	enum	Het type gegevensbron. Altijd `logs`. Mogelijke waarden: `logs`	Ja

OpenAI.EvalResponsesRunDataSourceParams

Een ResponsesRunDataSource-object waarin een modelsamplingconfiguratie wordt beschreven.

Naam	Type	Description	Required
invoer_berichten	Object		No
└ item_reference	tekenreeks	Een verwijzing naar een variabele in de `item` naamruimte. Ie, "item.name"	No
└─ sjabloon	gegevensreeks	Een lijst met chatberichten die de prompt of context vormen. Kan variabele verwijzingen naar de `item` naamruimte bevatten, dus {{item.name}}.	No
└type.	enum	Het type invoerberichten. Altijd `item_reference`. Mogelijke waarden: `item_reference`	No
model	tekenreeks	De naam van het model dat moet worden gebruikt voor het genereren van voltooiingen (bijvoorbeeld 'o3-mini').	No
sampling_params	AzureEvalAPIResponseSamplingParams		No
source	Object		Ja
└* inhoud	gegevensreeks	De inhoud van het jsonl-bestand.	No
└ created_after	integer	Alleen items opnemen die na deze tijdstempel (inclusief) zijn gemaakt. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└created_before	integer	Alleen items opnemen die vóór deze tijdstempel (inclusief) zijn gemaakt. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└* id	tekenreeks	De id van het bestand.	No
└instructions_search	tekenreeks	Optionele tekenreeks om het veld 'instructies' te doorzoeken. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De naam van het model waarvoor antwoorden moeten worden gezocht. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└─ redeneerinspanning	OpenAI.ReasoningEffort	Optionele redeneringsinspanningsparameter. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└─ temperatuur	number	Temperatuur van de bemonstering. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└─ hulpmiddelen	gegevensreeks	Lijst met namen van hulpprogramma's. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└top_p	number	Kernsamplingparameter. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└type.	enum	Het type gegevensbron uitvoeren. Altijd `responses`. Mogelijke waarden: `responses`	No
└─ gebruikers	gegevensreeks	Lijst met gebruikers-id's. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
type	enum	Het type gegevensbron uitvoeren. Altijd `responses`. Mogelijke waarden: `responses`	Ja

OpenAI.EvalRun

Een schema dat een evaluatieuitvoering vertegenwoordigt.

Naam	Type	Description	Required
aangemaakt_op	integer	Unix-tijdstempel (in seconden) wanneer de evaluatieuitvoering is gemaakt.	Ja
gegevensbron	Object		Ja
└type.	OpenAI.EvalRunDataSourceType		No
error	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	Ja
eval_id	tekenreeks	De id van de bijbehorende evaluatie.	Ja
identiteitskaart	tekenreeks	Unieke id voor de evaluatieuitvoering.	Ja
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
model	tekenreeks	Het model dat wordt geëvalueerd, indien van toepassing.	Ja
naam	tekenreeks	De naam van de evaluatieuitvoering.	Ja
Object	enum	Het type object. Altijd 'eval.run'. Mogelijke waarden: `eval.run`	Ja
gebruik per model	gegevensreeks	Gebruiksstatistieken voor elk model tijdens de evaluatieuitvoering.	Ja
per_testcriteria_resultaten	gegevensreeks	Resultaten per testcriteria die zijn toegepast tijdens de evaluatieuitvoering.	Ja
report_url	tekenreeks	De URL naar het weergegeven evaluatierapport op het UI-dashboard.	Ja
aantal_resultaten	Object	Tellers die de resultaten van de evaluatieuitvoering samenvatten.	Ja
└* fout opgetreden	integer	Aantal uitvoeritems dat heeft geresulteerd in een fout.	No
└* mislukt	integer	Aantal uitvoeritems dat de evaluatie niet heeft doorstaan.	No
└* geslaagd	integer	Aantal uitvoeritems dat de evaluatie heeft doorstaan.	No
└totaal.	integer	Totaal aantal uitgevoerde uitvoeritems.	No
status	tekenreeks	De status van de evaluatieuitvoering.	Ja

OpenAI.EvalRunDataContentSource

Discriminator voor OpenAI.EvalRunDataContentSource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`file_id`	OpenAI.EvalRunFileIdDataContentSource
`stored_completions`	OpenAI.EvalRunStoredCompletionsDataContentSource
`responses`	OpenAI.EvalRunResponsesDataContentSource

Naam	Type	Description	Required	Default
type	OpenAI.EvalRunDataContentSourceType		Ja

OpenAI.EvalRunDataContentSourceType

Property	Value
Typ	tekenreeks
waarden	`file_id` `file_content` `stored_completions` `responses`

OpenAI.EvalRunDataSourceCompletionsResource

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `completions`	Ja

OpenAI.EvalRunDataSourceJsonlResource

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `jsonl`	Ja

OpenAI.EvalRunDataSourceParams

Discriminator voor OpenAI.EvalRunDataSourceParams

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`jsonl`	OpenAI.EvalJsonlRunDataSourceParams
`completions`	OpenAI.EvalCompletionsRunDataSourceParams
`responses`	OpenAI.EvalResponsesRunDataSourceParams

Naam	Type	Description	Required	Default
type	OpenAI.EvalRunDataSourceType		Ja

OpenAI.EvalRunDataSourceResource

Naam	Type	Description	Required	Default
type	OpenAI.EvalRunDataSourceType		Ja

OpenAI.EvaluatieRunGegevensbronAntwoordenResource

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `responses`	Ja

OpenAI.EvalRunDataSourceType

Property	Value
Typ	tekenreeks
waarden	`jsonl` `completions` `responses`

OpenAI.EvalRunFileContentDataContentSource

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud van het jsonl-bestand.	Ja
type	enum	Het type jsonl-bron. Altijd `file_content`. Mogelijke waarden: `file_content`	Ja

OpenAI.EvalRunFileIdDataContentSource

Naam	Type	Description	Required	Default
identiteitskaart	tekenreeks	De id van het bestand.	Ja
type	enum	Het type jsonl-bron. Altijd `file_id`. Mogelijke waarden: `file_id`	Ja

OpenAI.EvalRunList

Een object dat een lijst met uitvoeringen voor een evaluatie vertegenwoordigt.

Naam	Type	Description	Required
Gegevens	gegevensreeks	Een matrix met evaluatie-uitvoeringsobjecten.	Ja
first_id	tekenreeks	De id van de eerste evaluatieuitvoering in de gegevensmatrix.	Ja
heeft_meer	boolean	Geeft aan of er meer evaluaties beschikbaar zijn.	Ja
last_id	tekenreeks	De id van de laatste evaluatieuitvoering in de gegevensmatrix.	Ja
Object	enum	Het type van dit object. Deze is altijd ingesteld op 'list'. Mogelijke waarden: `list`	Ja

OpenAI.EvalRunOutputItem

Een schema dat een uitvoeritem voor de evaluatieuitvoering vertegenwoordigt.

Naam	Type	Description	Required
aangemaakt_op	integer	Unix-tijdstempel (in seconden) wanneer de evaluatieuitvoering is gemaakt.	Ja
gegevensbron_item	Object	Details van het invoergegevensbronitem.	Ja
gegevensbron_item_id	integer	De id voor het gegevensbronitem.	Ja
eval_id	tekenreeks	De id van de evaluatiegroep.	Ja
identiteitskaart	tekenreeks	Unieke id voor het uitvoeritem van de evaluatieuitvoering.	Ja
Object	enum	Het type object. Altijd 'eval.run.output_item'. Mogelijke waarden: `eval.run.output_item`	Ja
results	gegevensreeks	Een lijst met resultaten uit de evaluatieuitvoering.	Ja
run_id	tekenreeks	De id van de evaluatieuitvoering die is gekoppeld aan dit uitvoeritem.	Ja
voorbeeld	Object	Een voorbeeld met de invoer en uitvoer van de evaluatieuitvoering.	Ja
└─ fout	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	No
└finish_reason	tekenreeks	De reden waarom de voorbeeldgeneratie is voltooid.	No
└input.	gegevensreeks	Een matrix met invoerberichten.	No
└max_completion_tokens	integer	Het maximum aantal tokens dat is toegestaan voor voltooiing.	No
└model.	tekenreeks	Het model dat wordt gebruikt voor het genereren van het voorbeeld.	No
└─ uitvoer	gegevensreeks	Een matrix met uitvoerberichten.	No
└─ zaad	integer	Het zaad dat wordt gebruikt voor het genereren van het voorbeeld.	No
└─ temperatuur	number	De gebruikte steekproeftemperatuur.	No
└top_p	number	De top_p waarde die wordt gebruikt voor steekproeven.	No
└─ gebruik	Object	Gebruiksgegevens voor token voor het voorbeeld.	No
└ cached_tokens	integer	Het aantal tokens dat is opgehaald uit de cache.	No
└completion_tokens	integer	Het aantal voltooiingstokens dat is gegenereerd.	No
└prompt_tokens	integer	Het aantal prompttokens dat wordt gebruikt.	No
└ totaal tokens	integer	Het totale aantal gebruikte tokens.	No
status	tekenreeks	De status van de evaluatieuitvoering.	Ja

OpenAI.EvalRunOutputItemList

Een object dat een lijst met uitvoeritems vertegenwoordigt voor een evaluatieuitvoering.

Naam	Type	Description	Required
Gegevens	gegevensreeks	Een matrix met uitvoeritemobjecten voor het uitvoeren van een evaluatierun.	Ja
first_id	tekenreeks	De id van het eerste uitvoeritem voor het uitvoeren van een evaluatie in de gegevensmatrix.	Ja
heeft_meer	boolean	Hiermee wordt aangegeven of er meer uitvoeritems voor de evaluatieuitvoering beschikbaar zijn.	Ja
last_id	tekenreeks	De id van het uitvoeritem voor de laatste evaluatieuitvoering in de gegevensmatrix.	Ja
Object	enum	Het type van dit object. Deze is altijd ingesteld op 'list'. Mogelijke waarden: `list`	Ja

OpenAI.EvalRunResponsesDataContentSource

Een EvalResponsesSource-object met een beschrijving van de configuratie van een uitvoeringsgegevensbron.

Naam	Type	Description	Required
aangemaakt_na	integer	Alleen items opnemen die na deze tijdstempel (inclusief) zijn gemaakt. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
gemaakt_voor	integer	Alleen items opnemen die vóór deze tijdstempel (inclusief) zijn gemaakt. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
instructies_zoeken	tekenreeks	Optionele tekenreeks om het veld 'instructies' te doorzoeken. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
model	tekenreeks	De naam van het model waarvoor antwoorden moeten worden gezocht. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
inspanning bij redeneren	Object	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
Temperatuur	number	Temperatuur van de bemonstering. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
tools	gegevensreeks	Lijst met namen van hulpprogramma's. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
top_p	number	Kernsamplingparameter. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
type	enum	Het type gegevensbron uitvoeren. Altijd `responses`. Mogelijke waarden: `responses`	Ja
users	gegevensreeks	Lijst met gebruikers-id's. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No

OpenAI.EvalRunStoredCompletionsDataContentSource

Een StoredCompletionsRunDataSource-configuratie die een set filters beschrijft

Naam	Type	Description	Required
aangemaakt_na	integer	Een optionele Unix-tijdstempel voor het filteren van items die na deze tijd zijn gemaakt.	No
gemaakt_voor	integer	Een optionele Unix-tijdstempel voor het filteren van items die vóór deze tijd zijn gemaakt.	No
limit	integer	Een optioneel maximum aantal te retourneren items.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
model	tekenreeks	Een optioneel model om op te filteren (bijvoorbeeld 'gpt-4o').	No
type	enum	Het type bron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	Ja

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Afgeschaft ten gunste van LogsDataSourceConfig.

Naam	Type	Description	Required	Default
metadata	Object	Metagegevensfilters voor de opgeslagen voltooiingsgegevensbron.	No
type	enum	Het type gegevensbron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	Ja

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Afgeschaft ten gunste van LogsDataSourceConfig.

Naam	Type	Description	Required
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
schema	Object	Het json-schema voor de gegevensbronitems uitvoeren. Leer hier hoe u JSON-schema's bouwt.	Ja
type	enum	Het type gegevensbron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	Ja

OpenAI.FileSearchTool

Een hulpprogramma waarmee wordt gezocht naar relevante inhoud uit geüploade bestanden.

Naam	Type	Description	Required
filters	Object		No
max_aantal_resultaten	integer	Het maximum aantal resultaten dat moet worden geretourneerd. Dit getal moet tussen 1 en 50 liggen.	No
rangschikkingsopties	Object		No
Rangschikker	enum	De ranker die moet worden gebruikt voor het zoeken naar bestanden. Mogelijke waarden: `auto`, `default-2024-11-15`	No
└score_threshold	number	De scoredrempel voor het zoeken naar bestanden, een getal tussen 0 en 1. Getallen dichter bij 1 proberen alleen de meest relevante resultaten te retourneren, maar kunnen minder resultaten opleveren.	No
type	enum	Het type zoekprogramma voor bestanden. Altijd `file_search`. Mogelijke waarden: `file_search`	Ja
vector_store_ids	gegevensreeks	De id's van de vectorarchieven om te zoeken.	Ja

OpenAI.FileSearchToolCallItemParam

De resultaten van een aanroep van een zoekprogramma voor bestanden.

Naam	Type	Description	Required
queries	gegevensreeks	De query's die worden gebruikt om te zoeken naar bestanden.	Ja
results	gegevensreeks	De resultaten van de aanroep van het zoekprogramma voor bestanden.	No
type	enum	Mogelijke waarden: `file_search_call`	Ja

OpenAI.FileSearchToolCallItemResource

De resultaten van een aanroep van een zoekprogramma voor bestanden.

Naam	Type	Description	Required
queries	gegevensreeks	De query's die worden gebruikt om te zoeken naar bestanden.	Ja
results	gegevensreeks	De resultaten van de aanroep van het zoekprogramma voor bestanden.	No
status	enum	De status van de aanroep van het zoekprogramma voor bestanden. Een van `in_progress`, `searching`of `incompletefailed`. Mogelijke waarden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Mogelijke waarden: `file_search_call`	Ja

OpenAI.Filters

Naam	Type	Description	Required
filters	gegevensreeks	Matrix van filters die moeten worden gecombineerd. Items kunnen `ComparisonFilter` of `CompoundFilter`.	Ja
sleutel	tekenreeks	De sleutel die moet worden vergeleken met de waarde.	Ja
type	enum	Type bewerking: `and` of `or`. Mogelijke waarden: `and`, `or`	Ja
value	tekenreeks of getal of booleaanse waarde	De waarde die moet worden vergeleken met de kenmerksleutel; ondersteunt tekenreeks-, getal- of booleaanse typen.	Ja

OpenAI.FineTuneDPOHyperparameters

De hyperparameters die worden gebruikt voor de taak voor het afstemmen van de DPO.

Naam	Type	Description	Required
batchgrootte	enum	Mogelijke waarden: `auto`	No
bèta	enum	Mogelijke waarden: `auto`	No
leerverhouding-vermenigvuldiger	enum	Mogelijke waarden: `auto`	No
aantal tijdperken	enum	Mogelijke waarden: `auto`	No

OpenAI.FineTuneDPOMethod

Configuratie voor de methode voor het afstemmen van de DPO.

Naam	Type	Description	Required	Default
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuneDPOHyperparameters	De hyperparameters die worden gebruikt voor de taak voor het afstemmen van de DPO.	No

OpenAI.FineTuneMethod

De methode die wordt gebruikt voor het afstemmen.

Naam	Type	Description	Required
dpo	OpenAI.FineTuneDPOMethod	Configuratie voor de methode voor het afstemmen van de DPO.	No
versterking	AzureFineTuneReinforcementMethod		No
Gemonitord	OpenAI.FineTuneSupervisedMethod	Configuratie voor de afstemmingsmethode onder supervisie.	No
type	enum	Het type methode. `supervised`Is , `dpo`of `reinforcement`. Mogelijke waarden: `supervised`, `dporeinforcement`	Ja

OpenAI.FineTuneReinforcementHyperparameters

De hyperparameters die worden gebruikt voor de versterkingsafstemmingstaak.

Naam	Type	Description	Required
batchgrootte	enum	Mogelijke waarden: `auto`	No
compute_multiplier	enum	Mogelijke waarden: `auto`	No
eval_interval	enum	Mogelijke waarden: `auto`	No
evaluatievoorbeelden	enum	Mogelijke waarden: `auto`	No
leerverhouding-vermenigvuldiger	enum	Mogelijke waarden: `auto`	No
aantal tijdperken	enum	Mogelijke waarden: `auto`	No
inspanning bij redeneren	enum	Niveau van redeneringsinspanning. Mogelijke waarden: `default`, `low`, , `mediumhigh`	No

OpenAI.FineTuneSupervisedHyperparameters

De hyperparameters die worden gebruikt voor de afstemmingstaak.

Naam	Type	Description	Required
batchgrootte	enum	Mogelijke waarden: `auto`	No
leerverhouding-vermenigvuldiger	enum	Mogelijke waarden: `auto`	No
aantal tijdperken	enum	Mogelijke waarden: `auto`	No

OpenAI.FineTuneSupervisedMethod

Configuratie voor de afstemmingsmethode onder supervisie.

Naam	Type	Description	Required	Default
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuneSupervisedHyperparameters	De hyperparameters die worden gebruikt voor de afstemmingstaak.	No

OpenAI.FineTuningIntegration

Discriminator voor OpenAI.FineTuningIntegration

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

Naam	Type	Description	Required	Default
type	tekenreeks (zie geldige modellen hieronder)		Ja

OpenAI.FineTuningIntegrationWandb

Naam	Type	Description	Required
type	enum	Het type integratie dat wordt ingeschakeld voor de taak voor het afstemmen van de taak. Mogelijke waarden: `wandb`	Ja
wandb	Object	De instellingen voor uw integratie met Gewichten en Vooroordelen. Met deze nettolading wordt het project opgegeven waarnaar metrische gegevens worden verzonden. U kunt desgewenst een expliciete weergavenaam instellen voor uw uitvoering, tags toevoegen aan uw uitvoering en een standaardentiteit (team, gebruikersnaam, enzovoort) instellen die aan uw uitvoering moet worden gekoppeld.	Ja
└─ Entiteit	tekenreeks	De entiteit die moet worden gebruikt voor de uitvoering. Hiermee kunt u het team of de gebruikersnaam instellen van de WandB-gebruiker die u aan de uitvoering wilt koppelen. Als deze niet is ingesteld, wordt de standaardentiteit voor de geregistreerde WandB API-sleutel gebruikt.	No
└─naam	tekenreeks	Een weergavenaam die moet worden ingesteld voor de uitvoering. Als deze niet is ingesteld, gebruiken we de taak-id als de naam.	No
└─project	tekenreeks	De naam van het project waaronder de nieuwe uitvoering wordt gemaakt.	No
└tags.	gegevensreeks	Een lijst met tags die moeten worden gekoppeld aan de zojuist gemaakte uitvoering. Deze tags worden rechtstreeks doorgegeven aan WandB. Sommige standaardtags worden gegenereerd door OpenAI: 'openai/finetune', 'openai/{base-model}', 'openai/{ftjob-abcdef}'.	No

OpenAI.FineTuningJob

Het fine_tuning.job object vertegenwoordigt een verfijningstaak die is gemaakt via de API.

Naam	Type	Description	Required
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen is gemaakt.	Ja
error	Object	Voor het afstemmen van taken die deze hebben `failed`, bevat dit meer informatie over de oorzaak van de fout.	Ja
└* code	tekenreeks	Een machineleesbare foutcode.	No
└• bericht	tekenreeks	Een door mensen leesbaar foutbericht.	No
└* param	tekenreeks	De parameter die ongeldig was, meestal `training_file` of `validation_file`. Dit veld is null als de fout niet parameterspecifiek is.	No
geschatte voltooiing	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen wordt geschat. De waarde is null als de taak voor het afstemmen niet wordt uitgevoerd.	No
fine_tuned_model	tekenreeks	De naam van het nauwkeurig afgestemde model dat wordt gemaakt. De waarde is null als de taak voor het afstemmen nog steeds wordt uitgevoerd.	Ja
afgerond_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen is voltooid. De waarde is null als de taak voor het afstemmen nog steeds wordt uitgevoerd.	Ja
hyperparameters (instellingen die een model beïnvloeden)	Object	De hyperparameters die worden gebruikt voor de afstemmingstaak. Deze waarde wordt alleen geretourneerd bij het uitvoeren `supervised` van taken.	Ja
└ batch_size	enum	Mogelijke waarden: `auto`	No
└learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
└n_epochs	enum	Mogelijke waarden: `auto`	No
identiteitskaart	tekenreeks	De object-id waarnaar kan worden verwezen in de API-eindpunten.	Ja
integraties	gegevensreeks	Een lijst met integraties om deze taak voor afstemming mogelijk te maken.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	tekenreeks	Het basismodel dat wordt afgestemd.	Ja
Object	enum	Het objecttype, dat altijd fine_tuning.job is. Mogelijke waarden: `fine_tuning.job`	Ja
organisatie_id	tekenreeks	De organisatie die eigenaar is van de afstemmingstaak.	Ja
resultaat_bestanden	gegevensreeks	De gecompileerde resultatenbestands-id('s) voor de taak voor het afstemmen. U kunt de resultaten ophalen met de Files-API.	Ja
seed	integer	Het zaad dat wordt gebruikt voor de verfijningstaak.	Ja
status	enum	De huidige status van de taak voor het afstemmen, die kan zijn`validating_files`: , `queuedrunning`, `succeeded`, of `failedcancelled`. Mogelijke waarden: `validating_files`, `queued`, `running`, `succeeded`, , `failedcancelled`	Ja
trained_tokens	integer	Het totale aantal factureerbare tokens dat door deze afstemmingstaak wordt verwerkt. De waarde is null als de taak voor het afstemmen nog steeds wordt uitgevoerd.	Ja
training_file	tekenreeks	De bestands-id die wordt gebruikt voor de training. U kunt de trainingsgegevens ophalen met de Files-API.	Ja
user_provided_suffix	tekenreeks	Het beschrijvende achtervoegsel dat is toegepast op de taak, zoals opgegeven in de aanvraag voor het maken van de taak.	No
validatiebestand	tekenreeks	De bestands-id die wordt gebruikt voor validatie. U kunt de validatieresultaten ophalen met de Files-API.	Ja

OpenAI.FineTuningJobCheckpoint

Het fine_tuning.job.checkpoint object vertegenwoordigt een modelcontrolepunt voor een taak die klaar is voor gebruik.

Naam	Type	Description	Required
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer het controlepunt is gemaakt.	Ja
fine_tuned_model_checkpoint (fijn-afgestelde modelcontrolenpunt)	tekenreeks	De naam van het nauwkeurig afgestemde controlepuntmodel dat wordt gemaakt.	Ja
fine_tuning_job_id	tekenreeks	De naam van de taak voor het afstemmen waarvan dit controlepunt is gemaakt.	Ja
identiteitskaart	tekenreeks	De controlepunt-id waarnaar kan worden verwezen in de API-eindpunten.	Ja
metrics	Object	Metrische gegevens op het stapnummer tijdens de taak voor het afstemmen.	Ja
└full_valid_loss	number		No
└full_valid_mean_token_accuracy	number		No
└stap.	number		No
└train_loss	number		No
└train_mean_token_accuracy	number		No
└valid_loss	number		No
└─ geldige_gemiddelde_token_nauwkeurigheid	number		No
Object	enum	Het objecttype, dat altijd 'fine_tuning.job.checkpoint' is. Mogelijke waarden: `fine_tuning.job.checkpoint`	Ja
stap_nummer	integer	Het stapnummer waarop het controlepunt is gemaakt.	Ja

OpenAI.FineTuningJobEvent

Taakgebeurtenisobject verfijnen

Naam	Type	Description	Required
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen is gemaakt.	Ja
Gegevens		De gegevens die aan de gebeurtenis zijn gekoppeld.	No
identiteitskaart	tekenreeks	De object-id.	Ja
level	enum	Het logboekniveau van de gebeurtenis. Mogelijke waarden: `info`, `warnerror`	Ja
message	tekenreeks	Het bericht van de gebeurtenis.	Ja
Object	enum	Het objecttype, dat altijd fine_tuning.job.event is. Mogelijke waarden: `fine_tuning.job.event`	Ja
type	enum	Het type gebeurtenis. Mogelijke waarden: `message`, `metrics`	No

OpenAI.FunctionObject

Naam	Type	Description	Required	Default
description	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.	Ja
parameters		De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	No
streng	boolean	Of u strikte schema-naleving wilt inschakelen bij het genereren van de functieaanroep. Als dit is ingesteld op true, volgt het model het exacte schema dat in het `parameters` veld is gedefinieerd. Alleen een subset van het JSON-schema wordt ondersteund wanneer `strict` dit is `true`.	No	Onwaar

OpenAI.FunctionTool

Definieert een functie in uw eigen code die het model kan aanroepen.

Naam	Type	Description	Required
description	tekenreeks	Een beschrijving van de functie. Wordt door het model gebruikt om te bepalen of de functie al dan niet moet worden aangeroepen.	No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Ja
parameters		Een JSON-schemaobject dat de parameters van de functie beschrijft.	Ja
streng	boolean	Of u strikte parametervalidatie wilt afdwingen. Standaard `true`.	Ja
type	enum	Het type functiehulpmiddel. Altijd `function`. Mogelijke waarden: `function`	Ja

OpenAI.FunctionToolCallItemParam

Een aanroep van een hulpprogramma om een functie uit te voeren.

Naam	Type	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Ja
call_id	tekenreeks	De unieke id van de aanroep van het functiehulpprogramma die door het model is gegenereerd.	Ja
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Ja
type	enum	Mogelijke waarden: `function_call`	Ja

OpenAI.FunctionToolCallItemResource

Een aanroep van een hulpprogramma om een functie uit te voeren.

Naam	Type	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Ja
call_id	tekenreeks	De unieke id van de aanroep van het functiehulpprogramma die door het model is gegenereerd.	Ja
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Ja
status	enum	De status van het item. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Mogelijke waarden: `function_call`	Ja

OpenAI.FunctionToolCallOutputItemParam

De uitvoer van een functiehulpmiddeloproep.

Naam	Type	Description	Required
call_id	tekenreeks	De unieke id van de aanroep van het functiehulpprogramma die door het model is gegenereerd.	Ja
uitvoer	tekenreeks	Een JSON-tekenreeks van de uitvoer van de functietool-aanroep.	Ja
type	enum	Mogelijke waarden: `function_call_output`	Ja

OpenAI.FunctionToolCallOutputItemResource

De uitvoer van een functiehulpmiddeloproep.

Naam	Type	Description	Required
call_id	tekenreeks	De unieke id van de aanroep van het functiehulpprogramma die door het model is gegenereerd.	Ja
uitvoer	tekenreeks	Een JSON-tekenreeks van de uitvoer van de functietool-aanroep.	Ja
status	enum	De status van het item. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Mogelijke waarden: `function_call_output`	Ja

OpenAI.Grader

Discriminator voor OpenAI.Grader

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`label_model`	OpenAI.GraderLabelModel
`text_similarity`	OpenAI.GraderTextSimilarity
`python`	OpenAI.GraderPython
`score_model`	OpenAI.GraderScoreModel
`multi`	OpenAI.GraderMulti

Naam	Type	Description	Required	Default
type	OpenAI.GraderType		Ja

OpenAI.GraderLabelModel

Een LabelModelGrader-object dat gebruikmaakt van een model om labels toe te wijzen aan elk item in de evaluatie.

Naam	Type	Description	Required
Invoer	gegevensreeks		Ja
labels	gegevensreeks	De labels die aan elk item in de evaluatie moeten worden toegewezen.	Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
doorgeven_labels	gegevensreeks	De labels die een doorgevend resultaat aangeven. Moet een subset van labels zijn.	Ja
type	enum	Het objecttype, dat altijd `label_model`is. Mogelijke waarden: `label_model`	Ja

OpenAI.GraderMulti

Een MultiGrader-object combineert de uitvoer van meerdere graders om één score te produceren.

Naam	Type	Description	Required
bereken_uitvoer	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	Ja
Klassers	Object		Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
type	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	Ja

OpenAI.GraderPython

Een PythonGrader-object dat een Python-script uitvoert op de invoer.

Naam	Type	Description	Required
image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
naam	tekenreeks	De naam van de cijferaar.	Ja
source	tekenreeks	De broncode van het Python-script.	Ja
type	enum	Het objecttype, dat altijd `python`is. Mogelijke waarden: `python`	Ja

OpenAI.GraderScoreModel

Een ScoreModelGrader-object dat gebruikmaakt van een model om een score toe te wijzen aan de invoer.

Naam	Type	Description	Required
Invoer	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
range	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
sampling_params		De steekproefparameters voor het model.	No
type	enum	Het objecttype, dat altijd `score_model`is. Mogelijke waarden: `score_model`	Ja

OpenAI.GraderStringCheck

Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.

Naam	Type	Description	Required
Invoer	tekenreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
operatie	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	Ja
referentie	tekenreeks	De verwijzingstekst. Dit kunnen sjabloontekenreeksen zijn.	Ja
type	enum	Het objecttype, dat altijd `string_check`is. Mogelijke waarden: `string_check`	Ja

OpenAI.GraderTextSimilarity

Een TextSimilarityGrader-object waarmee tekst wordt beoordeeld op basis van metrische overeenkomsten.

Naam	Type	Description	Required
evaluatiemaatstaf	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	Ja
Invoer	tekenreeks	De tekst die wordt beoordeeld.	Ja
naam	tekenreeks	De naam van de cijferaar.	Ja
referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	Ja
type	enum	Het type cijfer. Mogelijke waarden: `text_similarity`	Ja

OpenAI.GraderType

Property	Value
Typ	tekenreeks
waarden	`string_check` `text_similarity` `score_model` `label_model` `python` `multi`

OpenAI.ImageGenTool

Een hulpprogramma waarmee afbeeldingen worden gegenereerd met behulp van een model zoals gpt-image-1.5.

Naam	Type	Description	Required	Default
achtergrond	enum	ALLEEN GPT-image-1: achtergrondtype voor de gegenereerde afbeelding. Een van `transparent`, `opaque`of `auto`. Standaard: `auto`. Mogelijke waarden: `transparent`, `opaqueauto`	No
invoer_afbeelding_masker	Object	Optioneel masker voor inpainting. Bevat `image_url` (tekenreeks, optioneel) en `file_id` (tekenreeks, optioneel).	No
└─file_id	tekenreeks	Bestands-id voor de maskerafbeelding.	No
└─image_url	tekenreeks	Afbeelding van het met Base64 gecodeerde masker.	No
model	enum	Het model voor het genereren van afbeeldingen dat moet worden gebruikt. Standaard: `gpt-image-1`. Mogelijke waarden: `gpt-image-1`, `gpt-image-1.5gpt-image-2`	No
moderation	enum	Beheerniveau voor de gegenereerde installatiekopieën. Standaard: `auto`. Mogelijke waarden: `auto`, `low`	No
uitvoercompressie	integer	Compressieniveau voor de uitvoerafbeelding. Standaard: 100.	No	100
uitvoerformaat	enum	De uitvoerindeling van de gegenereerde afbeelding. Een van `png`, `webp`of `jpeg`. Standaard: `png`. Mogelijke waarden: `png`, `webpjpeg`	No
gedeeltelijke_afbeeldingen	integer	Aantal gedeeltelijke afbeeldingen dat moet worden gegenereerd in de streamingmodus, van 0 (standaardwaarde) tot 3.	No	0
kwaliteit	enum	De kwaliteit van de gegenereerde afbeelding. Een van`low`, `medium`, of `highauto`. Standaard: `auto`. Mogelijke waarden: `low`, `medium`, , `highauto`	No
size	enum	De grootte van de gegenereerde installatiekopieën. Een van`1024x1024`, `1024x1536`, of `1536x1024auto`. Standaard: `auto`. Mogelijke waarden: `1024x1024`, `1024x1536`, , `1536x1024auto`	No
type	enum	Het type hulpprogramma voor het genereren van installatiekopieën. Altijd `image_generation`. Mogelijke waarden: `image_generation`	Ja

OpenAI.ImageGenToolCallItemParam

Een aanvraag voor het genereren van afbeeldingen door het model.

Naam	Type	Description	Required	Default
result	tekenreeks	De gegenereerde installatiekopieën die zijn gecodeerd in base64.	Ja
type	enum	Mogelijke waarden: `image_generation_call`	Ja

OpenAI.ImageGenToolCallItemResource

Een aanvraag voor het genereren van afbeeldingen door het model.

Naam	Type	Description	Required
result	tekenreeks	De gegenereerde installatiekopieën die zijn gecodeerd in base64.	Ja
status	enum	Mogelijke waarden: `in_progress`, `completed`, , `generatingfailed`	Ja
type	enum	Mogelijke waarden: `image_generation_call`	Ja

OpenAI.ImplicitUserMessage

Naam	Type	Description	Required	Default
inhoud	tekenreeks of matrix		Ja

OpenAI.Includable

Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn:

code_interpreter_call.outputs: Bevat de uitvoer van de uitvoering van Python-code in het code-interpreter-hulpprogramma aanroepitems.
computer_call_output.output.image_url: Neem afbeeldings-URL's op uit de uitvoer van de computeroproep.
file_search_call.results: Neem de zoekresultaten van de aanroep van het zoekprogramma voor bestanden op.
message.input_image.image_url: Neem afbeeldings-URL's op uit het invoerbericht.
message.output_text.logprobs: Neem logprobs op met assistentberichten.
reasoning.encrypted_content: Bevat een versleutelde versie van redeneringstokens in itemuitvoer met redenering. Hierdoor kunnen redeneringsitems worden gebruikt in gesprekken met meerdere paden wanneer de antwoorden-API staatloos wordt gebruikt (zoals wanneer de store parameter is ingesteld falseop, of wanneer een organisatie is ingeschreven in het retentieprogramma voor gegevens nul).

Property	Value
Description	Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn: - `code_interpreter_call.outputs`: Bevat de uitvoer van de uitvoering van Python-code in het code-interpreter-hulpprogramma aanroepitems. - `computer_call_output.output.image_url`: Neem afbeeldings-URL's op uit de uitvoer van de computeroproep. - `file_search_call.results`: Neem de zoekresultaten van de aanroep van het zoekprogramma voor bestanden op. - `message.input_image.image_url`: Neem afbeeldings-URL's op uit het invoerbericht. - `message.output_text.logprobs`: Neem logprobs op met assistentberichten. - `reasoning.encrypted_content`: Bevat een versleutelde versie van redeneringstokens in itemuitvoer met redenering. Hierdoor kunnen redeneringsitems worden gebruikt in gesprekken met meerdere paden wanneer de antwoorden-API staatloos wordt gebruikt (zoals wanneer de `store` parameter is ingesteld `false`op, of wanneer een organisatie is ingeschreven in het retentieprogramma voor gegevens nul).
Typ	tekenreeks
waarden	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content`

OpenAI.ItemContent

Discriminator voor OpenAI.ItemContent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

Naam	Type	Description	Required	Default
type	OpenAI.ItemContentType	Multimodale invoer- en uitvoerinhoud.	Ja

OpenAI.ItemContentInputAudio

Een audio-invoer voor het model.

Naam	Type	Description	Required
Gegevens	tekenreeks	Met Base64 gecodeerde audiogegevens.	Ja
format	enum	De indeling van de audiogegevens. Momenteel ondersteunde indelingen zijn `mp3` en `wav`. Mogelijke waarden: `mp3`, `wav`	Ja
type	enum	Het type invoeritem. Altijd `input_audio`. Mogelijke waarden: `input_audio`	Ja

OpenAI.ItemContentInputFile

Een bestandsinvoer voor het model.

Naam	Type	Description	Required
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks	De id van het bestand dat naar het model moet worden verzonden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd `input_file`. Mogelijke waarden: `input_file`	Ja

OpenAI.ItemContentInputImage

Een afbeeldingsinvoer voor het model.

Naam	Type	Description	Required
detail	enum	Het detailniveau van de afbeelding die naar het model moet worden verzonden. Een van `high`, `low`of `auto`. Standaard ingesteld op `auto`. Mogelijke waarden: `low`, `highauto`	No
file_id	tekenreeks	De id van het bestand dat naar het model moet worden verzonden.	No
image_url	tekenreeks	De URL van de afbeelding die naar het model moet worden verzonden. Een volledig gekwalificeerde URL of base64-gecodeerde afbeelding in een gegevens-URL.	No
type	enum	Het type invoeritem. Altijd `input_image`. Mogelijke waarden: `input_image`	Ja

OpenAI.ItemContentInputText

Een tekstinvoer voor het model.

Naam	Type	Description	Required	Default
tekst	tekenreeks	De tekstinvoer voor het model.	Ja
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Ja

OpenAI.ItemContentOutputAudio

Een audio-uitvoer van het model.

Naam	Type	Description	Required
Gegevens	tekenreeks	Met Base64 gecodeerde audiogegevens uit het model.	Ja
transcript	tekenreeks	Het transcript van de audiogegevens van het model.	Ja
type	enum	Het type uitvoeraudio. Altijd `output_audio`. Mogelijke waarden: `output_audio`	Ja

OpenAI.ItemContentOutputText

Een tekstuitvoer van het model.

Naam	Type	Description	Required
annotations	gegevensreeks	De aantekeningen van de tekstuitvoer.	Ja
logprobs	gegevensreeks		No
tekst	tekenreeks	De tekstuitvoer van het model.	Ja
type	enum	Het type uitvoertekst. Altijd `output_text`. Mogelijke waarden: `output_text`	Ja

OpenAI.ItemContentRefusal

Een weigering van het model.

Naam	Type	Description	Required	Default
weigering	tekenreeks	De weigeringsverklaring van het model.	Ja
type	enum	Het type weigering. Altijd `refusal`. Mogelijke waarden: `refusal`	Ja

OpenAI.ItemContentType

Multimodale invoer- en uitvoerinhoud.

Property	Value
Description	Multimodale invoer- en uitvoerinhoud.
Typ	tekenreeks
waarden	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

Inhoudsitem dat wordt gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.ItemParam

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`local_shell_call`	OpenAI.LocalShellToolCallItemParam
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam
`message`	OpenAI.ResponsesMessageItemParam

Naam	Type	Description	Required	Default
type	OpenAI.ItemType		Ja

OpenAI.ItemReferenceItemParam

Een interne id voor een item waarnaar moet worden verwezen.

Naam	Type	Description	Required	Default
identiteitskaart	tekenreeks	De service-id van het eerder gegenereerde antwoorditem waarnaar wordt verwezen.	Ja
type	enum	Mogelijke waarden: `item_reference`	Ja

OpenAI.ItemResource

Inhoudsitem dat wordt gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.ItemResource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`local_shell_call`	OpenAI.LocalShellToolCallItemResource
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`mcp_call`	OpenAI.MCPCallItemResource
`message`	OpenAI.ResponsesMessageItemResource

Naam	Type	Description	Required	Default
identiteitskaart	tekenreeks		Ja
type	OpenAI.ItemType		Ja

OpenAI.ItemType

Property	Value
Typ	tekenreeks
waarden	`message` `file_search_call` `function_call` `function_call_output` `computer_call` `computer_call_output` `web_search_call` `reasoning` `item_reference` `image_generation_call` `code_interpreter_call` `local_shell_call` `local_shell_call_output` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.ListFineTuningJobCheckpointsResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks		Ja
first_id	tekenreeks		No
heeft_meer	boolean		Ja
last_id	tekenreeks		No
Object	enum	Mogelijke waarden: `list`	Ja

OpenAI.ListFineTuningJobEventsResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks		Ja
heeft_meer	boolean		Ja
Object	enum	Mogelijke waarden: `list`	Ja

OpenAI.ListModelsResponse

Naam	Type	Description	Required	Default
Gegevens	gegevensreeks		Ja
Object	enum	Mogelijke waarden: `list`	Ja

OpenAI.ListPaginatedFineTuningJobsResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks		Ja
heeft_meer	boolean		Ja
Object	enum	Mogelijke waarden: `list`	Ja

OpenAI.ListVectorStoreFilesFilter

Property	Value
Typ	tekenreeks
waarden	`in_progress` `completed` `failed` `cancelled`

OpenAI.ListVectorStoreFilesResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks		Ja
first_id	tekenreeks		Ja
heeft_meer	boolean		Ja
last_id	tekenreeks		Ja
Object	enum	Mogelijke waarden: `list`	Ja

OpenAI.ListVectorStoresResponse

Naam	Type	Description	Required
Gegevens	gegevensreeks		Ja
first_id	tekenreeks		Ja
heeft_meer	boolean		Ja
last_id	tekenreeks		Ja
Object	enum	Mogelijke waarden: `list`	Ja

OpenAI.LocalShellExecAction

Voer een shell-opdracht uit op de server.

Naam	Type	Description	Required
command	gegevensreeks	De opdracht die moet worden uitgevoerd.	Ja
Env	Object	Omgevingsvariabelen die moeten worden ingesteld voor de opdracht.	Ja
timeout_ms (milliseconden)	integer	Optionele time-out in milliseconden voor de opdracht.	No
type	enum	Het type lokale shell-actie. Altijd `exec`. Mogelijke waarden: `exec`	Ja
user	tekenreeks	Optionele gebruiker om de opdracht uit te voeren als.	No
working_directory	tekenreeks	Optionele werkmap waarin de opdracht moet worden uitgevoerd.	No

OpenAI.LocalShellTool

Een hulpprogramma waarmee het model shell-opdrachten kan uitvoeren in een lokale omgeving.

Naam	Type	Description	Required	Default
type	enum	Het type van het lokale shell-hulpprogramma. Altijd `local_shell`. Mogelijke waarden: `local_shell`	Ja

OpenAI.LocalShellToolCallItemParam

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Naam	Type	Description	Required
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Ja
call_id	tekenreeks	De unieke id van de aanroep van het lokale shell-hulpprogramma die door het model is gegenereerd.	Ja
type	enum	Mogelijke waarden: `local_shell_call`	Ja

OpenAI.LocalShellToolCallItemResource

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Naam	Type	Description	Required
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Ja
call_id	tekenreeks	De unieke id van de aanroep van het lokale shell-hulpprogramma die door het model is gegenereerd.	Ja
status	enum	Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Mogelijke waarden: `local_shell_call`	Ja

OpenAI.LocalShellToolCallOutputItemParam

De uitvoer van een lokale shell tool aanroep.

Naam	Type	Description	Required	Default
uitvoer	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Ja
type	enum	Mogelijke waarden: `local_shell_call_output`	Ja

OpenAI.LocalShellToolCallOutputItemResource

De uitvoer van een lokale shell tool aanroep.

Naam	Type	Description	Required
uitvoer	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Ja
status	enum	Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Mogelijke waarden: `local_shell_call_output`	Ja

OpenAI.Location

Discriminator voor OpenAI.Location

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`approximate`	OpenAI.ApproximateLocation

Naam	Type	Description	Required	Default
type	OpenAI.LocationType		Ja

OpenAI.LocationType

Property	Value
Typ	tekenreeks
waarden	`approximate`

OpenAI.LogProb

De logboekkans van een token.

Naam	Type	Required
bytes	gegevensreeks	Ja
logprob	number	Ja
token	tekenreeks	Ja
top_logprobs	gegevensreeks	Ja

OpenAI.MCPApprovalRequestItemParam

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Naam	Type	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Ja
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Ja
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Ja
type	enum	Mogelijke waarden: `mcp_approval_request`	Ja

OpenAI.MCPApprovalRequestItemResource

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Naam	Type	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Ja
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Ja
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Ja
type	enum	Mogelijke waarden: `mcp_approval_request`	Ja

OpenAI.MCPApprovalResponseItemParam

Een reactie op een MCP-goedkeuringsaanvraag.

Naam	Type	Description	Required
approval_request_id	tekenreeks	De id van de goedkeuringsaanvraag die wordt beantwoord.	Ja
approve	boolean	Of de aanvraag is goedgekeurd.	Ja
reden	tekenreeks	Optionele reden voor de beslissing.	No
type	enum	Mogelijke waarden: `mcp_approval_response`	Ja

OpenAI.MCPApprovalResponseItemResource

Een reactie op een MCP-goedkeuringsaanvraag.

Naam	Type	Description	Required
approval_request_id	tekenreeks	De id van de goedkeuringsaanvraag die wordt beantwoord.	Ja
approve	boolean	Of de aanvraag is goedgekeurd.	Ja
reden	tekenreeks	Optionele reden voor de beslissing.	No
type	enum	Mogelijke waarden: `mcp_approval_response`	Ja

OpenAI.MCPCallItemParam

Een aanroep van een hulpprogramma op een MCP-server.

Naam	Type	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Ja
error	tekenreeks	De fout van de aanroep van het hulpprogramma, indien van toepassing.	No
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Ja
uitvoer	tekenreeks	De uitvoer van de aanroep van het hulpprogramma.	No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Ja
type	enum	Mogelijke waarden: `mcp_call`	Ja

OpenAI.MCPCallItemResource

Een aanroep van een hulpprogramma op een MCP-server.

Naam	Type	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Ja
error	tekenreeks	De fout van de aanroep van het hulpprogramma, indien van toepassing.	No
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Ja
uitvoer	tekenreeks	De uitvoer van de aanroep van het hulpprogramma.	No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Ja
type	enum	Mogelijke waarden: `mcp_call`	Ja

OpenAI.MCPListToolsItemParam

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Naam	Type	Description	Required
error	tekenreeks	Foutbericht als de server geen hulpprogramma's kan vermelden.	No
server_label	tekenreeks	Het label van de MCP-server.	Ja
tools	gegevensreeks	De hulpprogramma's die beschikbaar zijn op de server.	Ja
type	enum	Mogelijke waarden: `mcp_list_tools`	Ja

OpenAI.MCPListToolsItemResource

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Naam	Type	Description	Required
error	tekenreeks	Foutbericht als de server geen hulpprogramma's kan vermelden.	No
server_label	tekenreeks	Het label van de MCP-server.	Ja
tools	gegevensreeks	De hulpprogramma's die beschikbaar zijn op de server.	Ja
type	enum	Mogelijke waarden: `mcp_list_tools`	Ja

OpenAI.MCPListToolsTool

Een hulpprogramma dat beschikbaar is op een MCP-server.

Naam	Type	Description	Required
annotations		Aanvullende aantekeningen over het hulpprogramma.	No
description	tekenreeks	De beschrijving van het hulpprogramma.	No
input_schema		Het JSON-schema waarin de invoer van het hulpprogramma wordt beschreven.	Ja
naam	tekenreeks	De naam van het hulpprogramma.	Ja

OpenAI.MCPTool

Geef het model toegang tot aanvullende hulpprogramma's via MCP-servers (Remote Model Context Protocol).

Naam	Type	Description	Required
toegestane_hulpmiddelen	Object		No
└─tool_names	gegevensreeks	Lijst met toegestane namen van hulpprogramma's.	No
headers	Object	Optionele HTTP-headers die naar de MCP-server moeten worden verzonden. Gebruiken voor verificatie of andere doeleinden.	No
goedkeuring vereist	object (zie geldige modellen hieronder)	Geef op welke van de hulpprogramma's van de MCP-server goedkeuring is vereist.	No
server_label	tekenreeks	Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.	Ja
server_url	tekenreeks	De URL voor de MCP-server.	Ja
type	enum	Het type MCP-hulpprogramma. Altijd `mcp`. Mogelijke waarden: `mcp`	Ja

OpenAI.MetadataPropertyForRequest

Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.

Naam	Type	Description	Required	Default
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

OpenAI.Model

Beschrijft een OpenAI-modelaanbieding die kan worden gebruikt met de API.

Naam	Type	Description	Required
created	integer	De Unix-tijdstempel (in seconden) toen het model werd gemaakt.	Ja
identiteitskaart	tekenreeks	De model-id waarnaar kan worden verwezen in de API-eindpunten.	Ja
Object	enum	Het objecttype, dat altijd 'model' is. Mogelijke waarden: `model`	Ja
eigendom van	tekenreeks	De organisatie die eigenaar is van het model.	Ja

OpenAI.OtherChunkingStrategyResponseParam

Dit wordt geretourneerd wanneer de segmenteringsstrategie onbekend is. Dit komt meestal doordat het bestand is geïndexeerd voordat het chunking_strategy concept in de API werd geïntroduceerd.

Naam	Type	Description	Required	Default
type	enum	Altijd `other`. Mogelijke waarden: `other`	Ja

OpenAI.ParallelToolCalls

Hiermee wordt aangegeven of parallelle functie aanroepen moet worden ingeschakeld tijdens het gebruik van het hulpprogramma.

Type: Booleaanse waarde

OpenAI.Prompt

Verwijzing naar een promptsjabloon en de bijbehorende variabelen.

Naam	Type	Description	Required
identiteitskaart	tekenreeks	De unieke id van de promptsjabloon die moet worden gebruikt.	Ja
variables	Object	Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.	No
version	tekenreeks	Optionele versie van de promptsjabloon.	No

OpenAI.RankingOptions

Naam	Type	Description	Required	Default
rangschikker	enum	De ranker die moet worden gebruikt voor het zoeken naar bestanden. Mogelijke waarden: `auto`, `default-2024-11-15`	No
score-drempelwaarde	number	De scoredrempel voor het zoeken naar bestanden, een getal tussen 0 en 1. Getallen dichter bij 1 proberen alleen de meest relevante resultaten te retourneren, maar kunnen minder resultaten opleveren.	No

OpenAI.Reasoning

Alleen modellen uit de o-serie

Naam	Type	Description	Required
effort	Object	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
generate_summary	enum	Afgeschaft: gebruik `summary` in plaats daarvan. Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
samenvatting	enum	Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No

OpenAI.ReasoningEffort

Alleen modellen uit de o-serie

Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn low, mediumen high. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.

Property	Value
Description	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.
Typ	tekenreeks
waarden	`low` `medium` `high`

OpenAI.ReasoningItemParam

Een beschrijving van de gedachtenketen die wordt gebruikt door een redeneringsmodel tijdens het genereren van een antwoord. Zorg ervoor dat u deze items in de input antwoorden-API opneemt voor volgende beurten van een gesprek als u de context handmatig beheert.

Naam	Type	Description	Required
encrypted_content	tekenreeks	De versleutelde inhoud van het redeneringsitem, ingevuld wanneer een antwoord wordt gegenereerd in `reasoning.encrypted_content` de `include` parameter.	No
samenvatting	gegevensreeks	Tekstinhoud redeneren.	Ja
type	enum	Mogelijke waarden: `reasoning`	Ja

OpenAI.ReasoningItemResource

Naam	Type	Description	Required
encrypted_content	tekenreeks	De versleutelde inhoud van het redeneringsitem, ingevuld wanneer een antwoord wordt gegenereerd in `reasoning.encrypted_content` de `include` parameter.	No
samenvatting	gegevensreeks	Tekstinhoud redeneren.	Ja
type	enum	Mogelijke waarden: `reasoning`	Ja

OpenAI.ReasoningItemSummaryPart

Discriminator voor OpenAI.ReasoningItemSummaryPart

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Naam	Type	Description	Required	Default
type	OpenAI.ReasoningItemSummaryPartType		Ja

OpenAI.ReasoningItemSummaryPartType

Property	Value
Typ	tekenreeks
waarden	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Naam	Type	Description	Required	Default
tekst	tekenreeks		Ja
type	enum	Mogelijke waarden: `summary_text`	Ja

OpenAI.Response

Naam	Type	Description	Required	Default
achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
aangemaakt_op	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Ja
error	Object	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Ja
└* code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	No
└• bericht	tekenreeks	Een door mensen leesbare beschrijving van de fout.	No
identiteitskaart	tekenreeks	Unieke id voor dit antwoord.	Ja
incomplete_details	Object	Details over waarom het antwoord onvolledig is.	Ja
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
aanwijzingen	tekenreeks of matrix		Ja
max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
max_gereedschap_aanroepen	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
Object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Ja
uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	Ja
output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Ja	True
previous_response_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
prompt	Object	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* id	tekenreeks	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└* variabelen	OpenAI.ResponsePromptVariables	Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.	No
└─ versie	tekenreeks	Optionele versie van de promptsjabloon.	No
reasoning	Object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Alleen modellen uit de o-serie Beperkingen voor redenering voor redeneringsmodellen. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.	No
└─generate_summary	enum	Afgeschaft: gebruik `summary` in plaats daarvan. Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
Samenvatting └─	enum	Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model. Een van `auto`, `concise`of `detailed`. Mogelijke waarden: `auto`, `concisedetailed`	No
status	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	Ja
tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	Object	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen.	No
└type.	OpenAI.ToolChoiceObjectType	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.	No
tools	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	Ja
truncation	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	Ja

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Verzonden wanneer een gedeeltelijk codefragment wordt gestreamd door de code-interpreter.

Naam	Type	Description	Required
delta	tekenreeks	Het gedeeltelijke codefragment dat wordt gestreamd door de code-interpreter.	Ja
item_id	tekenreeks	De unieke id van het aanroepitem van het hulpprogramma code-interpreter.	Ja
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de code wordt gestreamd.	Ja
type	enum	Het type gebeurtenis. Altijd `response.code_interpreter_call_code.delta`. Mogelijke waarden: `response.code_interpreter_call_code.delta`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Verzonden wanneer het codefragment is voltooid door de code-interpreter.

Naam	Type	Description	Required
code	tekenreeks	De uiteindelijke uitvoer van het codefragment door de code-interpreter.	Ja
item_id	tekenreeks	De unieke id van het aanroepitem van het hulpprogramma code-interpreter.	Ja
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de code is voltooid.	Ja
type	enum	Het type gebeurtenis. Altijd `response.code_interpreter_call_code.done`. Mogelijke waarden: `response.code_interpreter_call_code.done`	Ja

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Verzonden wanneer de aanroep van de code-interpreter is voltooid.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het aanroepitem van het hulpprogramma code-interpreter.	Ja
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de aanroep van de code-interpreter is voltooid.	Ja
type	enum	Het type gebeurtenis. Altijd `response.code_interpreter_call.completed`. Mogelijke waarden: `response.code_interpreter_call.completed`	Ja

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Verzonden wanneer een aanroep van een code-interpreter wordt uitgevoerd.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het aanroepitem van het hulpprogramma code-interpreter.	Ja
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de aanroep van de code-interpreter wordt uitgevoerd.	Ja
type	enum	Het type gebeurtenis. Altijd `response.code_interpreter_call.in_progress`. Mogelijke waarden: `response.code_interpreter_call.in_progress`	Ja

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Verzonden wanneer de code-interpreter het codefragment actief interpreteert.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het aanroepitem van het hulpprogramma code-interpreter.	Ja
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de code-interpreter code interpreteert.	Ja
type	enum	Het type gebeurtenis. Altijd `response.code_interpreter_call.interpreting`. Mogelijke waarden: `response.code_interpreter_call.interpreting`	Ja

OpenAI.ResponseCompletedEvent

Verzonden wanneer het modelantwoord is voltooid.

Naam	Type	Description	Required	Default
response	Object		Ja
└* achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ fout	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└* id	tekenreeks	Unieke id voor dit antwoord.	No
└onvolledige_details	Object	Details over waarom het antwoord onvolledig is.	No
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructies	tekenreeks of matrix	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
└─max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
└max_tool_calls	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└object.	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	No
└output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
└vorig_antwoord_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* redenering	OpenAI.Reasoning	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└status.	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No
└─ tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceObject	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de `tools` parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
└─ hulpmiddelen	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
└ top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
└top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No
└─ afkapping	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Altijd `response.completed`. Mogelijke waarden: `response.completed`	Ja

OpenAI.ResponseContentPartAddedEvent

Verzonden wanneer een nieuw inhoudsonderdeel wordt toegevoegd.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat is toegevoegd.	Ja
item_id	tekenreeks	De id van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Ja
output_index	integer	De index van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Ja
deel	Object		Ja
└type.	OpenAI.ItemContentType	Multimodale invoer- en uitvoerinhoud.	No
type	enum	Het type gebeurtenis. Altijd `response.content_part.added`. Mogelijke waarden: `response.content_part.added`	Ja

OpenAI.ResponseContentPartDoneEvent

Verzonden wanneer een inhoudsonderdeel is voltooid.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat wordt uitgevoerd.	Ja
item_id	tekenreeks	De id van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Ja
output_index	integer	De index van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Ja
deel	Object		Ja
└type.	OpenAI.ItemContentType	Multimodale invoer- en uitvoerinhoud.	No
type	enum	Het type gebeurtenis. Altijd `response.content_part.done`. Mogelijke waarden: `response.content_part.done`	Ja

OpenAI.ResponseCreatedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord wordt gemaakt.

Naam	Type	Description	Required	Default
response	Object		Ja
└* achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ fout	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└* id	tekenreeks	Unieke id voor dit antwoord.	No
└onvolledige_details	Object	Details over waarom het antwoord onvolledig is.	No
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructies	tekenreeks of matrix	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
└─max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
└max_tool_calls	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└object.	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	No
└output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
└vorig_antwoord_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* redenering	OpenAI.Reasoning	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└status.	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, , `cancelledqueued`of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No
└─ tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceObject	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de `tools` parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
└─ hulpmiddelen	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
└ top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
└top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No
└─ afkapping	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Altijd `response.created`. Mogelijke waarden: `response.created`	Ja

OpenAI.ResponseError

Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.

Naam	Type	Description	Required	Default
code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	Ja
message	tekenreeks	Een door mensen leesbare beschrijving van de fout.	Ja

OpenAI.ResponseErrorCode

De foutcode voor het antwoord.

Property	Value
Description	De foutcode voor het antwoord.
Typ	tekenreeks
waarden	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Verzonden wanneer er een fout optreedt.

Naam	Type	Description	Required
code	tekenreeks	De foutcode.	Ja
message	tekenreeks	Het foutbericht.	Ja
param	tekenreeks	De foutparameter.	Ja
type	enum	Het type gebeurtenis. Altijd `error`. Mogelijke waarden: `error`	Ja

OpenAI.ResponseFailedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord mislukt.

Naam	Type	Description	Required	Default
response	Object		Ja
└* achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ fout	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└* id	tekenreeks	Unieke id voor dit antwoord.	No
└onvolledige_details	Object	Details over waarom het antwoord onvolledig is.	No
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructies	tekenreeks of matrix	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
└─max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
└max_tool_calls	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└object.	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	No
└output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
└vorig_antwoord_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* redenering	OpenAI.Reasoning	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└status.	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No
└─ tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceObject	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de `tools` parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
└─ hulpmiddelen	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het th-model worden uitgebreid.	No
└ top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
└top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No
└─ afkapping	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Altijd `response.failed`. Mogelijke waarden: `response.failed`	Ja

OpenAI.ResponseFileSearchCallCompletedEvent

Verzonden wanneer een aanroep voor het zoeken van bestanden is voltooid (resultaten gevonden).

Naam	Type	Description	Required
item_id	tekenreeks	De id van het uitvoeritem dat de aanroep voor het zoeken van bestanden wordt gestart.	Ja
output_index	integer	De index van het uitvoeritem dat de aanroep voor het zoeken van bestanden wordt gestart.	Ja
type	enum	Het type gebeurtenis. Altijd `response.file_search_call.completed`. Mogelijke waarden: `response.file_search_call.completed`	Ja

OpenAI.ResponseFileSearchCallInProgressEvent

Verzonden wanneer een aanroep voor het zoeken van bestanden wordt gestart.

Naam	Type	Description	Required
item_id	tekenreeks	De id van het uitvoeritem dat de aanroep voor het zoeken van bestanden wordt gestart.	Ja
output_index	integer	De index van het uitvoeritem dat de aanroep voor het zoeken van bestanden wordt gestart.	Ja
type	enum	Het type gebeurtenis. Altijd `response.file_search_call.in_progress`. Mogelijke waarden: `response.file_search_call.in_progress`	Ja

OpenAI.ResponseFileSearchCallSearchingEvent

Verzonden wanneer er momenteel wordt gezocht in een bestand.

Naam	Type	Description	Required
item_id	tekenreeks	De id van het uitvoeritem dat de aanroep voor het zoeken van bestanden wordt gestart.	Ja
output_index	integer	De index van het uitvoeritem waarnaar de aanroep voor het zoeken van bestanden zoekt.	Ja
type	enum	Het type gebeurtenis. Altijd `response.file_search_call.searching`. Mogelijke waarden: `response.file_search_call.searching`	Ja

OpenAI.ResponseFormat

Discriminator voor OpenAI.ResponseFormat

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`text`	OpenAI.ResponseFormatText
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `text`, `json_objectjson_schema`	Ja

OpenAI.ResponseFormatJsonObject

JSON-objectantwoordindeling. Een oudere methode voor het genereren van JSON-antwoorden. Het gebruik json_schema wordt aanbevolen voor modellen die dit ondersteunen. Houd er rekening mee dat het model geen JSON genereert zonder een systeem- of gebruikersbericht waarin het wordt geïnstrueerd om dit te doen.

Naam	Type	Description	Required	Default
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_object`. Mogelijke waarden: `json_object`	Ja

OpenAI.ResponseFormatJsonSchema

JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren.

Naam	Type	Description	Required	Default
JSON-schema	Object	Configuratieopties voor gestructureerde uitvoer, waaronder een JSON-schema.	Ja
└─ Beschrijving	tekenreeks	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om te bepalen hoe moet worden gereageerd in de indeling.	No
└─naam	tekenreeks	De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.	No
└* schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	No
└─ strikt	boolean	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 in het `schema` veld is gedefinieerd. Alleen een subset van het JSON-schema wordt ondersteund wanneer `strict` dit is `true`.	No	Onwaar
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_schema`. Mogelijke waarden: `json_schema`	Ja

OpenAI.ResponseFormatJsonSchemaSchema

Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.

Type: objecten

OpenAI.ResponseFormatText

Standaardantwoordindeling. Wordt gebruikt om tekstreacties te genereren.

Naam	Type	Description	Required	Default
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `text`. Mogelijke waarden: `text`	Ja

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Verzonden wanneer er sprake is van een delta voor gedeeltelijke functie-aanroepargumenten.

Naam	Type	Description	Required
delta	tekenreeks	De delta voor functie-aanroepargumenten die wordt toegevoegd.	Ja
item_id	tekenreeks	De id van het uitvoeritem waaraan de delta voor functie-aanroepargumenten wordt toegevoegd.	Ja
output_index	integer	De index van het uitvoeritem waaraan de delta voor functie-aanroepargumenten wordt toegevoegd.	Ja
type	enum	Het type gebeurtenis. Altijd `response.function_call_arguments.delta`. Mogelijke waarden: `response.function_call_arguments.delta`	Ja

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Verzonden wanneer argumenten voor functieoproep zijn voltooid.

Naam	Type	Description	Required
arguments	tekenreeks	De argumenten voor functieoproep.	Ja
item_id	tekenreeks	De id van het item.	Ja
output_index	integer	De index van het uitvoeritem.	Ja
type	enum	Mogelijke waarden: `response.function_call_arguments.done`	Ja

OpenAI.ResponseImageGenCallCompletedEvent

Verzonden wanneer de aanroep van het hulpprogramma voor het genereren van afbeeldingen is voltooid en de uiteindelijke installatiekopieën beschikbaar zijn.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.completed'. Mogelijke waarden: `response.image_generation_call.completed`	Ja

OpenAI.ResponseImageGenCallGeneratingEvent

Wordt verzonden wanneer een aanroep van het hulpprogramma voor het genereren van afbeeldingen actief een installatiekopieën genereert (tussenliggende status).

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.generating'. Mogelijke waarden: `response.image_generation_call.generating`	Ja

OpenAI.ResponseImageGenCallInProgressEvent

Verzonden wanneer er een aanroep van het hulpprogramma voor het genereren van afbeeldingen wordt uitgevoerd.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.in_progress'. Mogelijke waarden: `response.image_generation_call.in_progress`	Ja

OpenAI.ResponseImageGenCallPartialImageEvent

Verzonden wanneer een gedeeltelijke installatiekopie beschikbaar is tijdens het genereren van afbeeldingen.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
partial_image_b64	tekenreeks	Met Base64 gecodeerde gedeeltelijke afbeeldingsgegevens, geschikt voor rendering als afbeelding.	Ja
partial_image_index	integer	Index op basis van 0 voor de gedeeltelijke installatiekopie (back-end is gebaseerd op 1, maar dit is 0 voor de gebruiker).	Ja
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.partial_image'. Mogelijke waarden: `response.image_generation_call.partial_image`	Ja

OpenAI.ResponseInProgressEvent

Verzonden wanneer het antwoord wordt uitgevoerd.

Naam	Type	Description	Required	Default
response	Object		Ja
└* achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ fout	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└* id	tekenreeks	Unieke id voor dit antwoord.	No
└onvolledige_details	Object	Details over waarom het antwoord onvolledig is.	No
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructies	tekenreeks of matrix	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
└─max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
└max_tool_calls	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└object.	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	No
└output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
└vorig_antwoord_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* redenering	OpenAI.Reasoning	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└status.	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No
└─ tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceObject	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de `tools` parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
└─ hulpmiddelen	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
└ top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
└top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No
└─ afkapping	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Altijd `response.in_progress`. Mogelijke waarden: `response.in_progress`	Ja

OpenAI.ResponseIncompleteEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord is voltooid als onvolledig.

Naam	Type	Description	Required	Default
response	Object		Ja
└* achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ fout	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└* id	tekenreeks	Unieke id voor dit antwoord.	No
└onvolledige_details	Object	Details over waarom het antwoord onvolledig is.	No
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructies	tekenreeks of matrix	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
└─max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
└max_tool_calls	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└object.	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	No
└output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
└vorig_antwoord_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* redenering	OpenAI.Reasoning	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└status.	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No
└─ tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceObject	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de `tools` parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
└─ hulpmiddelen	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
└ top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
└top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No
└─ afkapping	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Altijd `response.incomplete`. Mogelijke waarden: `response.incomplete`	Ja

OpenAI.ResponseItemList

Een lijst met antwoorditems.

Naam	Type	Description	Required
Gegevens	gegevensreeks	Een lijst met items die worden gebruikt om dit antwoord te genereren.	Ja
first_id	tekenreeks	De id van het eerste item in de lijst.	Ja
heeft_meer	boolean	Of er meer items beschikbaar zijn.	Ja
last_id	tekenreeks	De id van het laatste item in de lijst.	Ja
Object	enum	Het type object dat wordt geretourneerd, moet zijn `list`. Mogelijke waarden: `list`	Ja

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Verzonden wanneer er een delta (gedeeltelijke update) is voor de argumenten van een MCP-hulpprogrammaaanroep.

Naam	Type	Description	Required
delta		De gedeeltelijke update van de argumenten voor de aanroep van het MCP-hulpprogramma.	Ja
item_id	tekenreeks	De unieke id van het MCP-hulpprogramma dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.arguments_delta'. Mogelijke waarden: `response.mcp_call.arguments_delta`	Ja

OpenAI.ResponseMCPCallArgumentsDoneEvent

Verzonden wanneer de argumenten voor een MCP-hulpprogrammaaanroep zijn voltooid.

Naam	Type	Description	Required
arguments		De voltooide argumenten voor de aanroep van het MCP-hulpprogramma.	Ja
item_id	tekenreeks	De unieke id van het MCP-hulpprogramma dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.arguments_done'. Mogelijke waarden: `response.mcp_call.arguments_done`	Ja

OpenAI.ResponseMCPCallCompletedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is voltooid.

Naam	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.completed'. Mogelijke waarden: `response.mcp_call.completed`	Ja

OpenAI.ResponseMCPCallFailedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is mislukt.

Naam	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.failed'. Mogelijke waarden: `response.mcp_call.failed`	Ja

OpenAI.ResponseMCPCallInProgressEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep wordt uitgevoerd.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het MCP-hulpprogramma dat wordt verwerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.in_progress'. Mogelijke waarden: `response.mcp_call.in_progress`	Ja

OpenAI.ResponseMCPListToolsCompletedEvent

Verzonden wanneer de lijst met beschikbare MCP-hulpprogramma's is opgehaald.

Naam	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.completed'. Mogelijke waarden: `response.mcp_list_tools.completed`	Ja

OpenAI.ResponseMCPListToolsFailedEvent

Verzonden wanneer de poging om beschikbare MCP-hulpprogramma's weer te geven is mislukt.

Naam	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.failed'. Mogelijke waarden: `response.mcp_list_tools.failed`	Ja

OpenAI.ResponseMCPListToolsInProgressEvent

Verzonden wanneer het systeem bezig is met het ophalen van de lijst met beschikbare MCP-hulpprogramma's.

Naam	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.in_progress'. Mogelijke waarden: `response.mcp_list_tools.in_progress`	Ja

OpenAI.ResponseOutputItemAddedEvent

Verzonden wanneer een nieuw uitvoeritem wordt toegevoegd.

Naam	Type	Description	Required
item	Object	Inhoudsitem dat wordt gebruikt om een antwoord te genereren.	Ja
└* id	tekenreeks		No
└type.	OpenAI.ItemType		No
output_index	integer	De index van het uitvoeritem dat is toegevoegd.	Ja
type	enum	Het type gebeurtenis. Altijd `response.output_item.added`. Mogelijke waarden: `response.output_item.added`	Ja

OpenAI.ResponseOutputItemDoneEvent

Verzonden wanneer een uitvoeritem is gemarkeerd als voltooid.

Naam	Type	Description	Required
item	Object	Inhoudsitem dat wordt gebruikt om een antwoord te genereren.	Ja
└* id	tekenreeks		No
└type.	OpenAI.ItemType		No
output_index	integer	De index van het uitvoeritem dat is gemarkeerd als voltooid.	Ja
type	enum	Het type gebeurtenis. Altijd `response.output_item.done`. Mogelijke waarden: `response.output_item.done`	Ja

OpenAI.ResponsePromptVariables

Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.

Type: objecten

OpenAI.ResponseQueuedEvent

Wordt verzonden wanneer een antwoord in de wachtrij wordt geplaatst en wacht tot deze wordt verwerkt.

Naam	Type	Description	Required	Default
response	Object		Ja
└* achtergrond	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	Onwaar
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ fout	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└* id	tekenreeks	Unieke id voor dit antwoord.	No
└onvolledige_details	Object	Details over waarom het antwoord onvolledig is.	No
└─ reden	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructies	tekenreeks of matrix	Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met `previous_response_id`, worden de instructies van een vorige reactie niet overgedragen naar het volgende antwoord. Hierdoor kunt u eenvoudig systeemberichten (of ontwikkelaars) wisselen in nieuwe antwoorden.	No
└─max_output_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens	No
└max_tool_calls	integer	Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd.	No
└* metagegevens	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└object.	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ uitvoer	gegevensreeks	Een matrix met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk van het antwoord van het model. - In plaats van het eerste item in de `output` matrix te openen en ervan uitgaande dat het een `assistant` bericht is met de inhoud die door het model wordt gegenereerd, kunt u overwegen om de `output_text` eigenschap te gebruiken die wordt ondersteund in SDK's.	No
└output_text	tekenreeks	Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle `output_text` items in de `output` matrix bevat, indien aanwezig. Ondersteund in de Python- en JavaScript-SDK's.	No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
└vorig_antwoord_id	tekenreeks	De unieke id van het vorige antwoord op het model. Gebruik deze optie om gesprekken met meerdere paden te maken.	No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└* redenering	OpenAI.Reasoning	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└status.	enum	De status van de reactiegeneratie. Een van`completed`, `failed`, , `in_progress`, , `cancelled`of `queuedincomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we u aan dit of `top_p` niet beide te wijzigen.	No
└─ tekst	Object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.ResponseTextFormatConfiguration		No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceObject	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de `tools` parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
└─ hulpmiddelen	gegevensreeks	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de `tool_choice` parameter in te stellen. De twee categorieën hulpprogramma's die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: hulpprogramma's die worden geleverd door OpenAI waarmee de mogelijkheden van het model worden uitgebreid.	No
└ top_logprobs	integer	Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans.	No
└top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens met de top 10% kansmassa worden beschouwd. Over het algemeen raden we u aan dit of `temperature` niet beide te wijzigen.	No
└─ afkapping	enum	De afkappingsstrategie die moet worden gebruikt voor het modelantwoord. - `auto`: Als de context van dit antwoord en de vorige de venstergrootte van het contextvenster van het model overschrijdt, wordt het antwoord afgekapt zodat het in het contextvenster past door invoeritems in het midden van het gesprek te verwijderen. - `disabled` (standaard): Als een modelantwoord de contextvenstergrootte voor een model overschrijdt, mislukt de aanvraag met een 400-fout. Mogelijke waarden: `auto`, `disabled`	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Altijd 'response.queued'. Mogelijke waarden: `response.queued`	Ja

OpenAI.ResponseReasoningDeltaEvent

Verzonden wanneer er een delta (gedeeltelijke update) is voor de redeneringsinhoud.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel redenering binnen het uitvoeritem.	Ja
delta		De gedeeltelijke update van de redeneringsinhoud.	Ja
item_id	tekenreeks	De unieke id van het item waarvoor redenering wordt bijgewerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.reasoning.delta'. Mogelijke waarden: `response.reasoning.delta`	Ja

OpenAI.ResponseReasoningDoneEvent

Verzonden wanneer de redeneringsinhoud voor een item is voltooid.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel redenering binnen het uitvoeritem.	Ja
item_id	tekenreeks	De unieke id van het item waarvoor de redenering is voltooid.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
tekst	tekenreeks	De voltooide redeneringstekst.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.reasoning.done'. Mogelijke waarden: `response.reasoning.done`	Ja

OpenAI.ResponseReasoningSummaryDeltaEvent

Verzonden wanneer er een delta (gedeeltelijke update) is voor de redeneringsoverzichtsinhoud.

Naam	Type	Description	Required
delta		De gedeeltelijke update van de samenvattingsinhoud met redenering.	Ja
item_id	tekenreeks	De unieke id van het item waarvoor de redeneringssamenvatting wordt bijgewerkt.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
summary_index	integer	De index van het samenvattingsonderdeel in het uitvoeritem.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.reasoning_summary.delta'. Mogelijke waarden: `response.reasoning_summary.delta`	Ja

OpenAI.ResponseReasoningSummaryDoneEvent

Verzonden wanneer de samenvattingsinhoud van de redenering is voltooid voor een item.

Naam	Type	Description	Required
item_id	tekenreeks	De unieke id van het item waarvoor de redeneringssamenvatting is voltooid.	Ja
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Ja
summary_index	integer	De index van het samenvattingsonderdeel in het uitvoeritem.	Ja
tekst	tekenreeks	De uiteindelijke redeneringssamenvattingstekst.	Ja
type	enum	Het type gebeurtenis. Altijd 'response.reasoning_summary.done'. Mogelijke waarden: `response.reasoning_summary.done`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEvent

Verzonden wanneer een nieuw redeneringssamenvattingsonderdeel wordt toegevoegd.

Naam	Type	Description	Required
item_id	tekenreeks	De id van het item waarmee dit overzichtsonderdeel is gekoppeld.	Ja
output_index	integer	De index van het uitvoeritem waarmee dit overzichtsonderdeel is gekoppeld.	Ja
deel	Object		Ja
└type.	OpenAI.ReasoningItemSummaryPartType		No
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Ja
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_part.added`. Mogelijke waarden: `response.reasoning_summary_part.added`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEvent

Verzonden wanneer een samenvattingsonderdeel met redenering is voltooid.

Naam	Type	Description	Required
item_id	tekenreeks	De id van het item waarmee dit overzichtsonderdeel is gekoppeld.	Ja
output_index	integer	De index van het uitvoeritem waarmee dit overzichtsonderdeel is gekoppeld.	Ja
deel	Object		Ja
└type.	OpenAI.ReasoningItemSummaryPartType		No
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Ja
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_part.done`. Mogelijke waarden: `response.reasoning_summary_part.done`	Ja

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Verzonden wanneer een delta wordt toegevoegd aan een redeneringssamenvattingstekst.

Naam	Type	Description	Required
delta	tekenreeks	De tekst delta die is toegevoegd aan de samenvatting.	Ja
item_id	tekenreeks	De id van het item waarmee deze samenvattingstekst delta is gekoppeld.	Ja
output_index	integer	De index van het uitvoeritem waarmee deze samenvattingstekstdelta is gekoppeld.	Ja
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Ja
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_text.delta`. Mogelijke waarden: `response.reasoning_summary_text.delta`	Ja

OpenAI.ResponseReasoningSummaryTextDoneEvent

Verzonden wanneer een samenvattingstekst met redenering is voltooid.

Naam	Type	Description	Required
item_id	tekenreeks	De id van het item waarmee deze samenvattingstekst is gekoppeld.	Ja
output_index	integer	De index van het uitvoeritem waarmee deze samenvattingstekst is gekoppeld.	Ja
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Ja
tekst	tekenreeks	De volledige tekst van de voltooide redeneringssamenvatting.	Ja
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_text.done`. Mogelijke waarden: `response.reasoning_summary_text.done`	Ja

OpenAI.ResponseRefusalDeltaEvent

Verzonden wanneer er sprake is van een gedeeltelijke weigeringstekst.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel waaraan de weigeringstekst wordt toegevoegd.	Ja
delta	tekenreeks	De weigeringstekst die wordt toegevoegd.	Ja
item_id	tekenreeks	De id van het uitvoeritem waaraan de weigeringstekst wordt toegevoegd.	Ja
output_index	integer	De index van het uitvoeritem waaraan de weigeringstekst wordt toegevoegd.	Ja
type	enum	Het type gebeurtenis. Altijd `response.refusal.delta`. Mogelijke waarden: `response.refusal.delta`	Ja

OpenAI.ResponseRefusalDoneEvent

Verzonden wanneer de weigeringstekst is voltooid.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat de weigeringstekst is voltooid.	Ja
item_id	tekenreeks	De id van het uitvoeritem waarvan de weigeringstekst is voltooid.	Ja
output_index	integer	De index van het uitvoeritem dat de weigeringstekst is voltooid.	Ja
weigering	tekenreeks	De weigeringstekst die is voltooid.	Ja
type	enum	Het type gebeurtenis. Altijd `response.refusal.done`. Mogelijke waarden: `response.refusal.done`	Ja

OpenAI.ResponseStreamEvent

Discriminator voor OpenAI.ResponseStreamEvent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Naam	Type	Description	Required	Default
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	Ja
type	OpenAI.ResponseStreamEventType		Ja

OpenAI.ResponseStreamEventType

Property Value

Typ tekenreeks

waarden response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Verzonden wanneer er een extra tekstdelta is.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel waaraan de tekstdelta is toegevoegd.	Ja
delta	tekenreeks	De tekstdelta die is toegevoegd.	Ja
item_id	tekenreeks	De id van het uitvoeritem waaraan de tekstdelta is toegevoegd.	Ja
output_index	integer	De index van het uitvoeritem waaraan de tekstdelta is toegevoegd.	Ja
type	enum	Het type gebeurtenis. Altijd `response.output_text.delta`. Mogelijke waarden: `response.output_text.delta`	Ja

OpenAI.ResponseTextDoneEvent

Verzonden wanneer tekstinhoud is voltooid.

Naam	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat de tekstinhoud is voltooid.	Ja
item_id	tekenreeks	De id van het uitvoeritem waarvan de tekstinhoud is voltooid.	Ja
output_index	integer	De index van het uitvoeritem dat de tekstinhoud is voltooid.	Ja
tekst	tekenreeks	De tekstinhoud die is voltooid.	Ja
type	enum	Het type gebeurtenis. Altijd `response.output_text.done`. Mogelijke waarden: `response.output_text.done`	Ja

OpenAI.ResponseTextFormatConfiguration

Discriminator voor OpenAI.ResponseTextFormatConfiguration

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

Naam	Type	Description	Required	Default
type	OpenAI.ResponseTextFormatConfigurationType	Een object dat de indeling aangeeft die het model moet uitvoeren. `{ "type": "json_schema" }` Als u gestructureerde uitvoer configureert, zorgt u ervoor dat het model overeenkomt met het opgegeven JSON-schema. De standaardindeling is `{ "type": "text" }` zonder extra opties. Niet aanbevolen voor gpt-4o- en nieuwere modellen: `{ "type": "json_object" }` Als u de oudere JSON-modus wilt inschakelen, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruik heeft `json_schema` de voorkeur voor modellen die dit ondersteunen.	Ja

OpenAI.ResponseTextFormatConfigurationJsonObject

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `json_object`	Ja

OpenAI.ResponseTextFormatConfigurationJsonSchema

JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren.

Naam	Type	Description	Required	Default
description	tekenreeks	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om te bepalen hoe moet worden gereageerd in de indeling.	No
naam	tekenreeks	De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.	Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	Ja
streng	boolean	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 in het `schema` veld is gedefinieerd. Alleen een subset van het JSON-schema wordt ondersteund wanneer `strict` dit is `true`.	No	Onwaar
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_schema`. Mogelijke waarden: `json_schema`	Ja

OpenAI.ResponseTextFormatConfigurationText

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `text`	Ja

OpenAI.ResponseTextFormatConfigurationType

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

{ "type": "json_schema" } Als u gestructureerde uitvoer configureert, zorgt u ervoor dat het model overeenkomt met het opgegeven JSON-schema.

De standaardindeling is { "type": "text" } zonder extra opties.

Niet aanbevolen voor gpt-4o- en nieuwere modellen:

{ "type": "json_object" } Als u de oudere JSON-modus wilt inschakelen, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruik heeft json_schema de voorkeur voor modellen die dit ondersteunen.

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

{ "type": "json_schema" } Als u gestructureerde uitvoer configureert, zorgt u ervoor dat het model overeenkomt met het opgegeven JSON-schema.

De standaardindeling is { "type": "text" } zonder extra opties.

Niet aanbevolen voor gpt-4o- en nieuwere modellen:

OpenAI.ResponseUsage

Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.

Naam	Type	Description	Required
input_tokens	integer	Het aantal invoertokens.	Ja
input_tokens_details	Object	Een gedetailleerde uitsplitsing van de invoertokens.	Ja
└ cached_tokens	integer	Het aantal tokens dat is opgehaald uit de cache.	No
output_tokens	integer	Het aantal uitvoertokens.	Ja
output_tokens_details	Object	Een gedetailleerde uitsplitsing van de uitvoertokens.	Ja
└─ redeneertokens	integer	Het aantal redeneringstokens.	No
total_tokens	integer	Het totale aantal gebruikte tokens.	Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required
item_id	tekenreeks	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Ja
output_index	integer	De index van het uitvoeritem waaraan de webzoekopdracht is gekoppeld.	Ja
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.completed`. Mogelijke waarden: `response.web_search_call.completed`	Ja

OpenAI.ResponseWebSearchCallInProgressEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required
item_id	tekenreeks	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Ja
output_index	integer	De index van het uitvoeritem waaraan de webzoekopdracht is gekoppeld.	Ja
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.in_progress`. Mogelijke waarden: `response.web_search_call.in_progress`	Ja

OpenAI.ResponseWebSearchCallSearchingEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required
item_id	tekenreeks	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Ja
output_index	integer	De index van het uitvoeritem waaraan de webzoekopdracht is gekoppeld.	Ja
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.searching`. Mogelijke waarden: `response.web_search_call.searching`	Ja

OpenAI.ResponsesAssistantMessageItemParam

Een berichtparameteritem met de assistant rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `assistant`is. Mogelijke waarden: `assistant`	Ja

OpenAI.ResponsesAssistantMessageItemResource

Een berichtresource-item met de assistant rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `assistant`is. Mogelijke waarden: `assistant`	Ja

OpenAI.ResponsesDeveloperMessageItemParam

Een berichtparameteritem met de developer rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `developer`is. Mogelijke waarden: `developer`	Ja

OpenAI.ResponsesDeveloperMessageItemResource

Een berichtresource-item met de developer rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `developer`is. Mogelijke waarden: `developer`	Ja

OpenAI.ResponsesMessageItemParam

Een antwoordberichtitem, dat een rol en inhoud vertegenwoordigt, zoals opgegeven als parameters voor clientaanvragen.

Discriminator voor OpenAI.ResponsesMessageItemParam

Dit onderdeel maakt gebruik van de eigenschap role om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Naam	Type	Description	Required	Default
role	Object	De verzameling geldige rollen voor berichtitems voor antwoorden.	Ja
type	enum	Het type antwoorditem, dat altijd 'bericht' is. Mogelijke waarden: `message`	Ja

OpenAI.ResponsesMessageItemResource

Een resource-item voor een antwoordbericht, dat een rol en inhoud vertegenwoordigt, zoals opgegeven in serviceantwoorden.

Discriminator voor OpenAI.ResponsesMessageItemResource

Dit onderdeel maakt gebruik van de eigenschap role om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Naam	Type	Description	Required
role	Object	De verzameling geldige rollen voor berichtitems voor antwoorden.	Ja
status	enum	De status van het item. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Ja
type	enum	Het type antwoorditem, dat altijd 'bericht' is. Mogelijke waarden: `message`	Ja

OpenAI.ResponsesMessageRole

De verzameling geldige rollen voor berichtitems voor antwoorden.

Property	Value
Description	De verzameling geldige rollen voor berichtitems voor antwoorden.
Typ	tekenreeks
waarden	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Een berichtparameteritem met de system rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `system`is. Mogelijke waarden: `system`	Ja

OpenAI.ResponsesSystemMessageItemResource

Een berichtresource-item met de system rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `system`is. Mogelijke waarden: `system`	Ja

OpenAI.ResponsesUserMessageItemParam

Een berichtparameteritem met de user rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `user`is. Mogelijke waarden: `user`	Ja

OpenAI.ResponsesUserMessageItemResource

Een berichtresource-item met de user rol.

Naam	Type	Description	Required	Default
inhoud	gegevensreeks	De inhoud die aan het bericht is gekoppeld.	Ja
role	enum	De rol van het bericht, die altijd `user`is. Mogelijke waarden: `user`	Ja

OpenAI.RunGraderRequest

Naam	Type	Description	Required
Grader	Object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Ja
└calculate_output	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	No
└evaluation_metric	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	No
└* graders	Object		No
└image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└input.	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└model.	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	No
└─naam	tekenreeks	De naam van de cijferaar.	No
└─ bewerking	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ bereik	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ Referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	No
└─sampling_params		De steekproefparameters voor het model.	No
└* bron	tekenreeks	De broncode van het Python-script.	No
└type.	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No
item		Het gegevenssetitem dat aan de grader is verstrekt. Deze wordt gebruikt om de `item` naamruimte te vullen.	No
model_sample	tekenreeks	Het modelvoorbeeld dat moet worden geëvalueerd. Deze waarde wordt gebruikt om de `sample` naamruimte te vullen. De `output_json` variabele wordt ingevuld als het modelvoorbeeld een geldige JSON-tekenreeks is.	Ja

OpenAI.RunGraderResponse

Naam	Type	Required
metadata	Object	Ja
└─ fouten	Object	No
└─ formuletaalfout	boolean	No
└invalid_variable_error	boolean	No
└model_grader_parse_error	boolean	No
└model_grader_refusal_error	boolean	No
└model_grader_server_error	boolean	No
└model_grader_server_error_details	tekenreeks	No
└─other_error	boolean	No
└python_grader_runtime_error	boolean	No
└─python_grader_runtime_error_details	tekenreeks	No
└python_grader_server_error	boolean	No
└python_grader_server_error_type	tekenreeks	No
└sample_parse_error	boolean	No
└─ afgekapt_waarnemingsfout	boolean	No
└unresponsive_reward_error	boolean	No
└─ uitvoeringstijd	number	No
└─naam	tekenreeks	No
└─ bemonsterd_model_naam	tekenreeks	No
└* scores		No
└token_usage	integer	No
└type.	tekenreeks	No
model_grader_token_usage_per_model		Ja
belonen	number	Ja
subbeloningen		Ja

OpenAI.StaticChunkingStrategy

Naam	Type	Description	Required	Default
chunk_overlap_tokens	integer	Het aantal tokens dat overlapt tussen segmenten. De standaardwaarde is `400`. Houd er rekening mee dat de overlapping niet groter mag zijn dan de helft van `max_chunk_size_tokens`.	Ja
max_chunk_size_tokens (maximale chunk-grootte tokens)	integer	Het maximum aantal tokens in elk segment. De standaardwaarde is `800`. De minimumwaarde is `100` en de maximumwaarde is `4096`.	Ja

OpenAI.StaticChunkingStrategyRequestParam

Pas uw eigen segmentstrategie aan door segmentgrootte en segmentover overlap in te stellen.

Naam	Type	Description	Required	Default
statisch	OpenAI.StaticChunkingStrategy		Ja
type	enum	Altijd `static`. Mogelijke waarden: `static`	Ja

OpenAI.StaticChunkingStrategyResponseParam

Naam	Type	Description	Required	Default
statisch	OpenAI.StaticChunkingStrategy		Ja
type	enum	Altijd `static`. Mogelijke waarden: `static`	Ja

OpenAI.StopConfiguration

Niet ondersteund met de nieuwste redeneringsmodellen o3 en o4-mini.

Maximaal vier reeksen waarbij de API stopt met het genereren van verdere tokens. De geretourneerde tekst bevat niet de stopvolgorde.

Dit schema accepteert een van de volgende typen:

string
array

OpenAI.Tool

Discriminator voor OpenAI.Tool

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool

Naam	Type	Description	Required	Default
type	OpenAI.ToolType	Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.	Ja

OpenAI.ToolChoiceObject

Discriminator voor OpenAI.ToolChoiceObject

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`function`	OpenAI.ToolChoiceObjectFunction
`mcp`	OpenAI.ToolChoiceObjectMCP

Naam	Type	Description	Required	Default
type	OpenAI.ToolChoiceObjectType	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.	Ja

OpenAI.ToolChoiceObjectCodeInterpreter

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `code_interpreter`	Ja

OpenAI.ToolChoiceObjectComputer

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `computer_use_preview`	Ja

OpenAI.ToolChoiceObjectFileSearch

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `file_search`	Ja

OpenAI.ToolChoiceObjectFunction

Gebruik deze optie om af te dwingen dat het model een specifieke functie aanroept.

Naam	Type	Description	Required	Default
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Ja
type	enum	Voor functie-aanroepen is het type altijd `function`. Mogelijke waarden: `function`	Ja

OpenAI.ToolChoiceObjectImageGen

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `image_generation`	Ja

OpenAI.ToolChoiceObjectMCP

Gebruik deze optie om af te dwingen dat het model een specifiek hulpprogramma aanroept op een externe MCP-server.

Naam	Type	Description	Required
naam	tekenreeks	De naam van het hulpprogramma dat moet worden aangeroepen op de server.	No
server_label	tekenreeks	Het label van de MCP-server die moet worden gebruikt.	Ja
type	enum	Voor MCP-hulpprogramma's is het type altijd `mcp`. Mogelijke waarden: `mcp`	Ja

OpenAI.ToolChoiceObjectType

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.

Property	Value
Description	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.

Typ	tekenreeks
waarden	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required	Default
type	enum	Mogelijke waarden: `web_search_preview`	Ja

OpenAI.ToolChoiceOptions

Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model.

none betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert.

auto betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's.

required betekent dat het model een of meer hulpprogramma's moet aanroepen.

Property	Value
Description	Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. `none` betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. `auto` betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. `required` betekent dat het model een of meer hulpprogramma's moet aanroepen.
Typ	tekenreeks
waarden	`none` `auto` `required`

OpenAI.ToolType

Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.

Property	Value
Description	Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.
Typ	tekenreeks
waarden	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell`

OpenAI.TopLogProb

De grootste logboekkans van een token.

Naam	Type	Required
bytes	gegevensreeks	Ja
logprob	number	Ja
token	tekenreeks	Ja

OpenAI.TranscriptionAudioResponseFormat

Verwijzingen: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property	Value
Typ	tekenreeks
waarden	`logprobs`

OpenAI.TranscriptionSegment

Naam	Type	Description	Required
avg_logprob	number	Gemiddelde logprob van het segment. Als de waarde lager is dan -1, kunt u overwegen dat de logprobs zijn mislukt.	Ja
compression_ratio	number	Compressieverhouding van het segment. Als de waarde groter is dan 2,4, kunt u overwegen dat de compressie is mislukt.	Ja
einde	number	Eindtijd van het segment in seconden.	Ja
identiteitskaart	integer	Unieke id van het segment.	Ja
no_speech_prob	number	Waarschijnlijkheid van geen spraak in het segment. Als de waarde hoger is dan 1,0 en de `avg_logprob` waarde lager is dan -1, kunt u overwegen dit segment stil te houden.	Ja
seek	integer	Verschuiving van het segment zoeken.	Ja
start	number	Begintijd van het segment in seconden.	Ja
Temperatuur	number	Temperatuurparameter die wordt gebruikt voor het genereren van het segment.	Ja
tekst	tekenreeks	Tekstinhoud van het segment.	Ja
tokens	gegevensreeks	Matrix van token-id's voor de tekstinhoud.	Ja

OpenAI.TranscriptionWord

Naam	Type	Description	Required
einde	number	Eindtijd van het woord in seconden.	Ja
start	number	Begintijd van het woord in seconden.	Ja
word	tekenreeks	De tekstinhoud van het woord.	Ja

OpenAI.TranslationAudioResponseFormat

Verwijzingen: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Naam	Type	Description	Required	Default
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	Ja

OpenAI.UpdateVectorStoreRequest

Naam	Type	Description	Required
verloopt_na	Object	Het verloopbeleid voor een vectorarchief.	No
└─ Anker	enum	Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: `last_active_at`. Mogelijke waarden: `last_active_at`	No
└ dagen	integer	Het aantal dagen na de ankertijd dat het vectorarchief verloopt.	No
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van het vectorarchief.	No

OpenAI.VadConfig

Naam	Type	Description	Required	Default
prefix_padding_ms	integer	De hoeveelheid audio die moet worden opgenomen vóór de gedetecteerde VAD-spraak (in milliseconden).	No	300
silence_duration_ms	integer	Duur van stilte om spraakstop te detecteren (in milliseconden). Met kortere waarden reageert het model sneller, maar kan het inspringen op korte pauzes van de gebruiker.	No	200
threshold	number	Gevoeligheidsdrempel (0,0 tot 1.0) voor spraakactiviteitsdetectie. Voor een hogere drempelwaarde is luider geluid nodig om het model te activeren en kan het dus beter presteren in luidruchtige omgevingen.	No	0,5
type	enum	Moet zijn ingesteld om handmatig segmenteren in te `server_vad` schakelen met behulp van VAD aan de serverzijde. Mogelijke waarden: `server_vad`	Ja

OpenAI.ValidateGraderRequest

Naam	Type	Description	Required
Grader	Object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Ja
└calculate_output	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	No
└evaluation_metric	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	No
└* graders	Object		No
└image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└input.	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└model.	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	No
└─naam	tekenreeks	De naam van de cijferaar.	No
└─ bewerking	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ bereik	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ Referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	No
└─sampling_params		De steekproefparameters voor het model.	No
└* bron	tekenreeks	De broncode van het Python-script.	No
└type.	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No

OpenAI.ValidateGraderResponse

Naam	Type	Description	Required
Grader	Object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	No
└calculate_output	tekenreeks	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	No
└evaluation_metric	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van `fuzzy_match`, , `bleu`, `gleu`, , `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, , `rouge_4`, , , `rouge_5`of `rouge_l`. Mogelijke waarden: `fuzzy_match`, `bleu`, , `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3rouge_4rouge_5rouge_l`	No
└* graders	Object		No
└image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└input.	gegevensreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└model.	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	No
└─naam	tekenreeks	De naam van de cijferaar.	No
└─ bewerking	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ bereik	gegevensreeks	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ Referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	No
└─sampling_params		De steekproefparameters voor het model.	No
└* bron	tekenreeks	De broncode van het Python-script.	No
└type.	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No

OpenAI.VectorStoreExpirationAfter

Het verloopbeleid voor een vectorarchief.

Naam	Type	Description	Required	Default
anchor	enum	Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: `last_active_at`. Mogelijke waarden: `last_active_at`	Ja
Dagen	integer	Het aantal dagen na de ankertijd dat het vectorarchief verloopt.	Ja

OpenAI.VectorStoreFileAttributes

Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.

Type: objecten

OpenAI.VectorStoreFileBatchObject

Een batch bestanden die zijn gekoppeld aan een vectorarchief.

Naam	Type	Description	Required
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de batch vectoropslagbestanden is gemaakt.	Ja
aantal_bestanden	Object		Ja
└* geannuleerd	integer	Het aantal bestanden dat is geannuleerd.	No
└} voltooid	integer	Het aantal bestanden dat is verwerkt.	No
└* mislukt	integer	Het aantal bestanden dat niet kan worden verwerkt.	No
└─ in uitvoering	integer	Het aantal bestanden dat momenteel wordt verwerkt.	No
└totaal.	integer	Het totale aantal bestanden.	No
identiteitskaart	tekenreeks	De id waarnaar kan worden verwezen in API-eindpunten.	Ja
Object	enum	Het objecttype, dat altijd `vector_store.file_batch`is. Mogelijke waarden: `vector_store.files_batch`	Ja
status	enum	De status van de bestandsbatch van de vectoropslag, die kan zijn`in_progress`, `completedcancelled` of `failed`. Mogelijke waarden: `in_progress`, `completed`, , `cancelledfailed`	Ja
vector_store_id	tekenreeks	De id van het vectorarchief waaraan het bestand is gekoppeld.	Ja

OpenAI.VectorStoreFileObject

Een lijst met bestanden die zijn gekoppeld aan een vectorarchief.

Naam	Type	Description	Required
attributes	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.	No
chunking_strategy	Object		No
└type.	enum	Mogelijke waarden: `static`, `other`	No
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor het moment dat het vectorarchiefbestand is gemaakt.	Ja
identiteitskaart	tekenreeks	De id waarnaar kan worden verwezen in API-eindpunten.	Ja
laatste_fout	Object	De laatste fout die is gekoppeld aan dit vectorarchiefbestand. Dit gebeurt `null` als er geen fouten zijn.	Ja
└* code	enum	Een van `server_error` of `rate_limit_exceeded`. Mogelijke waarden: `server_error`, `unsupported_fileinvalid_file`	No
└• bericht	tekenreeks	Een door mensen leesbare beschrijving van de fout.	No
Object	enum	Het objecttype, dat altijd `vector_store.file`is. Mogelijke waarden: `vector_store.file`	Ja
status	enum	De status van het vectorarchiefbestand, dat kan zijn`in_progress`, `completed`of `cancelledfailed`. De status `completed` geeft aan dat het vectorarchiefbestand gereed is voor gebruik. Mogelijke waarden: `in_progress`, `completed`, , `cancelledfailed`	Ja
gebruiksbytes	integer	Het totale gebruik van vectoropslag in bytes. Houd er rekening mee dat dit mogelijk verschilt van de oorspronkelijke bestandsgrootte.	Ja
vector_store_id	tekenreeks	De id van het vectorarchief waaraan het bestand is gekoppeld.	Ja

OpenAI.VectorStoreObject

Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.

Naam	Type	Description	Required
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief is gemaakt.	Ja
verloopt_na	OpenAI.VectorStoreExpirationAfter	Het verloopbeleid voor een vectorarchief.	No
verloopt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief verloopt.	No
aantal_bestanden	Object		Ja
└* geannuleerd	integer	Het aantal geannuleerde bestanden.	No
└} voltooid	integer	Het aantal bestanden dat is verwerkt.	No
└* mislukt	integer	Het aantal bestanden dat niet kan worden verwerkt.	No
└─ in uitvoering	integer	Het aantal bestanden dat momenteel wordt verwerkt.	No
└totaal.	integer	Het totale aantal bestanden.	No
identiteitskaart	tekenreeks	De id waarnaar kan worden verwezen in API-eindpunten.	Ja
laatst_actief_op	integer	De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief voor het laatst actief was.	Ja
metadata	Object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Ja
naam	tekenreeks	De naam van het vectorarchief.	Ja
Object	enum	Het objecttype, dat altijd `vector_store`is. Mogelijke waarden: `vector_store`	Ja
status	enum	De status van het vectorarchief, dat kan zijn `expired`, `in_progress`of `completed`. Een status van `completed` geeft aan dat het vectorarchief gereed is voor gebruik. Mogelijke waarden: `expired`, `in_progresscompleted`	Ja
gebruiksbytes	integer	Het totale aantal bytes dat door de bestanden in het vectorarchief wordt gebruikt.	Ja

OpenAI.VoiceIdsShared

Property	Value
Typ	tekenreeks
waarden	`alloy` `ash` `ballad` `coral` `echo` `fable` `onyx` `nova` `sage` `shimmer` `verse`

OpenAI.WebSearchAction

Discriminator voor OpenAI.WebSearchAction

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Naam	Type	Description	Required	Default
type	OpenAI.WebSearchActionType		Ja

OpenAI.WebSearchActionFind

Actietype 'zoeken': zoekt naar een patroon binnen een geladen pagina.

Naam	Type	Description	Required
pattern	tekenreeks	Het patroon of de tekst die u op de pagina wilt zoeken.	Ja
type	enum	Het actietype. Mogelijke waarden: `find`	Ja
URL	tekenreeks	De URL van de pagina waarnaar het patroon is gezocht.	Ja

OpenAI.WebSearchActionOpenPage

Actietype 'open_page': hiermee opent u een specifieke URL uit zoekresultaten.

Naam	Type	Description	Required	Default
type	enum	Het actietype. Mogelijke waarden: `open_page`	Ja
URL	tekenreeks	De URL die door het model is geopend.	Ja

OpenAI.WebSearchActionSearch

Actietype 'zoeken': voert een webzoekquery uit.

Naam	Type	Description	Required	Default
zoekopdracht	tekenreeks	De zoekquery.	Ja
type	enum	Het actietype. Mogelijke waarden: `search`	Ja

OpenAI.WebSearchActionType

Property	Value
Typ	tekenreeks
waarden	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required
zoek_context_grootte	enum	Richtlijnen op hoog niveau voor de hoeveelheid contextvensterruimte die moet worden gebruikt voor de zoekopdracht. Een van `low`, `medium`of `high`. `medium` is de standaardwaarde. Mogelijke waarden: `low`, `mediumhigh`	No
type	enum	Het type webzoekprogramma. Een van `web_search_preview` of `web_search_preview_2025_03_11`. Mogelijke waarden: `web_search_preview`	Ja
gebruikerslocatie	Object		No
└type.	OpenAI.LocationType		No

OpenAI.WebSearchToolCallItemParam

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required
action	Object		Ja
└type.	OpenAI.WebSearchActionType		No
type	enum	Mogelijke waarden: `web_search_call`	Ja

OpenAI.WebSearchToolCallItemResource

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Naam	Type	Description	Required
action	Object		Ja
└type.	OpenAI.WebSearchActionType		No
status	enum	De status van de aanroep van het webzoekprogramma. Mogelijke waarden: `in_progress`, `searching`, , `completedfailed`	Ja
type	enum	Mogelijke waarden: `web_search_call`	Ja

PineconeChatDataSource

Naam	Type	Description	Required	Default
parameters	Object	De parameterinformatie voor het beheren van het gebruik van de pinecone-gegevensbron.	Ja
└allow_partial_result	boolean	Als deze optie is ingesteld op true, staat het systeem toe dat gedeeltelijke zoekresultaten worden gebruikt en mislukt de aanvraag als alle gedeeltelijke query's mislukken. Als deze niet is opgegeven of als onwaar is opgegeven, mislukt de aanvraag als een zoekquery mislukt.	No	Onwaar
└* verificatie	Object		No
└─ sleutel	tekenreeks		No
└type.	enum	Mogelijke waarden: `api_key`	No
└embedding_dependency	Object	Een weergave van een gegevensvectorisatiebron die kan worden gebruikt als een insluitresource met een gegevensbron.	No
└type.	AzureChatDataSourceVectorizationSourceType	De differentiërende id voor de betonvectorisatiebron.	No
└* omgeving	tekenreeks	De omgevingsnaam die moet worden gebruikt met Pinecone.	No
└fields_mapping	Object	Veldtoewijzingen die moeten worden toegepast op gegevens die worden gebruikt door de gegevensbron Pinecone. Houd er rekening mee dat inhoudsveldtoewijzingen vereist zijn voor Pinecone.	No
└content_fields	gegevensreeks		No
└─content_fields_separator	tekenreeks		No
└filepath_field	tekenreeks		No
└title_field	tekenreeks		No
└url_field	tekenreeks		No
└─ binnen_het_bereik	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└include_contexts	gegevensreeks	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['bronvermeldingen', 'intentie']
└index_name	tekenreeks	De naam van de pinecone-databaseindex die moet worden gebruikt.	No
└max_search_queries	integer	Het maximum aantal herschreven query's dat naar de zoekprovider moet worden verzonden voor één gebruikersbericht. Het systeem zal standaard een automatische beslissing nemen.	No
└* striktheid	integer	De geconfigureerde striktheid van het filteren op zoekrelevantie. Hogere strengheid zal de precisie verhogen, maar een lagere terugroeping van het antwoord.	No
└top_n_documents	integer	Het geconfigureerde aantal documenten dat moet worden weergegeven in de query.	No
type	enum	De gediscrimineerde type-id, die altijd 'pinecone' is. Mogelijke waarden: `pinecone`	Ja

Quality

De kwaliteit van de video-inhoud die moet worden opgehaald. Hiermee geeft u de kwaliteit op van de video-inhoud die moet worden geretourneerd.

Property	Value
Description	De kwaliteit van de video-inhoud die moet worden opgehaald. Hiermee geeft u de kwaliteit op van de video-inhoud die moet worden geretourneerd.
Typ	tekenreeks
waarden	`high` `low`

ResponseFormatJSONSchemaRequest

Naam	Type	Description	Required	Default
JSON-schema	Object	JSON-schema voor de antwoordindeling	Ja
type	enum	Type antwoordindeling Mogelijke waarden: `json_schema`	Ja

ResponseModalities

Uitvoertypen die u door het model wilt genereren. De meeste modellen kunnen tekst genereren. Dit is de standaardinstelling:

["text"]

Het gpt-4o-audio-preview model kan ook worden gebruikt om audio te genereren. Als u wilt aanvragen dat dit model zowel tekst- als audioantwoorden genereert, kunt u het volgende gebruiken:

["text", "audio"]

Matrix van: tekenreeks

SpeechGenerationResponseFormat

De ondersteunde audio-uitvoerindelingen voor tekst-naar-spraak.

Dit onderdeel kan een van de volgende zijn:

VideoGeneration

Een resultaat voor het genereren van video's.

Naam	Type	Description	Required
aangemaakt_op	integer	Het tijdstip waarop de videogeneratie is gemaakt.	Ja
height	integer	De hoogte van de video.	Ja
identiteitskaart	tekenreeks	De id van de videogeneratie.	Ja
job_id	tekenreeks	De id van de taak voor het genereren van video's voor deze video.	Ja
n_seconds	integer	De duur van de videogeneratie.	Ja
Object	enum	Mogelijke waarden: `video.generation`	Ja
prompt	tekenreeks	De prompt voor deze videogeneratie.	Ja
width	integer	De breedte van de video.	Ja

VideoGenerationJob

Een videogeneratietaak.

Naam	Type	Description	Required
aangemaakt_op	integer	Het tijdstip waarop de taak is gemaakt.	Ja
verloopt_op	integer	Het tijdstip waarop de taak automatisch uit de service wordt verwijderd. De video-inhoud en metagegevens van de taak moeten vóór deze datum worden opgeslagen om gegevensverlies te voorkomen.	No
failure_reason	tekenreeks (zie geldige modellen hieronder)		No
afgerond_op	integer	Het tijdstip waarop de taak klaar is met alle videogeneraties.	No
Generaties	gegevensreeks	De gegenereerde video's voor deze taak. Het getal hangt af van de gegeven n_variants en het succes van de generaties.	No
height	integer	De hoogte van de video.	Ja
identiteitskaart	tekenreeks	De id van de taak.	Ja
inpaint_items	gegevensreeks	Optionele inpainting-items voor deze videogeneratietaak.	No
model	tekenreeks	De naam van de implementatie die moet worden gebruikt voor deze videogeneratietaak.	Ja
n_seconds	integer	De duur van de videogeneratietaak.	Ja
n_variants	integer	Het aantal video's dat moet worden gemaakt als varianten voor deze videogeneratietaak.	Ja
Object	enum	Mogelijke waarden: `video.generation.job`	Ja
prompt	tekenreeks	De prompt voor deze videogeneratietaak.	Ja
status	Object	De status van een videogeneratietaak.	Ja
width	integer	De hoogte van de video.	Ja

VideoGenerationJobList

Een lijst met taken voor het genereren van video's.

Naam	Type	Description	Required
Gegevens	gegevensreeks	De lijst met taken voor het genereren van video's.	Ja
first_id	tekenreeks	De id van de eerste taak op de huidige pagina, indien beschikbaar.	No
heeft_meer	boolean	Een vlag die aangeeft of er meer taken beschikbaar zijn na de lijst.	Ja
last_id	tekenreeks	De id van de laatste taak op de huidige pagina, indien beschikbaar.	No
Object	enum	Mogelijke waarden: `list`	Ja

Volgende stappen

Meer informatie over modellen en het afstemmen met de REST API. Meer informatie over de onderliggende modellen die gebruikmaken van Azure OpenAI.

Feedback

Is deze pagina nuttig?

Last updated on 2026-05-20