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 Azure OpenAI-gegevensvlakdeductiespecificatie. Meer informatie vindt u in onze handleiding voor de LEVENSCYCLUS van DE API.

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

Create speech

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Microsoft Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
input	string	De tekst voor het genereren van audio. De maximumlengte is 4096 tekens.	Yes
instructions	string	Beheer de stem van uw gegenereerde audio met aanvullende instructies. Werkt niet met `tts-1` of `tts-1-hd`.	No
model	string	Het model dat moet worden gebruikt voor deze tekst-naar-spraak-aanvraag.	Yes
response_format	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		Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/octet-stream	string

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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"
}

Create transcription

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

Hiermee wordt audio getranscribeerd in de invoertaal.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: multipart/form-data

Name	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
└─ 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`	No
file	string		Yes
filename	string	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens.	No
include[]	array	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	string	De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1 -indeling (bijvoorbeeld `en`) verbetert de nauwkeurigheid en latentie.	No
model	string	Het model dat moet worden gebruikt voor deze transcriptieaanvraag.	No
prompt	string	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
response_format	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	False
temperature	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[]	array	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.

Content-Type	Type	Description
application/json	AzureAudioTranscriptionResponse
text/plain	string

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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"
}

Create translation

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string		Yes
filename	string	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens	No
model	string	Het model dat moet worden gebruikt voor deze vertaalaanvraag.	No
prompt	string	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
response_format	object		No
temperature	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.

Content-Type	Type	Description
application/json	AzureAudioTranslationResponse
text/plain	string

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
audio	object	Parameters voor audio-uitvoer. Vereist wanneer audio-uitvoer wordt aangevraagd met `modalities: ["audio"]`.	No
└─ format	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
└─ voice	object		No
data_sources	array	De gegevensbronnen die moeten worden gebruikt voor de functie On Your Data, exclusief voor Azure OpenAI.	No
frequency_penalty	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	array	Afgeschaft ten gunste van `tools`. Een lijst met functies waarvoor het model JSON-invoer kan genereren.	No
logit_bias	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	None
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	False
max_completion_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens.	No
max_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
messages	array	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.	Yes
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
modalities	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	string	De modelimplementatie-id die moet worden gebruikt voor de voltooiingsaanvraag voor chats.	Yes
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_tool_calls	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
presence_penalty	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
reasoning_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
response_format	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	False
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	False
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
temperature	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	array	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	string	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.

Content-Type	Type	Description
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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
    }
  }
}

Create embedding

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

Hiermee maakt u een insluitvector die de invoertekst vertegenwoordigt.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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
input	tekenreeks of matrix		Yes
model	string	Het model dat moet worden gebruikt voor de insluitingsaanvraag.	Yes
user	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.CreateEmbeddingResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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
    }
  }
}

List evals

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

Lijst met evaluaties voor een project.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	query	No	string	Id voor de laatsteval van de vorige pagineringsaanvraag.
limit	query	No	integer	Een limiet voor het aantal evals dat moet worden geretourneerd in één pagineringsreactie.
order	query	No	string Mogelijke waarden: `asc`, `desc`	Sorteervolgorde voor evals op tijdstempel. Gebruiken `asc` voor oplopende volgorde of `desc` voor aflopende volgorde.
order_by	query	No	string 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.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.EvalList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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'.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required
data_source_config	object		Yes
└─ 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
name	string	De naam van de evaluatie.	No
statusCode	enum	Mogelijke waarden: `201`	Yes
testing_criteria	array	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}}`).	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Get eval

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Update eval

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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
name	string		No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Delete eval

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	object

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string
after	query	No	string
limit	query	No	integer
order	query	No	string Mogelijke waarden: `asc`, `desc`
status	query	No	string Mogelijke waarden: `queued`, `in_progress`, `completed`, , `canceledfailed`

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.EvalRunList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required
data_source	object		Yes
└─ 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
name	string	De naam van de uitvoering.	No

Responses

Statuscode: 201

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

Content-Type	Type	Description
application/json	OpenAI.EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string
run_id	path	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string
run_id	path	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string
run_id	path	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	object

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string
run_id	path	Yes	string
after	query	No	string
limit	query	No	integer
status	query	No	string Mogelijke waarden: `fail`, `pass`
order	query	No	string Mogelijke waarden: `asc`, `desc`

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.EvalRunOutputItemList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
aoai-evals	header	Yes	string 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	Yes	string
run_id	path	Yes	string
output_item_id	path	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.EvalRunOutputItem

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Create file

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required
expires_after	object		Yes
└─ anchor	AzureFileExpiryAnchor		No
└─ seconds	integer		No
file	string		Yes
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`	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureOpenAIFile

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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

List files

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
purpose	query	No	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureListFilesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Retrieve file

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
file_id	path	Yes	string	De id van het bestand dat voor deze aanvraag moet worden gebruikt.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureOpenAIFile

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Delete file

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
file_id	path	Yes	string	De id van het bestand dat voor deze aanvraag moet worden gebruikt.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.DeleteFileResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Download file

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
file_id	path	Yes	string	De id van het bestand dat voor deze aanvraag moet worden gebruikt.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/octet-stream	string

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Rungrader

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

Voer een cijfer uit.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required
grader	object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Yes
└─ calculate_output	string	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	string	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└─ input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└─ model	string	Het model dat moet worden gebruikt voor de evaluatie.	No
└─ name	string	De naam van de cijferaar.	No
└─ operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ range	array	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ reference	string	De tekst wordt beoordeeld op basis van.	No
└─ sampling_params		De steekproefparameters voor het model.	No
└─ source	string	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	string	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.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.RunGraderResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Validate grader

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

Valideer een cijfer.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required
grader	object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Yes
└─ calculate_output	string	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	string	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└─ input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└─ model	string	Het model dat moet worden gebruikt voor de evaluatie.	No
└─ name	string	De naam van de cijferaar.	No
└─ operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ range	array	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ reference	string	De tekst wordt beoordeeld op basis van.	No
└─ sampling_params		De steekproefparameters voor het model.	No
└─ source	string	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.

Content-Type	Type	Description
application/json	OpenAI.ValidateGraderResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
hyperparameters	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
integrations	array	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.	Yes
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
suffix	string	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	None
training_file	string	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.	Yes
validation_file	string	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.

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
after	query	No	string	Id voor de laatste taak uit de vorige pagineringsaanvraag.
limit	query	No	integer	Aantal taakafstemmingen dat moet worden opgehaald.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van de taak voor het afstemmen.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van de taak voor het afstemmen om te annuleren.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van de taak voor het afstemmen van controlepunten.
after	query	No	string	Id voor de laatste controlepunt-id van de vorige pagineringsaanvraag.
limit	query	No	integer	Aantal controlepunten dat moet worden opgehaald.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van de taak voor het afstemmen van gebeurtenissen.
after	query	No	string	Id voor de laatste gebeurtenis uit de vorige pagineringsaanvraag.
limit	query	No	integer	Aantal gebeurtenissen dat moet worden opgehaald.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van de taak voor het afstemmen om te onderbreken.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van de taak voor het afstemmen om te hervatten.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Afbeeldingsbewerking maken

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
background	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
image	tekenreeks of matrix		Yes
mask	string		No
model	string	De modelimplementatie die moet worden gebruikt voor de bewerking voor het bewerken van afbeeldingen.	Yes
n	integer	Het aantal afbeeldingen dat moet worden gegenereerd. Moet tussen 1 en 10 zijn.	No	1
output_compression	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
output_format	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	string	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.	Yes
quality	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
response_format	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	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureImagesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Createimage

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
background	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	string	De modelimplementatie die moet worden gebruikt voor het genereren van installatiekopieën.	Yes
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
output_compression	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
output_format	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	string	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`.	Yes
quality	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
response_format	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
style	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	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureImagesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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
          }
        }
      }
    ]
  }
}

List models

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListModelsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Retrieve model

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
model	path	Yes	string	De id van het model dat voor deze aanvraag moet worden gebruikt.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.Model

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Create response

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

Hiermee maakt u een modelantwoord.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
include	array	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
input	tekenreeks of matrix		No
instructions	string	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
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	string	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	Yes
parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
previous_response_id	string	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	string	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└─ variables	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
└─ version	string	Optionele versie van de promptsjabloon.	No
reasoning	object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└─ effort	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
└─ summary	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	False
temperature	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
text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	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	array	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. You 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	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

Een modelantwoord maken

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

Get response

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

Haalt een modelantwoord op met de opgegeven id.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	string
include[]	query	No	array

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	AzureResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Delete response

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

Hiermee verwijdert u een antwoord op id.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	object

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	string
limit	query	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	query	No	string 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	query	No	string	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.
before	query	No	string	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.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ResponseItemList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Lijstvectorarchieven

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

Retourneert een lijst met vectorarchieven.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
limit	query	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	query	No	string 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	query	No	string	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.
before	query	No	string	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.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListVectorStoresResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Vector store maken

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

Hiermee maakt u een vectorarchief.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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
└─ static	OpenAI.StaticChunkingStrategy		No
└─ type	enum	Altijd `static`. Mogelijke waarden: `static`	No
expires_after	OpenAI.VectorStoreExpirationAfter	Het verloopbeleid voor een vectorarchief.	No
file_ids	array	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
name	string	De naam van het vectorarchief.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief dat moet worden opgehaald.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief dat moet worden gewijzigd.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	Type	Description	Required
expires_after	object	Het verloopbeleid voor een vectorarchief.	No
└─ anchor	enum	Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: `last_active_at`. Mogelijke waarden: `last_active_at`	No
└─ days	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
name	string	De naam van het vectorarchief.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureErrorResponse

Vectorarchief verwijderen

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

Een vectorarchief verwijderen.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief dat moet worden verwijderd.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.DeleteVectorStoreResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waarvoor een bestandsbatch moet worden gemaakt.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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	array	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.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waartoe de bestandsbatch behoort.
batch_id	path	Yes	string	De id van de bestandsbatch die wordt opgehaald.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waartoe de bestandsbatch behoort.
batch_id	path	Yes	string	De id van de bestandsbatch die moet worden geannuleerd.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileBatchObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waartoe de bestandsbatch behoort.
batch_id	path	Yes	string	De id van de bestandsbatch waartoe de bestanden behoren.
limit	query	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	query	No	string 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	query	No	string	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.
before	query	No	string	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	query	No		Filteren op bestandsstatus. Een van`in_progress`, `completed`, `failed`, . `cancelled`

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListVectorStoreFilesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waartoe de bestanden behoren.
limit	query	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	query	No	string 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	query	No	string	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.
before	query	No	string	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	query	No		Filteren op bestandsstatus. Een van`in_progress`, `completed`, `failed`, . `cancelled`

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.ListVectorStoreFilesResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waarvoor een bestand moet worden gemaakt.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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	string	Een bestands-id die door het vectorarchief moet worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waartoe het bestand behoort.
file_id	path	Yes	string	De id van het bestand dat wordt opgehaald.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string
file_id	path	Yes	string

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	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	Yes	string	De id van het vectorarchief waartoe het bestand behoort.
file_id	path	Yes	string	De id van het te verwijderen bestand.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	OpenAI.DeleteVectorStoreFileResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Request Body

Content-Type: application/json

Name	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.	Yes
model	string	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Yes
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	string	De prompt voor deze videogeneratietaak.	Yes
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.	Yes

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
files	array		Yes
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.	Yes
inpaint_items	array	Optionele inpainting-items voor deze videogeneratietaak.	No
model	string	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Yes
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	string	De prompt voor deze videogeneratietaak.	Yes
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.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	VideoGenerationJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
before	query	No	string
after	query	No	string
limit	query	Yes	integer
statuses	query	No	array

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	VideoGenerationJobList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
job-id	path	Yes	string	De id van de taak voor het genereren van video's die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	VideoGenerationJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
job-id	path	Yes	string	De id van de taak voor het genereren van video's die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	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.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Yes	string	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
application/json	VideoGeneration

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Yes	string	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
image/jpg	string

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Yes	string	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.
quality	query	No

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Content-Type	Type	Description
video/mp4	string

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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

Name	In	Required	Type	Description
endpoint	path	Yes	string 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-version	query	No		De expliciete Foundry Models API-versie die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
generation-id	path	Yes	string	De id van de videogeneratie die moet worden gebruikt voor de Azure OpenAI-aanvraag.
quality	query	No

Request Header

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

Name	Required	Type	Description
Authorization	True	string	Example:`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-key	True	string	Geef hier Azure OpenAI API-sleutel op

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Content-Type	Type	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.
Type	string
Values	`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.

Name	Type	Description	Required
avg_logprob	number	De gemiddelde logboekkans die aan dit audiosegment is gekoppeld.	Yes
compression_ratio	number	De compressieverhouding van dit audiosegment.	Yes
end	number	Het tijdstip waarop dit segment eindigde ten opzichte van het begin van de vertaalde audio.	Yes
id	integer	De op 0 gebaseerde index van dit segment binnen een vertaling.	Yes
no_speech_prob	number	De kans op geen spraakdetectie binnen dit audiosegment.	Yes
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.	Yes
start	number	Het tijdstip waarop dit segment begon ten opzichte van het begin van de vertaalde audio.	Yes
temperature	number	De temperatuurscore die aan dit audiosegment is gekoppeld.	Yes
text	string	De vertaalde tekst die deel uitmaakte van dit audiosegment.	Yes
tokens	array	De token-id's die overeenkomen met de vertaalde tekst in dit audiosegment.	Yes

AzureAIFoundryModelsApiVersion

Property	Value
Type	string
Values	`v1` `preview`

AzureAudioTranscriptionResponse

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

Name	Type	Description	Required
duration	number	De totale duur van de audio die is verwerkt om bijbehorende transcriptiegegevens te produceren.	No
language	string	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	array	Een verzameling informatie over de timing, waarschijnlijkheden en andere details van elk verwerkt audiosegment.	No
task	object	Definieert de mogelijke descriptors voor beschikbare antwoorden voor audiobewerkingen.	No
text	string	De getranscribeerde tekst voor de opgegeven audiogegevens.	Yes
words	array	Een verzameling informatie over de timing van elk verwerkt woord.	No

AzureAudioTranslationResponse

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

Name	Type	Description	Required
duration	number	De totale duur van de audio die is verwerkt voor het produceren van begeleidende vertaalgegevens.	No
language	string	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	array	Een verzameling informatie over de timing, waarschijnlijkheden en andere details van elk verwerkt audiosegment.	No
task	object	Definieert de mogelijke descriptors voor beschikbare antwoorden voor audiobewerkingen.	No
text	string	De vertaalde tekst voor de opgegeven audiogegevens.	Yes

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.

Name	Type	Description	Required
annotations	array	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
└─ data	string	Met Base64 gecodeerde audiobytes die door het model zijn gegenereerd, in de indeling die is opgegeven in de aanvraag.	No
└─ expires_at	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	string	Unieke id voor dit audioantwoord.	No
└─ transcript	string	Transcriptie van de audio die door het model wordt gegenereerd.	No
content	string	De inhoud van het bericht.	Yes
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	string	De segment-id voor de bronvermelding.	No
└─ content	string	De inhoud van de bronvermelding.	No
└─ data_source_index	integer	De index van de gegevensbron die wordt gebruikt voor het ophalen.	No
└─ filepath	string	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
└─ original_search_score	number	De oorspronkelijke zoekscore voor het ophalen.	No
└─ rerank_score	number	De rerankscore voor het ophalen.	No
└─ search_queries	array	De zoekquery's die worden uitgevoerd om documenten op te halen.	No
└─ title	string	De titel voor de bronvermelding.	No
└─ url	string	De URL van de bronvermelding.	No
└─ citations	array	De bronvermeldingen die worden geproduceerd door het ophalen van gegevens.	No
└─ intent	string	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
└─ arguments	string		No
└─ name	string		No
reasoning_content	string	Een Azure-specifieke extensieeigenschap met gegenereerde redeneringsinhoud van ondersteunde modellen.	No
refusal	string	Het weigeringsbericht dat door het model is gegenereerd.	Yes
role	enum	De rol van de auteur van dit bericht. Mogelijke waarden: `assistant`	Yes
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.

Name	Type	Description	Required
audio	object		No
└─ data	string		No
└─ expires_at	integer		No
└─ id	string		No
└─ transcript	string		No
content	string	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	string	De segment-id voor de bronvermelding.	No
└─ content	string	De inhoud van de bronvermelding.	No
└─ data_source_index	integer	De index van de gegevensbron die wordt gebruikt voor het ophalen.	No
└─ filepath	string	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
└─ original_search_score	number	De oorspronkelijke zoekscore voor het ophalen.	No
└─ rerank_score	number	De rerankscore voor het ophalen.	No
└─ search_queries	array	De zoekquery's die worden uitgevoerd om documenten op te halen.	No
└─ title	string	De titel voor de bronvermelding.	No
└─ url	string	De URL van de bronvermelding.	No
└─ citations	array	De bronvermeldingen die worden geproduceerd door het ophalen van gegevens.	No
└─ intent	string	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
└─ arguments	string		No
└─ name	string		No
reasoning_content	string	Een Azure-specifieke extensieeigenschap met gegenereerde redeneringsinhoud van ondersteunde modellen.	No
refusal	string	Het weigeringsbericht dat door het model is gegenereerd.	No
role	object	De rol van de auteur van een bericht	No
tool_calls	array		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:

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

Name	Type	Description	Required	Default
type	object		Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Name	Type	Description	Required	Default
access_token	string		Yes
type	enum	Mogelijke waarden: `access_token`	Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Name	Type	Description	Required	Default
key	string		Yes
type	enum	Mogelijke waarden: `api_key`	Yes

AzureChatDataSourceAuthenticationOptions

Discriminator voor AzureChatDataSourceAuthenticationOptions

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

Type Value	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

Name	Type	Description	Required	Default
type	AzureChatDataSourceAuthenticationOptionsType		Yes

AzureChatDataSourceAuthenticationOptionsType

Property	Value
Type	string
Values	`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

Name	Type	Description	Required	Default
connection_string	string		Yes
type	enum	Mogelijke waarden: `connection_string`	Yes

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.

Name	Type	Description	Required
deployment_name	string	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.	Yes
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`	Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name	Type	Description	Required	Default
encoded_api_key	string		Yes
type	enum	Mogelijke waarden: `encoded_api_key`	Yes

AzureChatDataSourceEndpointVectorizationSource

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

Name	Type	Description	Required
authentication	object		Yes
└─ access_token	string		No
└─ key	string		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	string	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.	Yes
type	enum	De type-id, altijd 'eindpunt' voor dit vectorisatiebrontype. Mogelijke waarden: `endpoint`	Yes

AzureChatDataSourceIntegratedVectorizationSource

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

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

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name	Type	Description	Required
key	string		Yes
key_id	string		Yes
type	enum	Mogelijke waarden: `key_and_key_id`	Yes

AzureChatDataSourceModelIdVectorizationSource

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

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

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `system_assigned_managed_identity`	Yes

AzureChatDataSourceType

Property	Value
Type	string
Values	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name	Type	Description	Required	Default
managed_identity_resource_id	string		Yes
type	enum	Mogelijke waarden: `user_assigned_managed_identity`	Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name	Type	Description	Required
password	string		Yes
type	enum	Mogelijke waarden: `username_and_password`	Yes
username	string		Yes

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:

Type Value	Schema
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChatDataSourceModelIdVectorizationSource

Name	Type	Description	Required	Default
type	object		Yes

AzureChatDataSourceVectorizationSourceType

Property	Value
Type	string
Values	`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.

Name	Type	Description	Required
all_retrieved_documents	object	Samenvattingsinformatie over documenten die zijn opgehaald door de bewerking voor het ophalen van gegevens.	No
└─ chunk_id	string	De segment-id voor de bronvermelding.	No
└─ content	string	De inhoud van de bronvermelding.	No
└─ data_source_index	integer	De index van de gegevensbron die wordt gebruikt voor het ophalen.	No
└─ filepath	string	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
└─ original_search_score	number	De oorspronkelijke zoekscore voor het ophalen.	No
└─ rerank_score	number	De rerankscore voor het ophalen.	No
└─ search_queries	array	De zoekquery's die worden uitgevoerd om documenten op te halen.	No
└─ title	string	De titel voor de bronvermelding.	No
└─ url	string	De URL van de bronvermelding.	No
citations	array	De bronvermeldingen die worden geproduceerd door het ophalen van gegevens.	No
intent	string	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.

Name	Type	Description	Required	Default
details	array	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.	Yes

AzureContentFilterCompletionTextSpan

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

Name	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.	Yes
completion_start_offset	integer	Verschuiving van het UTF32-codepunt dat begint met het bereik.	Yes

AzureContentFilterCompletionTextSpanDetectionResult

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

AzureContentFilterCustomTopicResult

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

Name	Type	Description	Required	Default
details	array	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.	Yes

AzureContentFilterDetectionResult

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

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

AzureContentFilterImagePromptResults

Een inhoudsfilterresultaat voor de invoeraanvraaginhoud van een afbeeldingsgeneratiebewerking.

Name	Type	Description	Required
custom_blocklists	object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└─ details	array	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.	No
custom_topics	object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details	array	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.	No
jailbreak	object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	Yes
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	No

AzureContentFilterImageResponseResults

Een inhoudsfilterresultaat voor de uitvoerantwoordinhoud van een afbeeldingsgeneratiebewerking.

Name	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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.

Name	Type	Description	Required
custom_blocklists	object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└─ details	array	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.	No
custom_topics	object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details	array	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.	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
└─ message	string	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ citation	object	Indien beschikbaar, worden de bronvermeldingsgegevens beschreven die de bijbehorende licentie en de locatie ervan beschrijven.	No
└─ URL	string	De URL die is gekoppeld aan de licentie.	No
└─ license	string	De naam of id van de licentie die is gekoppeld aan de detectie.	No
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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.

Name	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	array	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.	No
└─ custom_topics	object	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details	array	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.	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
└─ message	string	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	No
└─ indirect_attack	object	Een gelabeld inhoudsfilterresultaatitem dat aangeeft of de inhoud is gedetecteerd en of de inhoud is gefilterd.	No
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ detected	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	No
└─ filtered	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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
└─ filtered	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	No
└─ severity	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.

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

AzureCosmosDBChatDataSource

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

Name	Type	Description	Required	Default
parameters	object	De parameterinformatie voor het beheren van het gebruik van de Azure CosmosDB-gegevensbron.	Yes
└─ 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	False
└─ authentication	AzureChatDataSourceConnectionStringAuthenticationOptions		No
└─ container_name	string		No
└─ database_name	string		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	array		No
└─ content_fields_separator	string		No
└─ filepath_field	string		No
└─ title_field	string		No
└─ url_field	string		No
└─ vector_fields	array		No
└─ in_scope	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└─ include_contexts	array	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['citations', 'intent']
└─ index_name	string		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
└─ strictness	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`	Yes

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.

Name	Type	Description	Required	Default
audio	object	Parameters voor audio-uitvoer. Vereist wanneer audio-uitvoer wordt aangevraagd met `modalities: ["audio"]`.	No
└─ format	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
└─ voice	object		No
data_sources	array	De gegevensbronnen die moeten worden gebruikt voor de functie On Your Data, exclusief voor Azure OpenAI.	No
frequency_penalty	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	array	Afgeschaft ten gunste van `tools`. Een lijst met functies waarvoor het model JSON-invoer kan genereren.	No
logit_bias	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	None
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	False
max_completion_tokens	integer	Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een voltooiing, inclusief zichtbare uitvoertokens en redeneringstokens.	No
max_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
messages	array	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.	Yes
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
modalities	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	string	De modelimplementatie-id die moet worden gebruikt voor de voltooiingsaanvraag voor chats.	Yes
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_tool_calls	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
presence_penalty	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
reasoning_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
response_format	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	False
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	False
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
temperature	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	array	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	string	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.

Name	Type	Description	Required
choices	array		Yes
created	integer	De Unix-tijdstempel (in seconden) van het moment waarop de chat is voltooid.	Yes
id	string	Een unieke id voor het voltooien van de chat.	Yes
model	string	Het model dat wordt gebruikt voor het voltooien van de chat.	Yes
object	enum	Het objecttype, dat altijd `chat.completion`is. Mogelijke waarden: `chat.completion`	Yes
prompt_filter_results	array	De verantwoordelijke AI-inhoudsfilteraantekeningen die zijn gekoppeld aan promptinvoer in voltooiingen van chats.	No
system_fingerprint	string	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
usage	OpenAI.CompletionUsage	Gebruiksstatistieken voor de voltooiingsaanvraag.	No

AzureCreateChatCompletionStreamResponse

Name	Type	Description	Required	Default
choices	array	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}`.	Yes
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.	Yes
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
id	string	Een unieke id voor het voltooien van de chat. Elk segment heeft dezelfde id.	Yes
model	string	Het model om de voltooiing te genereren.	Yes
object	enum	Het objecttype, dat altijd `chat.completion.chunk`is. Mogelijke waarden: `chat.completion.chunk`	Yes
system_fingerprint	string	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
usage	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
└─ accepted_prediction_tokens	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
└─ reasoning_tokens	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
└─ total_tokens	integer	Het totale aantal tokens dat wordt gebruikt in de aanvraag (prompt + voltooiing).	No	0

AzureCreateEmbeddingRequest

Name	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
input	tekenreeks of matrix		Yes
model	string	Het model dat moet worden gebruikt voor de insluitingsaanvraag.	Yes
user	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateFileRequestMultiPart

Name	Type	Description	Required
expires_after	object		Yes
└─ anchor	AzureFileExpiryAnchor		No
└─ seconds	integer		No
file	string		Yes
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`	Yes

AzureCreateImageEditRequestMultiPart

Name	Type	Description	Required	Default
background	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
image	tekenreeks of matrix		Yes
mask	string		No
model	string	De modelimplementatie die moet worden gebruikt voor de bewerking voor het bewerken van afbeeldingen.	Yes
n	integer	Het aantal afbeeldingen dat moet worden gegenereerd. Moet tussen 1 en 10 zijn.	No	1
output_compression	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
output_format	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	string	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.	Yes
quality	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
response_format	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	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateImageRequest

Name	Type	Description	Required	Default
background	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	string	De modelimplementatie die moet worden gebruikt voor het genereren van installatiekopieën.	Yes
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
output_compression	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
output_format	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	string	Een tekstbeschrijving van de gewenste afbeelding(en).	Yes
quality	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
response_format	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
style	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	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No

AzureCreateResponse

Name	Type	Description	Required	Default
background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
include	array	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
input	tekenreeks of matrix		No
instructions	string	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
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	string	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	Yes
parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	No	True
previous_response_id	string	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	string	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└─ variables	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
└─ version	string	Optionele versie van de promptsjabloon.	No
reasoning	object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└─ effort	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
└─ summary	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	False
temperature	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
text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	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	array	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	string	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.

Name	Type	Description	Required	Default
input	string	De tekst voor het genereren van audio. De maximumlengte is 4096 tekens.	Yes
instructions	string	Beheer de stem van uw gegenereerde audio met aanvullende instructies. Werkt niet met `tts-1` of `tts-1-hd`.	No
model	string	Het model dat moet worden gebruikt voor deze tekst-naar-spraak-aanvraag.	Yes
response_format	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		Yes

AzureCreateTranscriptionRequestMultiPart

De configuratiegegevens voor een aanvraag voor audiotranscriptie.

Name	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
└─ 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`	No
file	string		Yes
filename	string	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens.	No
include[]	array	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	string	De taal van de invoeraudio. Het leveren van de invoertaal in ISO-639-1 -indeling (bijvoorbeeld `en`) verbetert de nauwkeurigheid en latentie.	No
model	string	Het model dat moet worden gebruikt voor deze transcriptieaanvraag.	No
prompt	string	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
response_format	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	False
temperature	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[]	array	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.

Name	Type	Description	Required	Default
file	string		Yes
filename	string	De optionele bestandsnaam of beschrijvende id die moet worden gekoppeld aan de audiogegevens	No
model	string	Het model dat moet worden gebruikt voor deze vertaalaanvraag.	No
prompt	string	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
response_format	object		No
temperature	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

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

AzureEvalAPICompletionsSamplingParams

Name	Type	Required
parallel_tool_calls	boolean	No
response_format	OpenAI.ResponseTextFormatConfiguration	No
tools	array	No

AzureEvalAPIModelSamplingParams

Name	Type	Description	Required
max_tokens	integer	Het maximum aantal tokens in de gegenereerde uitvoer.	No
reasoning_effort	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
temperature	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

Name	Type	Required
parallel_tool_calls	boolean	No
response_format	OpenAI.ResponseTextFormatConfiguration	No
tools	array	No

AzureFileExpiryAnchor

Property	Value
Type	string
Values	`created_at`

AzureFineTuneReinforcementMethod

Name	Type	Description	Required
grader	object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Yes
└─ calculate_output	string	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	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└─ model	string	Het model dat moet worden gebruikt voor de evaluatie.	No
└─ name	string	De naam van de cijferaar.	No
└─ operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ range	array	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ reference	string	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	OpenAI.FineTuneReinforcementHyperparameters	De hyperparameters die worden gebruikt voor de versterkingsafstemmingstaak.	No
response_format	object		No
└─ json_schema	object	JSON-schema voor de antwoordindeling	No
└─ type	enum	Type antwoordindeling. Mogelijke waarden: `json_schema`	No

AzureImage

Name	Type	Description	Required
b64_json	string	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.	Yes
prompt_filter_results	AzureContentFilterImagePromptResults	Een inhoudsfilterresultaat voor de invoeraanvraaginhoud van een afbeeldingsgeneratiebewerking.	Yes
revised_prompt	string	Alleen `dall-e-3` de herziene prompt die is gebruikt om de afbeelding te genereren.	No
url	string	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

Name	Type	Description	Required
background	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.	Yes
data	array		No
output_format	enum	De uitvoerindeling van de generatie van de installatiekopieën. Ofwel `png`, `webp`of `jpeg`. Mogelijke waarden: `png`, `webpjpeg`	No
quality	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
usage	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
└─ total_tokens	integer	Het totale aantal tokens (afbeeldingen en tekst) dat wordt gebruikt voor het genereren van afbeeldingen.	No

AzureListFilesResponse

Name	Type	Description	Required
data	array		Yes
first_id	string		Yes
has_more	boolean		Yes
last_id	string		Yes
object	enum	Mogelijke waarden: `list`	Yes

AzureOpenAIFile

Name	Type	Description	Required
bytes	integer	De grootte van het bestand, in bytes.	Yes
created_at	integer	De Unix-tijdstempel (in seconden) voor het moment waarop het bestand is gemaakt.	Yes
expires_at	integer	De Unix-tijdstempel (in seconden) voor wanneer het bestand verloopt.	No
filename	string	De naam van het bestand.	Yes
id	string	De bestands-id waarnaar kan worden verwezen in de API-eindpunten.	Yes
object	enum	Het objecttype, dat altijd `file`is. Mogelijke waarden: `file`	Yes
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`	Yes
status	enum	Mogelijke waarden: `uploaded`, `pending`, `running`, `processed`, , `errordeletingdeleted`	Yes
status_details	string	Deprecated. Zie het `error` veld op `fine_tuning.job`voor meer informatie over waarom de validatie van een trainingsbestand is mislukt.	No

AzureOpenAIVideoGenerationErrorResponse

Name	Type	Description	Required
code	string	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	string	Indien van toepassing, wordt de wijzigingsprompt gebruikt voor het genereren.	No
message	string	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	No
param	string	Indien van toepassing, de aanvraaginvoerparameter die is gekoppeld aan de fout	No
type	string	Indien van toepassing, is het nummer van de invoerregel gekoppeld aan de fout.	No

AzureResponse

Name	Type	Description	Required	Default
background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
error	object	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	No
└─ message	string	Een door mensen leesbare beschrijving van de fout.	No
id	string	Unieke id voor dit antwoord.	Yes
incomplete_details	object	Details over waarom het antwoord onvolledig is.	Yes
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
instructions	tekenreeks of matrix		Yes
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
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.	Yes
model	string	Het model dat wordt gebruikt om dit antwoord te genereren.	Yes
object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
output	array	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.	Yes
output_text	string	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.	Yes	True
previous_response_id	string	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	string	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└─ variables	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
└─ version	string	Optionele versie van de promptsjabloon.	No
reasoning	object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└─ effort	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
└─ summary	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
temperature	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.	Yes
text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	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	array	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.	Yes
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
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	Yes

AzureSearchChatDataSource

Vertegenwoordigt een gegevensbronconfiguratie die een Azure zoekresource gebruikt.

Name	Type	Description	Required	Default
parameters	object	De parameterinformatie voor het beheren van het gebruik van de Azure Gegevensbron zoeken.	Yes
└─ 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	False
└─ authentication	object		No
└─ access_token	string		No
└─ key	string		No
└─ managed_identity_resource_id	string		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
└─ authentication	AzureChatDataSourceApiKeyAuthenticationOptions of AzureChatDataSourceAccessTokenAuthenticationOptions	Het verificatiemechanisme voor gebruik met de vectorisatiebron op basis van eindpunten. Eindpuntverificatie ondersteunt API-sleutel- en toegangstokenmechanismen.	No
└─ deployment_name	string	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
└─ dimensions	integer	Het aantal dimensies dat moet worden aangevraagd voor insluitingen. Alleen ondersteund in 'text-embedding-3' en latere modellen.	No
└─ endpoint	string	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
└─ endpoint	string	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	array	De namen van indexvelden die als inhoud moeten worden behandeld.	No
└─ content_fields_separator	string	Het scheidingsteken dat inhoudsvelden moeten gebruiken.	No
└─ filepath_field	string	De naam van het indexveld dat moet worden gebruikt als bestandspad.	No
└─ image_vector_fields	array	De namen van velden die afbeeldingsvectorgegevens vertegenwoordigen.	No
└─ title_field	string	De naam van het indexveld dat moet worden gebruikt als titel.	No
└─ url_field	string	De naam van het indexveld dat moet worden gebruikt als URL.	No
└─ vector_fields	array	De namen van velden die vectorgegevens vertegenwoordigen.	No
└─ filter	string	Een filter dat moet worden toegepast op de zoekopdracht.	No
└─ in_scope	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└─ include_contexts	array	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['citations', 'intent']
└─ index_name	string	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	string	Aanvullende semantische configuratie voor de query.	No
└─ strictness	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`	Yes

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.

Name	Type	Description	Required
application_name	string	De naam van de toepassing. Gevoelige persoonlijke gegevens mogen niet worden opgenomen in dit veld.	No
end_user_id	string	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	string	De Microsoft 365 tenant-id waartoe de eindgebruiker behoort. Dit is vereist wanneer de generatieve AI-toepassing multitenant is.	No
source_ip	string	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

Name	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.	Yes
model	string	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Yes
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	string	De prompt voor deze videogeneratietaak.	Yes
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.	Yes

CreateVideoGenerationWithMediaRequestMultiPart

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

Name	Type	Description	Required	Default
files	array		Yes
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.	Yes
inpaint_items	array	Optionele inpainting-items voor deze videogeneratietaak.	No
model	string	De naam van de implementatie die voor deze aanvraag moet worden gebruikt.	Yes
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	string	De prompt voor deze videogeneratietaak.	Yes
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.	Yes

CropBounds

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

Name	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

Name	Type	Description	Required	Default
parameters	object	De parameterinformatie voor het beheren van het gebruik van de Elasticsearch-gegevensbron.	Yes
└─ 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	False
└─ authentication	object		No
└─ encoded_api_key	string		No
└─ key	string		No
└─ key_id	string		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
└─ endpoint	string		No
└─ fields_mapping	object		No
└─ content_fields	array		No
└─ content_fields_separator	string		No
└─ filepath_field	string		No
└─ title_field	string		No
└─ url_field	string		No
└─ vector_fields	array		No
└─ in_scope	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└─ include_contexts	array	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['citations', 'intent']
└─ index_name	string		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
└─ strictness	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`	Yes

InpaintItem

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

Name	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
file_name	string	De bestandsnaam van het media-item. Deze moet overeenkomen met de bestandsnaam van een bestandsbijlage in deze aanvraag.	Yes
frame_index	integer	De frameindex voor dit media-item. Hiermee geeft u het beginframe op in de resulterende gegenereerde video voor dit inpainting-item.	Yes	0
type	object	Het type van het inpainting-item.	Yes

JobStatus

De status van een videogeneratietaak.

Property	Value
Description	De status van een videogeneratietaak.
Type	string
Values	`preprocessing` `queued` `running` `processing` `cancelled` `succeeded` `failed`

MediaItemType

Het type van het inpainting-item.

Property	Value
Description	Het type van het inpainting-item.
Type	string
Values	`image`

MongoDBChatDataSource

Name	Type	Description	Required	Default
parameters	object	De parameterinformatie voor het beheren van het gebruik van de MongoDB-gegevensbron.	Yes
└─ 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	False
└─ app_name	string	De naam van de MongoDB-toepassing.	No
└─ authentication	object		No
└─ password	string		No
└─ type	enum	Mogelijke waarden: `username_and_password`	No
└─ username	string		No
└─ collection_name	string	De naam van de MongoDB-verzameling.	No
└─ database_name	string	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
└─ authentication	AzureChatDataSourceApiKeyAuthenticationOptions of AzureChatDataSourceAccessTokenAuthenticationOptions	Het verificatiemechanisme voor gebruik met de vectorisatiebron op basis van eindpunten. Eindpuntverificatie ondersteunt API-sleutel- en toegangstokenmechanismen.	No
└─ deployment_name	string	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
└─ dimensions	integer	Het aantal dimensies dat moet worden aangevraagd voor insluitingen. Alleen ondersteund in 'text-embedding-3' en latere modellen.	No
└─ endpoint	string	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
└─ endpoint	string	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	array		No
└─ content_fields_separator	string		No
└─ filepath_field	string		No
└─ title_field	string		No
└─ url_field	string		No
└─ vector_fields	array		No
└─ in_scope	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└─ include_contexts	array	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['citations', 'intent']
└─ index_name	string	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
└─ strictness	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`	Yes

OpenAI.Annotation

Discriminator voor OpenAI.Annotatie

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

Type Value	Schema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Name	Type	Description	Required	Default
type	OpenAI.AnnotationType		Yes

OpenAI.AnnotationFileCitation

Een bronvermelding naar een bestand.

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

OpenAI.AnnotationFilePath

Een pad naar een bestand.

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

OpenAI.AnnotationType

Property	Value
Type	string
Values	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

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

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

OpenAI.ApproximateLocation

Name	Type	Description	Required
city	string		No
country	string		No
region	string		No
timezone	string		No
type	enum	Mogelijke waarden: `approximate`	Yes

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`.
Type	string
Values	`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.

Name	Type	Description	Required	Default
type	enum	Altijd `auto`. Mogelijke waarden: `auto`	Yes

OpenAI.ChatCompletionFunctionCallOption

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

Name	Type	Description	Required	Default
name	string	De naam van de functie die moet worden aangeroepen.	Yes

OpenAI.ChatCompletionFunctions

Name	Type	Description	Required
description	string	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
name	string	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.	Yes
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

Name	Type	Required
data	string	No
expires_at	integer	No
id	string	No
transcript	string	No

OpenAI.ChatCompletionMessageToolCall

Name	Type	Description	Required
function	object	De functie die het model heeft aangeroepen.	Yes
└─ arguments	string	De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en parameters die niet door uw functieschema zijn gedefinieerd, halluvalideert. Valideer de argumenten in uw code voordat u de functie aanroept.	No
└─ name	string	De naam van de functie die moet worden aangeroepen.	No
id	string	De id van de aanroep van het hulpprogramma.	Yes
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name	Type	Description	Required
function	object		No
└─ arguments	string	De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling. Houd er rekening mee dat het model niet altijd geldige JSON genereert en parameters die niet door uw functieschema zijn gedefinieerd, halluvalideert. Valideer de argumenten in uw code voordat u de functie aanroept.	No
└─ name	string	De naam van de functie die moet worden aangeroepen.	No
id	string	De id van de aanroep van het hulpprogramma.	No
index	integer		Yes
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.

Name	Type	Description	Required
function	object		Yes
└─ name	string	De naam van de functie die moet worden aangeroepen.	No
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Yes

OpenAI.ChatCompletionRequestAssistantMessage

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

Name	Type	Description	Required
audio	object	Gegevens over een eerdere audioreactie van het model.	No
└─ id	string	Unieke id voor een vorige audioreactie van het model.	No
content	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
└─ arguments	string		No
└─ name	string		No
name	string	Een optionele naam voor de deelnemer. Biedt de modelinformatie om onderscheid te maken tussen deelnemers van dezelfde rol.	No
refusal	string	Het weigeringsbericht van de assistent.	No
role	enum	De rol van de auteur van berichten, in dit geval `assistant`. Mogelijke waarden: `assistant`	Yes
tool_calls	ChatCompletionMessageToolCallsItem	De hulpprogramma-aanroepen die door het model worden gegenereerd, zoals functie-aanroepen.	No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name	Type	Description	Required
refusal	string	Het weigeringsbericht dat door het model is gegenereerd.	Yes
text	string	De tekstinhoud.	Yes
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `refusal`	Yes

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.

Name	Type	Description	Required
content	tekenreeks of matrix		Yes
name	string	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`	Yes

OpenAI.ChatCompletionRequestFunctionMessage

Name	Type	Description	Required
content	string	De inhoud van het functiebericht.	Yes
name	string	De naam van de functie die moet worden aangeroepen.	Yes
role	enum	De rol van de auteur van berichten, in dit geval `function`. Mogelijke waarden: `function`	Yes

OpenAI.ChatCompletionRequestMessage

Discriminator voor OpenAI.ChatCompletionRequestMessage

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

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

Name	Type	Description	Required	Default
content	tekenreeks of matrix		No
role	object	De rol van de auteur van een bericht	Yes

OpenAI.ChatCompletionRequestMessageContentPart

Discriminator voor OpenAI.ChatCompletionRequestMessageContentPart

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

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

Name	Type	Description	Required	Default
type	OpenAI.ChatCompletionRequestMessageContentPartType		Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name	Type	Description	Required
input_audio	object		Yes
└─ data	string	Met Base64 gecodeerde audiogegevens.	No
└─ format	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`	Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name	Type	Description	Required
file	object		Yes
└─ file_data	string	De met base64 gecodeerde bestandsgegevens, die worden gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
└─ file_id	string	De id van een geüpload bestand dat moet worden gebruikt als invoer.	No
└─ filename	string	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`	Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name	Type	Description	Required
image_url	object		Yes
└─ detail	enum	Hiermee geeft u het detailniveau van de afbeelding op. Mogelijke waarden: `auto`, `lowhigh`	No
└─ url	string	Een URL van de afbeelding of de met base64 gecodeerde afbeeldingsgegevens.	No
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `image_url`	Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name	Type	Description	Required	Default
refusal	string	Het weigeringsbericht dat door het model is gegenereerd.	Yes
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `refusal`	Yes

OpenAI.ChatCompletionRequestMessageContentPartText

Name	Type	Description	Required	Default
text	string	De tekstinhoud.	Yes
type	enum	Het type inhoudsonderdeel. Mogelijke waarden: `text`	Yes

OpenAI.ChatCompletionRequestMessageContentPartType

Property	Value
Type	string
Values	`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.

Name	Type	Description	Required
content	tekenreeks of matrix		Yes
name	string	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`	Yes

OpenAI.ChatCompletionRequestSystemMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

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

OpenAI.ChatCompletionRequestToolMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

Name	Type	Description	Required
content	tekenreeks of matrix		Yes
name	string	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`	Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Name	Type	Description	Required
file	object		Yes
└─ file_data	string	De met base64 gecodeerde bestandsgegevens, die worden gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
└─ file_id	string	De id van een geüpload bestand dat moet worden gebruikt als invoer.	No
└─ filename	string	De naam van het bestand, dat wordt gebruikt bij het doorgeven van het bestand aan het model als een tekenreeks.	No
image_url	object		Yes
└─ detail	enum	Hiermee geeft u het detailniveau van de afbeelding op. Mogelijke waarden: `auto`, `lowhigh`	No
└─ url	string	Een URL van de afbeelding of de met base64 gecodeerde afbeeldingsgegevens.	No
input_audio	object		Yes
└─ data	string	Met Base64 gecodeerde audiogegevens.	No
└─ format	enum	De indeling van de gecodeerde audiogegevens. Ondersteunt momenteel 'wav' en 'mp3'. Mogelijke waarden: `wav`, `mp3`	No
text	string	De tekstinhoud.	Yes
type	enum	Het type inhoudsonderdeel. Altijd `file`. Mogelijke waarden: `file`	Yes

OpenAI.ChatCompletionRole

De rol van de auteur van een bericht

Property	Value
Description	De rol van de auteur van een bericht
Type	string
Values	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

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

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

Name	Type	Description	Required
audio	object		No
└─ data	string		No
└─ expires_at	integer		No
└─ id	string		No
└─ transcript	string		No
content	string	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
└─ arguments	string		No
└─ name	string		No
refusal	string	Het weigeringsbericht dat door het model is gegenereerd.	No
role	object	De rol van de auteur van een bericht	No
tool_calls	array		No

OpenAI.ChatCompletionTokenLogprob

Name	Type	Description	Required
bytes	array	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.	Yes
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.	Yes
token	string	The token.	Yes
top_logprobs	array	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.	Yes

OpenAI.ChatCompletionTool

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

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.

Name	Type	Description	Required
function	object		Yes
└─ name	string	De naam van de functie die moet worden aangeroepen.	No
type	enum	Het type hulpprogramma. Momenteel wordt alleen `function` ondersteund. Mogelijke waarden: `function`	Yes

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:

Type Value	Schema
`content`	OpenAI.ChatOutputPredictionContent

Name	Type	Description	Required	Default
type	OpenAI.ChatOutputPredictionType		Yes

OpenAI.ChatOutputPredictionContent

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

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

OpenAI.ChatOutputPredictionType

Property	Value
Type	string
Values	`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:

Type Value	Schema
`static`	OpenAI.StaticChunkingStrategyRequestParam

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

OpenAI.ChunkingStrategyResponseParam

Discriminator voor OpenAI.ChunkingStrategyResponseParam

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

Type Value	Schema
`other`	OpenAI.OtherChunkingStrategyResponseParam
`static`	OpenAI.StaticChunkingStrategyResponseParam

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `static`, `other`	Yes

OpenAI.CodeInterpreterOutput

Discriminator voor OpenAI.CodeInterpreterOutput

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

Type Value	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Name	Type	Description	Required	Default
type	OpenAI.CodeInterpreterOutputType		Yes

OpenAI.CodeInterpreterOutputImage

De uitvoer van de afbeelding van de code-interpreter.

Name	Type	Description	Required	Default
type	enum	Het type uitvoer. Always 'image'. Mogelijke waarden: `image`	Yes
url	string	De URL van de uitvoer van de afbeelding van de code-interpreter.	Yes

OpenAI.CodeInterpreterOutputLogs

De logboekuitvoer van de code-interpreter.

Name	Type	Description	Required	Default
logs	string	De logboekuitvoer van de code-interpreter.	Yes
type	enum	Het type uitvoer. Always 'logs'. Mogelijke waarden: `logs`	Yes

OpenAI.CodeInterpreterOutputType

Property	Value
Type	string
Values	`logs` `image`

OpenAI.CodeInterpreterTool

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

Name	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.	Yes
└─ file_ids	array	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`	Yes

OpenAI.CodeInterpreterToolAuto

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

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

OpenAI.CodeInterpreterToolCallItemParam

Een aanroep van een hulpprogramma om code uit te voeren.

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

OpenAI.CodeInterpreterToolCallItemResource

Een aanroep van een hulpprogramma om code uit te voeren.

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

OpenAI.ComparisonFilter

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

Name	Type	Description	Required
key	string	De sleutel die moet worden vergeleken met de waarde.	Yes
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`	Yes
value	tekenreeks of getal of booleaanse waarde		Yes

OpenAI.CompletionUsage

Gebruiksstatistieken voor de voltooiingsaanvraag.

Name	Type	Description	Required	Default
completion_tokens	integer	Aantal tokens in de gegenereerde voltooiing.	Yes	0
completion_tokens_details	object	Uitsplitsing van tokens die worden gebruikt in een voltooiing.	No
└─ accepted_prediction_tokens	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
└─ reasoning_tokens	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.	Yes	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).	Yes	0

OpenAI.CompoundFilter

Meerdere filters combineren met of andor.

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

OpenAI.ComputerAction

Discriminator voor OpenAI.ComputerAction

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

Type Value	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

Name	Type	Description	Required	Default
type	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionClick

Een klikactie.

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

OpenAI.ComputerActionDoubleClick

Een actie met dubbelklikken.

Name	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`	Yes
x	integer	De x-coördinaat waarop het dubbelklikken heeft plaatsgevonden.	Yes
y	integer	De y-coördinaat waar het dubbelklikken heeft plaatsgevonden.	Yes

OpenAI.ComputerActionDrag

Een sleepactie.

Name	Type	Description	Required	Default
path	array	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 }`	Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een sleepactie is deze eigenschap altijd ingesteld op `drag`. Mogelijke waarden: `drag`	Yes

OpenAI.ComputerActionKeyPress

Een verzameling toetsdrukken die het model wil uitvoeren.

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

OpenAI.ComputerActionMove

Een actie voor het verplaatsen van de muis.

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

OpenAI.ComputerActionScreenshot

Een schermopnameactie.

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

OpenAI.ComputerActionScroll

Een schuifactie.

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

OpenAI.ComputerActionType

Property	Value
Type	string
Values	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

Een actie om tekst te typen.

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

OpenAI.ComputerActionWait

Een wachtactie.

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

OpenAI.ComputerToolCallItemParam

Een hulpprogramma-aanroep naar een hulpprogramma voor computergebruik.

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

OpenAI.ComputerToolCallItemResource

Een hulpprogramma-aanroep naar een hulpprogramma voor computergebruik.

Name	Type	Description	Required
action	OpenAI.ComputerAction		Yes
call_id	string	Een id die wordt gebruikt bij het beantwoorden van de aanroep van het hulpprogramma met uitvoer.	Yes
pending_safety_checks	array	De in behandeling zijnde veiligheidscontroles voor de computeroproep.	Yes
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`	Yes
type	enum	Mogelijke waarden: `computer_call`	Yes

OpenAI.ComputerToolCallOutputItemOutput

Discriminator voor OpenAI.ComputerToolCallOutputItemOutput

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

Type Value	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

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

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	Type	Description	Required
file_id	string		No
image_url	string		No
type	enum	Mogelijke waarden: `computer_screenshot`	Yes

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.
Type	string
Values	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Type	Description	Required
acknowledged_safety_checks	array	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	string	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Yes
output	OpenAI.ComputerToolCallOutputItemOutput		Yes
type	enum	Mogelijke waarden: `computer_call_output`	Yes

OpenAI.ComputerToolCallOutputItemResource

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Type	Description	Required
acknowledged_safety_checks	array	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	string	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Yes
output	OpenAI.ComputerToolCallOutputItemOutput		Yes
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`	Yes
type	enum	Mogelijke waarden: `computer_call_output`	Yes

OpenAI.ComputerToolCallSafetyCheck

Een veiligheidscontrole in behandeling voor de computeroproep.

Name	Type	Description	Required
code	string	Het type van de in behandeling zijnde veiligheidscontrole.	Yes
id	string	De id van de in behandeling zijnde veiligheidscontrole.	Yes
message	string	Details over de in behandeling zijnde veiligheidscontrole.	Yes

OpenAI.ComputerUsePreviewTool

Een hulpprogramma waarmee een virtuele computer wordt bestuurd.

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

OpenAI.Coordinate

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

Name	Type	Description	Required	Default
x	integer	The x-coordinate.	Yes
y	integer	The y-coordinate.	Yes

OpenAI.CreateEmbeddingResponse

Name	Type	Description	Required
data	array	De lijst met insluitingen die door het model worden gegenereerd.	Yes
model	string	De naam van het model dat wordt gebruikt voor het genereren van de insluiting.	Yes
object	enum	Het objecttype, dat altijd 'list' is. Mogelijke waarden: `list`	Yes
usage	object	De gebruiksgegevens voor de aanvraag.	Yes
└─ prompt_tokens	integer	Het aantal tokens dat door de prompt wordt gebruikt.	No
└─ total_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}}.

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

OpenAI.CreateEvalRunRequest

Name	Type	Description	Required
data_source	object		Yes
└─ 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
name	string	De naam van de uitvoering.	No

OpenAI.CreateFineTuningJobRequest

Valid models:

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

Name	Type	Description	Required	Default
hyperparameters	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
integrations	array	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.	Yes
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
suffix	string	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	None
training_file	string	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.	Yes
validation_file	string	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:

Type Value	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	Type	Description	Required	Default
type	tekenreeks (zie geldige modellen hieronder)		Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	Type	Description	Required
type	enum	Mogelijke waarden: `wandb`	Yes
wandb	object		Yes
└─ entity	string		No
└─ name	string		No
└─ project	string		No
└─ tags	array		No

OpenAI.CreateVectorStoreFileBatchRequest

Name	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	array	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.	Yes

OpenAI.CreateVectorStoreFileRequest

Name	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	string	Een bestands-id die door het vectorarchief moet worden gebruikt. Handig voor hulpprogramma's zoals `file_search` die toegang hebben tot bestanden.	Yes

OpenAI.CreateVectorStoreRequest

Name	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
└─ static	OpenAI.StaticChunkingStrategy		No
└─ type	enum	Altijd `static`. Mogelijke waarden: `static`	No
expires_after	OpenAI.VectorStoreExpirationAfter	Het verloopbeleid voor een vectorarchief.	No
file_ids	array	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
name	string	De naam van het vectorarchief.	No

OpenAI.DeleteFileResponse

Name	Type	Description	Required
deleted	boolean		Yes
id	string		Yes
object	enum	Mogelijke waarden: `file`	Yes

OpenAI.DeleteVectorStoreFileResponse

Name	Type	Description	Required
deleted	boolean		Yes
id	string		Yes
object	enum	Mogelijke waarden: `vector_store.file.deleted`	Yes

OpenAI.DeleteVectorStoreResponse

Name	Type	Description	Required
deleted	boolean		Yes
id	string		Yes
object	enum	Mogelijke waarden: `vector_store.deleted`	Yes

OpenAI.Embedding

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

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

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. Like:

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

Name	Type	Description	Required	Default
created_at	integer	De Unix-tijdstempel (in seconden) voor het moment waarop de eval is gemaakt.	Yes
data_source_config	object		Yes
└─ type	OpenAI.EvalDataSourceConfigType		No
id	string	Unieke id voor de evaluatie.	Yes
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.	Yes
name	string	De naam van de evaluatie.	Yes
object	enum	Het objecttype. Mogelijke waarden: `eval`	Yes
testing_criteria	array	Een lijst met testcriteria.	Yes	None

OpenAI.EvalApiError

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

Name	Type	Description	Required	Default
code	string	De foutcode.	Yes
message	string	Het foutbericht.	Yes

OpenAI.EvalCompletionsRunDataSourceParams

Een CompletionsRunDataSource-object met een beschrijving van een modelsamplingconfiguratie.

Name	Type	Description	Required
input_messages	object		No
└─ item_reference	string	Een verwijzing naar een variabele in de `item` naamruimte. Ie, "item.input_trajectory"	No
└─ template	array	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	string	De naam van het model dat moet worden gebruikt voor het genereren van voltooiingen (bijvoorbeeld 'o3-mini').	No
sampling_params	AzureEvalAPICompletionsSamplingParams		No
source	object		Yes
└─ content	array	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	string	De id van het bestand.	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.	No
└─ model	string	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`	Yes

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

Name	Type	Description	Required	Default
include_sample_schema	boolean	Of de evaluatie verwacht dat u de voorbeeldnaamruimte vult (bijvoorbeeld door antwoorden van uw gegevensbron te genereren)	No	False
item_schema	object	Het json-schema voor elke rij in de gegevensbron.	Yes
type	enum	Het type gegevensbron. Altijd `custom`. Mogelijke waarden: `custom`	Yes

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

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

OpenAI.EvalDataSourceConfigParams

Discriminator voor OpenAI.EvalDataSourceConfigParams

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

Type Value	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigParams
`logs`	OpenAI.EvalLogsDataSourceConfigParams
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Name	Type	Description	Required	Default
type	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigResource

Discriminator voor OpenAI.EvalDataSourceConfigResource

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

Type Value	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigResource
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigResource
`logs`	OpenAI.EvalLogsDataSourceConfigResource

Name	Type	Description	Required	Default
type	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigType

Property	Value
Type	string
Values	`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.

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

OpenAI.EvalGraderLabelModelResource

Name	Type	Description	Required
input	array		Yes
labels	array	De labels die aan elk item in de evaluatie moeten worden toegewezen.	Yes
model	string	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Yes
name	string	De naam van de cijferaar.	Yes
passing_labels	array	De labels die een doorgevend resultaat aangeven. Moet een subset van labels zijn.	Yes
type	enum	Het objecttype, dat altijd `label_model`is. Mogelijke waarden: `label_model`	Yes

OpenAI.EvalGraderParams

Discriminator voor OpenAI.EvalGraderParams

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

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

Name	Type	Description	Required	Default
type	OpenAI.GraderType		Yes

OpenAI.EvalGraderPythonParams

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

OpenAI.EvalGraderPythonResource

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

OpenAI.EvalGraderResource

Discriminator voor OpenAI.EvalGraderResource

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

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

Name	Type	Description	Required	Default
type	OpenAI.GraderType		Yes

OpenAI.EvalGraderScoreModelParams

Name	Type	Description	Required
input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
model	string	Het model dat moet worden gebruikt voor de evaluatie.	Yes
name	string	De naam van de cijferaar.	Yes
pass_threshold	number	De drempelwaarde voor de score.	No
range	array	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`	Yes

OpenAI.EvalGraderScoreModelResource

Name	Type	Description	Required
input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
model	string	Het model dat moet worden gebruikt voor de evaluatie.	Yes
name	string	De naam van de cijferaar.	Yes
pass_threshold	number	De drempelwaarde voor de score.	No
range	array	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`	Yes

OpenAI.EvalGraderStringCheckParams

Name	Type	Description	Required
input	string	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
name	string	De naam van de cijferaar.	Yes
operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	Yes
reference	string	De verwijzingstekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
type	enum	Het objecttype, dat altijd `string_check`is. Mogelijke waarden: `string_check`	Yes

OpenAI.EvalGraderTextSimilarityParams

Name	Type	Description	Required
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`	Yes
input	string	De tekst die wordt beoordeeld.	Yes
name	string	De naam van de cijferaar.	Yes
pass_threshold	number	De drempelwaarde voor de score.	Yes
reference	string	De tekst wordt beoordeeld op basis van.	Yes
type	enum	Het type cijfer. Mogelijke waarden: `text_similarity`	Yes

OpenAI.EvalGraderTextSimilarityResource

Name	Type	Description	Required
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`	Yes
input	string	De tekst die wordt beoordeeld.	Yes
name	string	De naam van de cijferaar.	Yes
pass_threshold	number	De drempelwaarde voor de score.	Yes
reference	string	De tekst wordt beoordeeld op basis van.	Yes
type	enum	Het type cijfer. Mogelijke waarden: `text_similarity`	Yes

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.

Name	Type	Description	Required
content	object		Yes
└─ type	OpenAI.EvalItemContentType		No
role	enum	De rol van de berichtinvoer. Een van`user`, `assistant`, of `systemdeveloper`. Mogelijke waarden: `user`, `assistant`, , `systemdeveloper`	Yes
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:

Type Value	Schema
`input_text`	OpenAI.EvalItemContentInputText
`output_text`	OpenAI.EvalItemContentOutputText

Name	Type	Description	Required	Default
type	OpenAI.EvalItemContentType		Yes

OpenAI.EvalItemContentInputText

Name	Type	Description	Required	Default
text	string		Yes
type	enum	Mogelijke waarden: `input_text`	Yes

OpenAI.EvalItemContentOutputText

Name	Type	Description	Required	Default
text	string		Yes
type	enum	Mogelijke waarden: `output_text`	Yes

OpenAI.EvalItemContentType

Property	Value
Type	string
Values	`input_text` `output_text`

OpenAI.EvalJsonlRunDataSourceParams

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

Name	Type	Description	Required
source	object		Yes
└─ content	array	De inhoud van het jsonl-bestand.	No
└─ id	string	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`	Yes

OpenAI.EvalList

Een object dat een lijst met evals vertegenwoordigt.

Name	Type	Description	Required
data	array	Een matrix met evaluatieobjecten.	Yes
first_id	string	De id van de eersteval in de gegevensmatrix.	Yes
has_more	boolean	Geeft aan of er meer evaluaties beschikbaar zijn.	Yes
last_id	string	De id van de laatsteval in de gegevensmatrix.	Yes
object	enum	Het type van dit object. Deze is altijd ingesteld op 'list'. Mogelijke waarden: `list`	Yes

OpenAI.EvalLogsDataSourceConfigParams

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

Name	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`	Yes

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.

Name	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.	Yes
schema	object	Het json-schema voor de gegevensbronitems uitvoeren. Leer hier hoe u JSON-schema's bouwt.	Yes
type	enum	Het type gegevensbron. Altijd `logs`. Mogelijke waarden: `logs`	Yes

OpenAI.EvalResponsesRunDataSourceParams

Een ResponsesRunDataSource-object waarin een modelsamplingconfiguratie wordt beschreven.

Name	Type	Description	Required
input_messages	object		No
└─ item_reference	string	Een verwijzing naar een variabele in de `item` naamruimte. Ie, "item.name"	No
└─ template	array	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	string	De naam van het model dat moet worden gebruikt voor het genereren van voltooiingen (bijvoorbeeld 'o3-mini').	No
sampling_params	AzureEvalAPIResponseSamplingParams		No
source	object		Yes
└─ content	array	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	string	De id van het bestand.	No
└─ instructions_search	string	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	string	De naam van het model waarvoor antwoorden moeten worden gezocht. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└─ reasoning_effort	OpenAI.ReasoningEffort	Optionele redeneringsinspanningsparameter. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└─ temperature	number	Sampling temperature. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
└─ tools	array	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
└─ users	array	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`	Yes

OpenAI.EvalRun

Een schema dat een evaluatieuitvoering vertegenwoordigt.

Name	Type	Description	Required
created_at	integer	Unix-tijdstempel (in seconden) wanneer de evaluatieuitvoering is gemaakt.	Yes
data_source	object		Yes
└─ type	OpenAI.EvalRunDataSourceType		No
error	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	Yes
eval_id	string	De id van de bijbehorende evaluatie.	Yes
id	string	Unieke id voor de evaluatieuitvoering.	Yes
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.	Yes
model	string	Het model dat wordt geëvalueerd, indien van toepassing.	Yes
name	string	De naam van de evaluatieuitvoering.	Yes
object	enum	Het type object. Always "eval.run". Mogelijke waarden: `eval.run`	Yes
per_model_usage	array	Gebruiksstatistieken voor elk model tijdens de evaluatieuitvoering.	Yes
per_testing_criteria_results	array	Resultaten per testcriteria die zijn toegepast tijdens de evaluatieuitvoering.	Yes
report_url	string	De URL naar het weergegeven evaluatierapport op het UI-dashboard.	Yes
result_counts	object	Tellers die de resultaten van de evaluatieuitvoering samenvatten.	Yes
└─ errored	integer	Aantal uitvoeritems dat heeft geresulteerd in een fout.	No
└─ failed	integer	Aantal uitvoeritems dat de evaluatie niet heeft doorstaan.	No
└─ passed	integer	Aantal uitvoeritems dat de evaluatie heeft doorstaan.	No
└─ total	integer	Totaal aantal uitgevoerde uitvoeritems.	No
status	string	De status van de evaluatieuitvoering.	Yes

OpenAI.EvalRunDataContentSource

Discriminator voor OpenAI.EvalRunDataContentSource

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

Type Value	Schema
`file_id`	OpenAI.EvalRunFileIdDataContentSource
`stored_completions`	OpenAI.EvalRunStoredCompletionsDataContentSource
`responses`	OpenAI.EvalRunResponsesDataContentSource

Name	Type	Description	Required	Default
type	OpenAI.EvalRunDataContentSourceType		Yes

OpenAI.EvalRunDataContentSourceType

Property	Value
Type	string
Values	`file_id` `file_content` `stored_completions` `responses`

OpenAI.EvalRunDataSourceCompletionsResource

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `completions`	Yes

OpenAI.EvalRunDataSourceJsonlResource

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `jsonl`	Yes

OpenAI.EvalRunDataSourceParams

Discriminator voor OpenAI.EvalRunDataSourceParams

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

Type Value	Schema
`jsonl`	OpenAI.EvalJsonlRunDataSourceParams
`completions`	OpenAI.EvalCompletionsRunDataSourceParams
`responses`	OpenAI.EvalResponsesRunDataSourceParams

Name	Type	Description	Required	Default
type	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResource

Name	Type	Description	Required	Default
type	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResponsesResource

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `responses`	Yes

OpenAI.EvalRunDataSourceType

Property	Value
Type	string
Values	`jsonl` `completions` `responses`

OpenAI.EvalRunFileContentDataContentSource

Name	Type	Description	Required	Default
content	array	De inhoud van het jsonl-bestand.	Yes
type	enum	Het type jsonl-bron. Altijd `file_content`. Mogelijke waarden: `file_content`	Yes

OpenAI.EvalRunFileIdDataContentSource

Name	Type	Description	Required	Default
id	string	De id van het bestand.	Yes
type	enum	Het type jsonl-bron. Altijd `file_id`. Mogelijke waarden: `file_id`	Yes

OpenAI.EvalRunList

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

Name	Type	Description	Required
data	array	Een matrix met evaluatie-uitvoeringsobjecten.	Yes
first_id	string	De id van de eerste evaluatieuitvoering in de gegevensmatrix.	Yes
has_more	boolean	Geeft aan of er meer evaluaties beschikbaar zijn.	Yes
last_id	string	De id van de laatste evaluatieuitvoering in de gegevensmatrix.	Yes
object	enum	Het type van dit object. Deze is altijd ingesteld op 'list'. Mogelijke waarden: `list`	Yes

OpenAI.EvalRunOutputItem

Een schema dat een uitvoeritem voor de evaluatieuitvoering vertegenwoordigt.

Name	Type	Description	Required
created_at	integer	Unix-tijdstempel (in seconden) wanneer de evaluatieuitvoering is gemaakt.	Yes
datasource_item	object	Details van het invoergegevensbronitem.	Yes
datasource_item_id	integer	De id voor het gegevensbronitem.	Yes
eval_id	string	De id van de evaluatiegroep.	Yes
id	string	Unieke id voor het uitvoeritem van de evaluatieuitvoering.	Yes
object	enum	Het type object. Always "eval.run.output_item". Mogelijke waarden: `eval.run.output_item`	Yes
results	array	Een lijst met resultaten uit de evaluatieuitvoering.	Yes
run_id	string	De id van de evaluatieuitvoering die is gekoppeld aan dit uitvoeritem.	Yes
sample	object	Een voorbeeld met de invoer en uitvoer van de evaluatieuitvoering.	Yes
└─ error	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	No
└─ finish_reason	string	De reden waarom de voorbeeldgeneratie is voltooid.	No
└─ input	array	Een matrix met invoerberichten.	No
└─ max_completion_tokens	integer	Het maximum aantal tokens dat is toegestaan voor voltooiing.	No
└─ model	string	Het model dat wordt gebruikt voor het genereren van het voorbeeld.	No
└─ output	array	Een matrix met uitvoerberichten.	No
└─ seed	integer	Het zaad dat wordt gebruikt voor het genereren van het voorbeeld.	No
└─ temperature	number	De gebruikte steekproeftemperatuur.	No
└─ top_p	number	De top_p waarde die wordt gebruikt voor steekproeven.	No
└─ usage	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
└─ total_tokens	integer	Het totale aantal gebruikte tokens.	No
status	string	De status van de evaluatieuitvoering.	Yes

OpenAI.EvalRunOutputItemList

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

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

OpenAI.EvalRunResponsesDataContentSource

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

Name	Type	Description	Required
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
instructions_search	string	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	string	De naam van het model waarvoor antwoorden moeten worden gezocht. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
reasoning_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
temperature	number	Sampling temperature. Dit is een queryparameter die wordt gebruikt om antwoorden te selecteren.	No
tools	array	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`	Yes
users	array	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

Name	Type	Description	Required
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
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.	Yes
model	string	Een optioneel model om op te filteren (bijvoorbeeld 'gpt-4o').	No
type	enum	Het type bron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Afgeschaft ten gunste van LogsDataSourceConfig.

Name	Type	Description	Required	Default
metadata	object	Metagegevensfilters voor de opgeslagen voltooiingsgegevensbron.	No
type	enum	Het type gegevensbron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Afgeschaft ten gunste van LogsDataSourceConfig.

Name	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.	Yes
schema	object	Het json-schema voor de gegevensbronitems uitvoeren. Leer hier hoe u JSON-schema's bouwt.	Yes
type	enum	Het type gegevensbron. Altijd `stored_completions`. Mogelijke waarden: `stored_completions`	Yes

OpenAI.FileSearchTool

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

Name	Type	Description	Required
filters	object		No
max_num_results	integer	Het maximum aantal resultaten dat moet worden geretourneerd. Dit getal moet tussen 1 en 50 liggen.	No
ranking_options	object		No
└─ ranker	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`	Yes
vector_store_ids	array	De id's van de vectorarchieven om te zoeken.	Yes

OpenAI.FileSearchToolCallItemParam

De resultaten van een aanroep van een zoekprogramma voor bestanden.

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

OpenAI.FileSearchToolCallItemResource

De resultaten van een aanroep van een zoekprogramma voor bestanden.

Name	Type	Description	Required
queries	array	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	array	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`	Yes
type	enum	Mogelijke waarden: `file_search_call`	Yes

OpenAI.Filters

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

OpenAI.FineTuneDPOHyperparameters

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

Name	Type	Description	Required
batch_size	enum	Mogelijke waarden: `auto`	No
beta	enum	Mogelijke waarden: `auto`	No
learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
n_epochs	enum	Mogelijke waarden: `auto`	No

OpenAI.FineTuneDPOMethod

Configuratie voor de methode voor het afstemmen van de DPO.

Name	Type	Description	Required	Default
hyperparameters	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.

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

OpenAI.FineTuneReinforcementHyperparameters

De hyperparameters die worden gebruikt voor de versterkingsafstemmingstaak.

Name	Type	Description	Required
batch_size	enum	Mogelijke waarden: `auto`	No
compute_multiplier	enum	Mogelijke waarden: `auto`	No
eval_interval	enum	Mogelijke waarden: `auto`	No
eval_samples	enum	Mogelijke waarden: `auto`	No
learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
n_epochs	enum	Mogelijke waarden: `auto`	No
reasoning_effort	enum	Niveau van redeneringsinspanning. Mogelijke waarden: `default`, `low`, , `mediumhigh`	No

OpenAI.FineTuneSupervisedHyperparameters

De hyperparameters die worden gebruikt voor de afstemmingstaak.

Name	Type	Description	Required
batch_size	enum	Mogelijke waarden: `auto`	No
learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
n_epochs	enum	Mogelijke waarden: `auto`	No

OpenAI.FineTuneSupervisedMethod

Configuratie voor de afstemmingsmethode onder supervisie.

Name	Type	Description	Required	Default
hyperparameters	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:

Type Value	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

Name	Type	Description	Required	Default
type	tekenreeks (zie geldige modellen hieronder)		Yes

OpenAI.FineTuningIntegrationWandb

Name	Type	Description	Required
type	enum	Het type integratie dat wordt ingeschakeld voor de taak voor het afstemmen van de taak. Mogelijke waarden: `wandb`	Yes
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.	Yes
└─ entity	string	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
└─ name	string	Een weergavenaam die moet worden ingesteld voor de uitvoering. Als deze niet is ingesteld, gebruiken we de taak-id als de naam.	No
└─ project	string	De naam van het project waaronder de nieuwe uitvoering wordt gemaakt.	No
└─ tags	array	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.

Name	Type	Description	Required
created_at	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen is gemaakt.	Yes
error	object	Voor het afstemmen van taken die deze hebben `failed`, bevat dit meer informatie over de oorzaak van de fout.	Yes
└─ code	string	Een machineleesbare foutcode.	No
└─ message	string	Een door mensen leesbaar foutbericht.	No
└─ param	string	De parameter die ongeldig was, meestal `training_file` of `validation_file`. Dit veld is null als de fout niet parameterspecifiek is.	No
estimated_finish	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	string	De naam van het nauwkeurig afgestemde model dat wordt gemaakt. De waarde is null als de taak voor het afstemmen nog steeds wordt uitgevoerd.	Yes
finished_at	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.	Yes
hyperparameters	object	De hyperparameters die worden gebruikt voor de afstemmingstaak. Deze waarde wordt alleen geretourneerd bij het uitvoeren `supervised` van taken.	Yes
└─ batch_size	enum	Mogelijke waarden: `auto`	No
└─ learning_rate_multiplier	enum	Mogelijke waarden: `auto`	No
└─ n_epochs	enum	Mogelijke waarden: `auto`	No
id	string	De object-id waarnaar kan worden verwezen in de API-eindpunten.	Yes
integrations	array	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.	Yes
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	string	Het basismodel dat wordt afgestemd.	Yes
object	enum	Het objecttype, dat altijd fine_tuning.job is. Mogelijke waarden: `fine_tuning.job`	Yes
organization_id	string	De organisatie die eigenaar is van de afstemmingstaak.	Yes
result_files	array	De gecompileerde resultatenbestands-id('s) voor de taak voor het afstemmen. U kunt de resultaten ophalen met de Files-API.	Yes
seed	integer	Het zaad dat wordt gebruikt voor de verfijningstaak.	Yes
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`	Yes
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.	Yes
training_file	string	De bestands-id die wordt gebruikt voor de training. U kunt de trainingsgegevens ophalen met de Files-API.	Yes
user_provided_suffix	string	Het beschrijvende achtervoegsel dat is toegepast op de taak, zoals opgegeven in de aanvraag voor het maken van de taak.	No
validation_file	string	De bestands-id die wordt gebruikt voor validatie. U kunt de validatieresultaten ophalen met de Files-API.	Yes

OpenAI.FineTuningJobCheckpoint

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

Name	Type	Description	Required
created_at	integer	De Unix-tijdstempel (in seconden) voor wanneer het controlepunt is gemaakt.	Yes
fine_tuned_model_checkpoint	string	De naam van het nauwkeurig afgestemde controlepuntmodel dat wordt gemaakt.	Yes
fine_tuning_job_id	string	De naam van de taak voor het afstemmen waarvan dit controlepunt is gemaakt.	Yes
id	string	De controlepunt-id waarnaar kan worden verwezen in de API-eindpunten.	Yes
metrics	object	Metrische gegevens op het stapnummer tijdens de taak voor het afstemmen.	Yes
└─ full_valid_loss	number		No
└─ full_valid_mean_token_accuracy	number		No
└─ step	number		No
└─ train_loss	number		No
└─ train_mean_token_accuracy	number		No
└─ valid_loss	number		No
└─ valid_mean_token_accuracy	number		No
object	enum	Het objecttype, dat altijd 'fine_tuning.job.checkpoint' is. Mogelijke waarden: `fine_tuning.job.checkpoint`	Yes
step_number	integer	Het stapnummer waarop het controlepunt is gemaakt.	Yes

OpenAI.FineTuningJobEvent

Taakgebeurtenisobject verfijnen

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

OpenAI.FunctionObject

Name	Type	Description	Required	Default
description	string	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
name	string	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.	Yes
parameters		De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	No
strict	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	False

OpenAI.FunctionTool

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

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

OpenAI.FunctionToolCallItemParam

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

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

OpenAI.FunctionToolCallItemResource

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

Name	Type	Description	Required
arguments	string	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	string	De unieke id van de aanroep van het functiehulpprogramma die door het model is gegenereerd.	Yes
name	string	De naam van de functie die moet worden uitgevoerd.	Yes
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`	Yes
type	enum	Mogelijke waarden: `function_call`	Yes

OpenAI.FunctionToolCallOutputItemParam

De uitvoer van een functiehulpmiddeloproep.

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

OpenAI.FunctionToolCallOutputItemResource

De uitvoer van een functiehulpmiddeloproep.

Name	Type	Description	Required
call_id	string	De unieke id van de aanroep van het functiehulpprogramma die door het model is gegenereerd.	Yes
output	string	Een JSON-tekenreeks van de uitvoer van de functietool-aanroep.	Yes
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`	Yes
type	enum	Mogelijke waarden: `function_call_output`	Yes

OpenAI.Grader

Discriminator voor OpenAI.Grader

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

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

Name	Type	Description	Required	Default
type	OpenAI.GraderType		Yes

OpenAI.GraderLabelModel

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

Name	Type	Description	Required
input	array		Yes
labels	array	De labels die aan elk item in de evaluatie moeten worden toegewezen.	Yes
model	string	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Yes
name	string	De naam van de cijferaar.	Yes
passing_labels	array	De labels die een doorgevend resultaat aangeven. Moet een subset van labels zijn.	Yes
type	enum	Het objecttype, dat altijd `label_model`is. Mogelijke waarden: `label_model`	Yes

OpenAI.GraderMulti

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

Name	Type	Description	Required
calculate_output	string	Een formule om de uitvoer te berekenen op basis van cijferresultaten.	Yes
graders	object		Yes
name	string	De naam van de cijferaar.	Yes
type	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	Yes

OpenAI.GraderPython

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

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

OpenAI.GraderScoreModel

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

Name	Type	Description	Required
input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
model	string	Het model dat moet worden gebruikt voor de evaluatie.	Yes
name	string	De naam van de cijferaar.	Yes
range	array	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`	Yes

OpenAI.GraderStringCheck

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

Name	Type	Description	Required
input	string	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
name	string	De naam van de cijferaar.	Yes
operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	Yes
reference	string	De verwijzingstekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
type	enum	Het objecttype, dat altijd `string_check`is. Mogelijke waarden: `string_check`	Yes

OpenAI.GraderTextSimilarity

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

Name	Type	Description	Required
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`	Yes
input	string	De tekst die wordt beoordeeld.	Yes
name	string	De naam van de cijferaar.	Yes
reference	string	De tekst wordt beoordeeld op basis van.	Yes
type	enum	Het type cijfer. Mogelijke waarden: `text_similarity`	Yes

OpenAI.GraderType

Property	Value
Type	string
Values	`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.

Name	Type	Description	Required	Default
background	enum	ALLEEN GPT-image-1: achtergrondtype voor de gegenereerde afbeelding. Een van `transparent`, `opaque`of `auto`. Standaard: `auto`. Mogelijke waarden: `transparent`, `opaqueauto`	No
input_image_mask	object	Optioneel masker voor inpainting. Bevat `image_url` (tekenreeks, optioneel) en `file_id` (tekenreeks, optioneel).	No
└─ file_id	string	Bestands-id voor de maskerafbeelding.	No
└─ image_url	string	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
output_compression	integer	Compressieniveau voor de uitvoerafbeelding. Default: 100.	No	100
output_format	enum	De uitvoerindeling van de gegenereerde afbeelding. Een van `png`, `webp`of `jpeg`. Standaard: `png`. Mogelijke waarden: `png`, `webpjpeg`	No
partial_images	integer	Aantal gedeeltelijke afbeeldingen dat moet worden gegenereerd in de streamingmodus, van 0 (standaardwaarde) tot 3.	No	0
quality	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`	Yes

OpenAI.ImageGenToolCallItemParam

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Type	Description	Required	Default
result	string	De gegenereerde installatiekopieën die zijn gecodeerd in base64.	Yes
type	enum	Mogelijke waarden: `image_generation_call`	Yes

OpenAI.ImageGenToolCallItemResource

Een aanvraag voor het genereren van afbeeldingen door het model.

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

OpenAI.ImplicitUserMessage

Name	Type	Description	Required	Default
content	tekenreeks of matrix		Yes

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).
Type	string
Values	`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:

Type Value	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

Name	Type	Description	Required	Default
type	OpenAI.ItemContentType	Multimodale invoer- en uitvoerinhoud.	Yes

OpenAI.ItemContentInputAudio

Een audio-invoer voor het model.

Name	Type	Description	Required
data	string	Met Base64 gecodeerde audiogegevens.	Yes
format	enum	De indeling van de audiogegevens. Momenteel ondersteunde indelingen zijn `mp3` en `wav`. Mogelijke waarden: `mp3`, `wav`	Yes
type	enum	Het type invoeritem. Altijd `input_audio`. Mogelijke waarden: `input_audio`	Yes

OpenAI.ItemContentInputFile

Een bestandsinvoer voor het model.

Name	Type	Description	Required
file_data	string	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	string	De id van het bestand dat naar het model moet worden verzonden.	No
filename	string	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`	Yes

OpenAI.ItemContentInputImage

Een afbeeldingsinvoer voor het model.

Name	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	string	De id van het bestand dat naar het model moet worden verzonden.	No
image_url	string	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`	Yes

OpenAI.ItemContentInputText

Een tekstinvoer voor het model.

Name	Type	Description	Required	Default
text	string	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Yes

OpenAI.ItemContentOutputAudio

Een audio-uitvoer van het model.

Name	Type	Description	Required
data	string	Met Base64 gecodeerde audiogegevens uit het model.	Yes
transcript	string	Het transcript van de audiogegevens van het model.	Yes
type	enum	Het type uitvoeraudio. Altijd `output_audio`. Mogelijke waarden: `output_audio`	Yes

OpenAI.ItemContentOutputText

Een tekstuitvoer van het model.

Name	Type	Description	Required
annotations	array	De aantekeningen van de tekstuitvoer.	Yes
logprobs	array		No
text	string	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd `output_text`. Mogelijke waarden: `output_text`	Yes

OpenAI.ItemContentRefusal

Een weigering van het model.

Name	Type	Description	Required	Default
refusal	string	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd `refusal`. Mogelijke waarden: `refusal`	Yes

OpenAI.ItemContentType

Multimodale invoer- en uitvoerinhoud.

Property	Value
Description	Multimodale invoer- en uitvoerinhoud.
Type	string
Values	`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:

Type Value	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

Name	Type	Description	Required	Default
type	OpenAI.ItemType		Yes

OpenAI.ItemReferenceItemParam

Een interne id voor een item waarnaar moet worden verwezen.

Name	Type	Description	Required	Default
id	string	De service-id van het eerder gegenereerde antwoorditem waarnaar wordt verwezen.	Yes
type	enum	Mogelijke waarden: `item_reference`	Yes

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:

Type Value	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

Name	Type	Description	Required	Default
id	string		Yes
type	OpenAI.ItemType		Yes

OpenAI.ItemType

Property	Value
Type	string
Values	`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

Name	Type	Description	Required
data	array		Yes
first_id	string		No
has_more	boolean		Yes
last_id	string		No
object	enum	Mogelijke waarden: `list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Name	Type	Description	Required
data	array		Yes
has_more	boolean		Yes
object	enum	Mogelijke waarden: `list`	Yes

OpenAI.ListModelsResponse

Name	Type	Description	Required	Default
data	array		Yes
object	enum	Mogelijke waarden: `list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Type	Description	Required
data	array		Yes
has_more	boolean		Yes
object	enum	Mogelijke waarden: `list`	Yes

OpenAI.ListVectorStoreFilesFilter

Property	Value
Type	string
Values	`in_progress` `completed` `failed` `cancelled`

OpenAI.ListVectorStoreFilesResponse

Name	Type	Description	Required
data	array		Yes
first_id	string		Yes
has_more	boolean		Yes
last_id	string		Yes
object	enum	Mogelijke waarden: `list`	Yes

OpenAI.ListVectorStoresResponse

Name	Type	Description	Required
data	array		Yes
first_id	string		Yes
has_more	boolean		Yes
last_id	string		Yes
object	enum	Mogelijke waarden: `list`	Yes

OpenAI.LocalShellExecAction

Voer een shell-opdracht uit op de server.

Name	Type	Description	Required
command	array	De opdracht die moet worden uitgevoerd.	Yes
env	object	Omgevingsvariabelen die moeten worden ingesteld voor de opdracht.	Yes
timeout_ms	integer	Optionele time-out in milliseconden voor de opdracht.	No
type	enum	Het type lokale shell-actie. Altijd `exec`. Mogelijke waarden: `exec`	Yes
user	string	Optionele gebruiker om de opdracht uit te voeren als.	No
working_directory	string	Optionele werkmap waarin de opdracht moet worden uitgevoerd.	No

OpenAI.LocalShellTool

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

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

OpenAI.LocalShellToolCallItemParam

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

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

OpenAI.LocalShellToolCallItemResource

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

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

OpenAI.LocalShellToolCallOutputItemParam

De uitvoer van een lokale shell tool aanroep.

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

OpenAI.LocalShellToolCallOutputItemResource

De uitvoer van een lokale shell tool aanroep.

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

OpenAI.Location

Discriminator voor OpenAI.Location

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

Type Value	Schema
`approximate`	OpenAI.ApproximateLocation

Name	Type	Description	Required	Default
type	OpenAI.LocationType		Yes

OpenAI.LocationType

Property	Value
Type	string
Values	`approximate`

OpenAI.LogProb

De logboekkans van een token.

Name	Type	Required
bytes	array	Yes
logprob	number	Yes
token	string	Yes
top_logprobs	array	Yes

OpenAI.MCPApprovalRequestItemParam

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

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

OpenAI.MCPApprovalRequestItemResource

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

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

OpenAI.MCPApprovalResponseItemParam

Een reactie op een MCP-goedkeuringsaanvraag.

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

OpenAI.MCPApprovalResponseItemResource

Een reactie op een MCP-goedkeuringsaanvraag.

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

OpenAI.MCPCallItemParam

Een aanroep van een hulpprogramma op een MCP-server.

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

OpenAI.MCPCallItemResource

Een aanroep van een hulpprogramma op een MCP-server.

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

OpenAI.MCPListToolsItemParam

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

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

OpenAI.MCPListToolsItemResource

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

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

OpenAI.MCPListToolsTool

Een hulpprogramma dat beschikbaar is op een MCP-server.

Name	Type	Description	Required
annotations		Aanvullende aantekeningen over het hulpprogramma.	No
description	string	De beschrijving van het hulpprogramma.	No
input_schema		Het JSON-schema waarin de invoer van het hulpprogramma wordt beschreven.	Yes
name	string	De naam van het hulpprogramma.	Yes

OpenAI.MCPTool

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

Name	Type	Description	Required
allowed_tools	object		No
└─ tool_names	array	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
require_approval	object (zie geldige modellen hieronder)	Geef op welke van de hulpprogramma's van de MCP-server goedkeuring is vereist.	No
server_label	string	Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.	Yes
server_url	string	De URL voor de MCP-server.	Yes
type	enum	Het type MCP-hulpprogramma. Altijd `mcp`. Mogelijke waarden: `mcp`	Yes

OpenAI.MetadataPropertyForRequest

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

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

Name	Type	Description	Required
created	integer	De Unix-tijdstempel (in seconden) toen het model werd gemaakt.	Yes
id	string	De model-id waarnaar kan worden verwezen in de API-eindpunten.	Yes
object	enum	Het objecttype, dat altijd 'model' is. Mogelijke waarden: `model`	Yes
owned_by	string	De organisatie die eigenaar is van het model.	Yes

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.

Name	Type	Description	Required	Default
type	enum	Altijd `other`. Mogelijke waarden: `other`	Yes

OpenAI.ParallelToolCalls

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

Type: boolean

OpenAI.Prompt

Verwijzing naar een promptsjabloon en de bijbehorende variabelen.

Name	Type	Description	Required
id	string	De unieke id van de promptsjabloon die moet worden gebruikt.	Yes
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	string	Optionele versie van de promptsjabloon.	No

OpenAI.RankingOptions

Name	Type	Description	Required	Default
ranker	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

OpenAI.Reasoning

Alleen modellen uit de o-serie

Name	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
summary	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.
Type	string
Values	`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.

Name	Type	Description	Required
encrypted_content	string	De versleutelde inhoud van het redeneringsitem, ingevuld wanneer een antwoord wordt gegenereerd in `reasoning.encrypted_content` de `include` parameter.	No
summary	array	Tekstinhoud redeneren.	Yes
type	enum	Mogelijke waarden: `reasoning`	Yes

OpenAI.ReasoningItemResource

Name	Type	Description	Required
encrypted_content	string	De versleutelde inhoud van het redeneringsitem, ingevuld wanneer een antwoord wordt gegenereerd in `reasoning.encrypted_content` de `include` parameter.	No
summary	array	Tekstinhoud redeneren.	Yes
type	enum	Mogelijke waarden: `reasoning`	Yes

OpenAI.ReasoningItemSummaryPart

Discriminator voor OpenAI.ReasoningItemSummaryPart

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

Type Value	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Name	Type	Description	Required	Default
type	OpenAI.ReasoningItemSummaryPartType		Yes

OpenAI.ReasoningItemSummaryPartType

Property	Value
Type	string
Values	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Name	Type	Description	Required	Default
text	string		Yes
type	enum	Mogelijke waarden: `summary_text`	Yes

OpenAI.Response

Name	Type	Description	Required	Default
background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
error	object	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	No
└─ message	string	Een door mensen leesbare beschrijving van de fout.	No
id	string	Unieke id voor dit antwoord.	Yes
incomplete_details	object	Details over waarom het antwoord onvolledig is.	Yes
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
instructions	tekenreeks of matrix		Yes
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
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.	Yes
object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
output	array	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.	Yes
output_text	string	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.	Yes	True
previous_response_id	string	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	string	De unieke id van de promptsjabloon die moet worden gebruikt.	No
└─ variables	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
└─ version	string	Optionele versie van de promptsjabloon.	No
reasoning	object	Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen.	No
└─ effort	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
└─ summary	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
temperature	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.	Yes
text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	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	array	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.	Yes
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
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

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

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

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

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

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

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

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

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Verzonden wanneer de code-interpreter het codefragment actief interpreteert.

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

OpenAI.ResponseCompletedEvent

Verzonden wanneer het modelantwoord is voltooid.

Name	Type	Description	Required	Default
response	object		Yes
└─ background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
└─ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ error	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└─ id	string	Unieke id voor dit antwoord.	No
└─ incomplete_details	object	Details over waarom het antwoord onvolledig is.	No
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructions	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
└─ 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
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ output	array	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	string	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
└─ previous_response_id	string	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
└─ reasoning	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
└─ temperature	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
└─ text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	OpenAI.ResponseTextFormatConfiguration		No
└─ tool_choice	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
└─ tools	array	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
└─ 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
└─ usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ user	string	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`	Yes

OpenAI.ResponseContentPartAddedEvent

Verzonden wanneer een nieuw inhoudsonderdeel wordt toegevoegd.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat is toegevoegd.	Yes
item_id	string	De id van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Yes
output_index	integer	De index van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Yes
part	object		Yes
└─ type	OpenAI.ItemContentType	Multimodale invoer- en uitvoerinhoud.	No
type	enum	Het type gebeurtenis. Altijd `response.content_part.added`. Mogelijke waarden: `response.content_part.added`	Yes

OpenAI.ResponseContentPartDoneEvent

Verzonden wanneer een inhoudsonderdeel is voltooid.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat wordt uitgevoerd.	Yes
item_id	string	De id van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Yes
output_index	integer	De index van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Yes
part	object		Yes
└─ type	OpenAI.ItemContentType	Multimodale invoer- en uitvoerinhoud.	No
type	enum	Het type gebeurtenis. Altijd `response.content_part.done`. Mogelijke waarden: `response.content_part.done`	Yes

OpenAI.ResponseCreatedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord wordt gemaakt.

Name	Type	Description	Required	Default
response	object		Yes
└─ background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
└─ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ error	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└─ id	string	Unieke id voor dit antwoord.	No
└─ incomplete_details	object	Details over waarom het antwoord onvolledig is.	No
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructions	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
└─ 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
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ output	array	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	string	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
└─ previous_response_id	string	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
└─ reasoning	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
└─ temperature	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
└─ text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	OpenAI.ResponseTextFormatConfiguration		No
└─ tool_choice	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
└─ tools	array	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
└─ 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
└─ usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ user	string	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`	Yes

OpenAI.ResponseError

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

Name	Type	Description	Required	Default
code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	Yes
message	string	Een door mensen leesbare beschrijving van de fout.	Yes

OpenAI.ResponseErrorCode

De foutcode voor het antwoord.

Property	Value
Description	De foutcode voor het antwoord.
Type	string
Values	`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.

Name	Type	Description	Required
code	string	De foutcode.	Yes
message	string	Het foutbericht.	Yes
param	string	De foutparameter.	Yes
type	enum	Het type gebeurtenis. Altijd `error`. Mogelijke waarden: `error`	Yes

OpenAI.ResponseFailedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord mislukt.

Name	Type	Description	Required	Default
response	object		Yes
└─ background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
└─ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ error	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└─ id	string	Unieke id voor dit antwoord.	No
└─ incomplete_details	object	Details over waarom het antwoord onvolledig is.	No
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructions	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
└─ 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
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ output	array	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	string	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
└─ previous_response_id	string	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
└─ reasoning	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
└─ temperature	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
└─ text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	OpenAI.ResponseTextFormatConfiguration		No
└─ tool_choice	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
└─ tools	array	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
└─ 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
└─ usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ user	string	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`	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

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

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

OpenAI.ResponseFileSearchCallInProgressEvent

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

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

OpenAI.ResponseFileSearchCallSearchingEvent

Verzonden wanneer er momenteel wordt gezocht in een bestand.

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

OpenAI.ResponseFormat

Discriminator voor OpenAI.ResponseFormat

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

Type Value	Schema
`text`	OpenAI.ResponseFormatText
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `text`, `json_objectjson_schema`	Yes

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.

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

OpenAI.ResponseFormatJsonSchema

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

Name	Type	Description	Required	Default
json_schema	object	Configuratieopties voor gestructureerde uitvoer, waaronder een JSON-schema.	Yes
└─ description	string	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om te bepalen hoe moet worden gereageerd in de indeling.	No
└─ name	string	De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.	No
└─ schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	No
└─ strict	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	False
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_schema`. Mogelijke waarden: `json_schema`	Yes

OpenAI.ResponseFormatJsonSchemaSchema

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

Type: object

OpenAI.ResponseFormatText

Standaardantwoordindeling. Wordt gebruikt om tekstreacties te genereren.

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

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

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Verzonden wanneer argumenten voor functieoproep zijn voltooid.

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

OpenAI.ResponseImageGenCallCompletedEvent

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

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

OpenAI.ResponseImageGenCallGeneratingEvent

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

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

OpenAI.ResponseImageGenCallInProgressEvent

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

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

OpenAI.ResponseImageGenCallPartialImageEvent

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

Name	Type	Description	Required
item_id	string	De unieke id van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
partial_image_b64	string	Met Base64 gecodeerde gedeeltelijke afbeeldingsgegevens, geschikt voor rendering als afbeelding.	Yes
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).	Yes
type	enum	Het type gebeurtenis. Always 'response.image_generation_call.partial_image'. Mogelijke waarden: `response.image_generation_call.partial_image`	Yes

OpenAI.ResponseInProgressEvent

Verzonden wanneer het antwoord wordt uitgevoerd.

Name	Type	Description	Required	Default
response	object		Yes
└─ background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
└─ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ error	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└─ id	string	Unieke id voor dit antwoord.	No
└─ incomplete_details	object	Details over waarom het antwoord onvolledig is.	No
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructions	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
└─ 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
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ output	array	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	string	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
└─ previous_response_id	string	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
└─ reasoning	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
└─ temperature	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
└─ text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	OpenAI.ResponseTextFormatConfiguration		No
└─ tool_choice	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
└─ tools	array	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
└─ 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
└─ usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ user	string	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`	Yes

OpenAI.ResponseIncompleteEvent

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

Name	Type	Description	Required	Default
response	object		Yes
└─ background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
└─ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ error	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└─ id	string	Unieke id voor dit antwoord.	No
└─ incomplete_details	object	Details over waarom het antwoord onvolledig is.	No
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructions	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
└─ 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
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ output	array	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	string	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
└─ previous_response_id	string	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
└─ reasoning	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
└─ temperature	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
└─ text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	OpenAI.ResponseTextFormatConfiguration		No
└─ tool_choice	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
└─ tools	array	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
└─ 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
└─ usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ user	string	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`	Yes

OpenAI.ResponseItemList

Een lijst met antwoorditems.

Name	Type	Description	Required
data	array	Een lijst met items die worden gebruikt om dit antwoord te genereren.	Yes
first_id	string	De id van het eerste item in de lijst.	Yes
has_more	boolean	Of er meer items beschikbaar zijn.	Yes
last_id	string	De id van het laatste item in de lijst.	Yes
object	enum	Het type object dat wordt geretourneerd, moet zijn `list`. Mogelijke waarden: `list`	Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

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

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

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

OpenAI.ResponseMCPCallCompletedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is voltooid.

Name	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Always 'response.mcp_call.completed'. Mogelijke waarden: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is mislukt.

Name	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Always 'response.mcp_call.failed'. Mogelijke waarden: `response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep wordt uitgevoerd.

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

OpenAI.ResponseMCPListToolsCompletedEvent

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

Name	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Always 'response.mcp_list_tools.completed'. Mogelijke waarden: `response.mcp_list_tools.completed`	Yes

OpenAI.ResponseMCPListToolsFailedEvent

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

Name	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Always 'response.mcp_list_tools.failed'. Mogelijke waarden: `response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Verzonden wanneer het systeem bezig is met het ophalen van de lijst met beschikbare MCP-hulpprogramma's.

Name	Type	Description	Required	Default
type	enum	Het type gebeurtenis. Always 'response.mcp_list_tools.in_progress'. Mogelijke waarden: `response.mcp_list_tools.in_progress`	Yes

OpenAI.ResponseOutputItemAddedEvent

Verzonden wanneer een nieuw uitvoeritem wordt toegevoegd.

Name	Type	Description	Required
item	object	Inhoudsitem dat wordt gebruikt om een antwoord te genereren.	Yes
└─ id	string		No
└─ type	OpenAI.ItemType		No
output_index	integer	De index van het uitvoeritem dat is toegevoegd.	Yes
type	enum	Het type gebeurtenis. Altijd `response.output_item.added`. Mogelijke waarden: `response.output_item.added`	Yes

OpenAI.ResponseOutputItemDoneEvent

Verzonden wanneer een uitvoeritem is gemarkeerd als voltooid.

Name	Type	Description	Required
item	object	Inhoudsitem dat wordt gebruikt om een antwoord te genereren.	Yes
└─ id	string		No
└─ type	OpenAI.ItemType		No
output_index	integer	De index van het uitvoeritem dat is gemarkeerd als voltooid.	Yes
type	enum	Het type gebeurtenis. Altijd `response.output_item.done`. Mogelijke waarden: `response.output_item.done`	Yes

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: object

OpenAI.ResponseQueuedEvent

Wordt verzonden wanneer een antwoord in de wachtrij wordt geplaatst en wacht tot deze wordt verwerkt.

Name	Type	Description	Required	Default
response	object		Yes
└─ background	boolean	Of het modelantwoord op de achtergrond moet worden uitgevoerd.	No	False
└─ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	No
└─ error	OpenAI.ResponseError	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	No
└─ id	string	Unieke id voor dit antwoord.	No
└─ incomplete_details	object	Details over waarom het antwoord onvolledig is.	No
└─ reason	enum	De reden waarom het antwoord onvolledig is. Mogelijke waarden: `max_output_tokens`, `content_filter`	No
└─ instructions	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
└─ 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
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	No
└─ output	array	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	string	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
└─ previous_response_id	string	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
└─ reasoning	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
└─ temperature	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
└─ text	object	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ format	OpenAI.ResponseTextFormatConfiguration		No
└─ tool_choice	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
└─ tools	array	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
└─ 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
└─ usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ user	string	Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren.	No
type	enum	Het type gebeurtenis. Always 'response.queued'. Mogelijke waarden: `response.queued`	Yes

OpenAI.ResponseReasoningDeltaEvent

Verzonden wanneer er een delta (gedeeltelijke update) is voor de redeneringsinhoud.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel redenering binnen het uitvoeritem.	Yes
delta		De gedeeltelijke update van de redeneringsinhoud.	Yes
item_id	string	De unieke id van het item waarvoor redenering wordt bijgewerkt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
type	enum	Het type gebeurtenis. Always 'response.reasoning.delta'. Mogelijke waarden: `response.reasoning.delta`	Yes

OpenAI.ResponseReasoningDoneEvent

Verzonden wanneer de redeneringsinhoud voor een item is voltooid.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel redenering binnen het uitvoeritem.	Yes
item_id	string	De unieke id van het item waarvoor de redenering is voltooid.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
text	string	De voltooide redeneringstekst.	Yes
type	enum	Het type gebeurtenis. Always 'response.reasoning.done'. Mogelijke waarden: `response.reasoning.done`	Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Verzonden wanneer er een delta (gedeeltelijke update) is voor de redeneringsoverzichtsinhoud.

Name	Type	Description	Required
delta		De gedeeltelijke update van de samenvattingsinhoud met redenering.	Yes
item_id	string	De unieke id van het item waarvoor de redeneringssamenvatting wordt bijgewerkt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
summary_index	integer	De index van het samenvattingsonderdeel in het uitvoeritem.	Yes
type	enum	Het type gebeurtenis. Always 'response.reasoning_summary.delta'. Mogelijke waarden: `response.reasoning_summary.delta`	Yes

OpenAI.ResponseReasoningSummaryDoneEvent

Verzonden wanneer de samenvattingsinhoud van de redenering is voltooid voor een item.

Name	Type	Description	Required
item_id	string	De unieke id van het item waarvoor de redeneringssamenvatting is voltooid.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
summary_index	integer	De index van het samenvattingsonderdeel in het uitvoeritem.	Yes
text	string	De uiteindelijke redeneringssamenvattingstekst.	Yes
type	enum	Het type gebeurtenis. Always 'response.reasoning_summary.done'. Mogelijke waarden: `response.reasoning_summary.done`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Verzonden wanneer een nieuw redeneringssamenvattingsonderdeel wordt toegevoegd.

Name	Type	Description	Required
item_id	string	De id van het item waarmee dit overzichtsonderdeel is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee dit overzichtsonderdeel is gekoppeld.	Yes
part	object		Yes
└─ type	OpenAI.ReasoningItemSummaryPartType		No
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Yes
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_part.added`. Mogelijke waarden: `response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Verzonden wanneer een samenvattingsonderdeel met redenering is voltooid.

Name	Type	Description	Required
item_id	string	De id van het item waarmee dit overzichtsonderdeel is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee dit overzichtsonderdeel is gekoppeld.	Yes
part	object		Yes
└─ type	OpenAI.ReasoningItemSummaryPartType		No
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Yes
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_part.done`. Mogelijke waarden: `response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Verzonden wanneer een delta wordt toegevoegd aan een redeneringssamenvattingstekst.

Name	Type	Description	Required
delta	string	De tekst delta die is toegevoegd aan de samenvatting.	Yes
item_id	string	De id van het item waarmee deze samenvattingstekst delta is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee deze samenvattingstekstdelta is gekoppeld.	Yes
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Yes
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_text.delta`. Mogelijke waarden: `response.reasoning_summary_text.delta`	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Verzonden wanneer een samenvattingstekst met redenering is voltooid.

Name	Type	Description	Required
item_id	string	De id van het item waarmee deze samenvattingstekst is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee deze samenvattingstekst is gekoppeld.	Yes
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Yes
text	string	De volledige tekst van de voltooide redeneringssamenvatting.	Yes
type	enum	Het type gebeurtenis. Altijd `response.reasoning_summary_text.done`. Mogelijke waarden: `response.reasoning_summary_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Verzonden wanneer er sprake is van een gedeeltelijke weigeringstekst.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel waaraan de weigeringstekst wordt toegevoegd.	Yes
delta	string	De weigeringstekst die wordt toegevoegd.	Yes
item_id	string	De id van het uitvoeritem waaraan de weigeringstekst wordt toegevoegd.	Yes
output_index	integer	De index van het uitvoeritem waaraan de weigeringstekst wordt toegevoegd.	Yes
type	enum	Het type gebeurtenis. Altijd `response.refusal.delta`. Mogelijke waarden: `response.refusal.delta`	Yes

OpenAI.ResponseRefusalDoneEvent

Verzonden wanneer de weigeringstekst is voltooid.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat de weigeringstekst is voltooid.	Yes
item_id	string	De id van het uitvoeritem waarvan de weigeringstekst is voltooid.	Yes
output_index	integer	De index van het uitvoeritem dat de weigeringstekst is voltooid.	Yes
refusal	string	De weigeringstekst die is voltooid.	Yes
type	enum	Het type gebeurtenis. Altijd `response.refusal.done`. Mogelijke waarden: `response.refusal.done`	Yes

OpenAI.ResponseStreamEvent

Discriminator voor OpenAI.ResponseStreamEvent

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

Type Value	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

Name	Type	Description	Required	Default
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	Yes
type	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Property Value

Type string

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

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel waaraan de tekstdelta is toegevoegd.	Yes
delta	string	De tekstdelta die is toegevoegd.	Yes
item_id	string	De id van het uitvoeritem waaraan de tekstdelta is toegevoegd.	Yes
output_index	integer	De index van het uitvoeritem waaraan de tekstdelta is toegevoegd.	Yes
type	enum	Het type gebeurtenis. Altijd `response.output_text.delta`. Mogelijke waarden: `response.output_text.delta`	Yes

OpenAI.ResponseTextDoneEvent

Verzonden wanneer tekstinhoud is voltooid.

Name	Type	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat de tekstinhoud is voltooid.	Yes
item_id	string	De id van het uitvoeritem waarvan de tekstinhoud is voltooid.	Yes
output_index	integer	De index van het uitvoeritem dat de tekstinhoud is voltooid.	Yes
text	string	De tekstinhoud die is voltooid.	Yes
type	enum	Het type gebeurtenis. Altijd `response.output_text.done`. Mogelijke waarden: `response.output_text.done`	Yes

OpenAI.ResponseTextFormatConfiguration

Discriminator voor OpenAI.ResponseTextFormatConfiguration

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

Type Value	Schema
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

Name	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.	Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `json_object`	Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

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

Name	Type	Description	Required	Default
description	string	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om te bepalen hoe moet worden gereageerd in de indeling.	No
name	string	De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 of onderstrepingstekens en streepjes bevatten, met een maximale lengte van 64.	Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	Yes
strict	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	False
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_schema`. Mogelijke waarden: `json_schema`	Yes

OpenAI.ResponseTextFormatConfigurationText

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `text`	Yes

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.

Name	Type	Description	Required
input_tokens	integer	Het aantal invoertokens.	Yes
input_tokens_details	object	Een gedetailleerde uitsplitsing van de invoertokens.	Yes
└─ cached_tokens	integer	Het aantal tokens dat is opgehaald uit de cache.	No
output_tokens	integer	Het aantal uitvoertokens.	Yes
output_tokens_details	object	Een gedetailleerde uitsplitsing van de uitvoertokens.	Yes
└─ reasoning_tokens	integer	Het aantal redeneringstokens.	No
total_tokens	integer	Het totale aantal gebruikte tokens.	Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Type	Description	Required
item_id	string	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Yes
output_index	integer	De index van het uitvoeritem waaraan de webzoekopdracht is gekoppeld.	Yes
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.completed`. Mogelijke waarden: `response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Type	Description	Required
item_id	string	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Yes
output_index	integer	De index van het uitvoeritem waaraan de webzoekopdracht is gekoppeld.	Yes
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.in_progress`. Mogelijke waarden: `response.web_search_call.in_progress`	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Type	Description	Required
item_id	string	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Yes
output_index	integer	De index van het uitvoeritem waaraan de webzoekopdracht is gekoppeld.	Yes
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.searching`. Mogelijke waarden: `response.web_search_call.searching`	Yes

OpenAI.ResponsesAssistantMessageItemParam

Een berichtparameteritem met de assistant rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `assistant`is. Mogelijke waarden: `assistant`	Yes

OpenAI.ResponsesAssistantMessageItemResource

Een berichtresource-item met de assistant rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `assistant`is. Mogelijke waarden: `assistant`	Yes

OpenAI.ResponsesDeveloperMessageItemParam

Een berichtparameteritem met de developer rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `developer`is. Mogelijke waarden: `developer`	Yes

OpenAI.ResponsesDeveloperMessageItemResource

Een berichtresource-item met de developer rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `developer`is. Mogelijke waarden: `developer`	Yes

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:

Type Value	Schema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Name	Type	Description	Required	Default
role	object	De verzameling geldige rollen voor berichtitems voor antwoorden.	Yes
type	enum	Het type antwoorditem, dat altijd 'bericht' is. Mogelijke waarden: `message`	Yes

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:

Type Value	Schema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Name	Type	Description	Required
role	object	De verzameling geldige rollen voor berichtitems voor antwoorden.	Yes
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`	Yes
type	enum	Het type antwoorditem, dat altijd 'bericht' is. Mogelijke waarden: `message`	Yes

OpenAI.ResponsesMessageRole

De verzameling geldige rollen voor berichtitems voor antwoorden.

Property	Value
Description	De verzameling geldige rollen voor berichtitems voor antwoorden.
Type	string
Values	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Een berichtparameteritem met de system rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `system`is. Mogelijke waarden: `system`	Yes

OpenAI.ResponsesSystemMessageItemResource

Een berichtresource-item met de system rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `system`is. Mogelijke waarden: `system`	Yes

OpenAI.ResponsesUserMessageItemParam

Een berichtparameteritem met de user rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `user`is. Mogelijke waarden: `user`	Yes

OpenAI.ResponsesUserMessageItemResource

Een berichtresource-item met de user rol.

Name	Type	Description	Required	Default
content	array	De inhoud die aan het bericht is gekoppeld.	Yes
role	enum	De rol van het bericht, die altijd `user`is. Mogelijke waarden: `user`	Yes

OpenAI.RunGraderRequest

Name	Type	Description	Required
grader	object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Yes
└─ calculate_output	string	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	string	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└─ input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└─ model	string	Het model dat moet worden gebruikt voor de evaluatie.	No
└─ name	string	De naam van de cijferaar.	No
└─ operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ range	array	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ reference	string	De tekst wordt beoordeeld op basis van.	No
└─ sampling_params		De steekproefparameters voor het model.	No
└─ source	string	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	string	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.	Yes

OpenAI.RunGraderResponse

Name	Type	Required
metadata	object	Yes
└─ errors	object	No
└─ formula_parse_error	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	string	No
└─ other_error	boolean	No
└─ python_grader_runtime_error	boolean	No
└─ python_grader_runtime_error_details	string	No
└─ python_grader_server_error	boolean	No
└─ python_grader_server_error_type	string	No
└─ sample_parse_error	boolean	No
└─ truncated_observation_error	boolean	No
└─ unresponsive_reward_error	boolean	No
└─ execution_time	number	No
└─ name	string	No
└─ sampled_model_name	string	No
└─ scores		No
└─ token_usage	integer	No
└─ type	string	No
model_grader_token_usage_per_model		Yes
reward	number	Yes
sub_rewards		Yes

OpenAI.StaticChunkingStrategy

Name	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`.	Yes
max_chunk_size_tokens	integer	Het maximum aantal tokens in elk segment. De standaardwaarde is `800`. De minimumwaarde is `100` en de maximumwaarde is `4096`.	Yes

OpenAI.StaticChunkingStrategyRequestParam

Pas uw eigen segmentstrategie aan door segmentgrootte en segmentover overlap in te stellen.

Name	Type	Description	Required	Default
static	OpenAI.StaticChunkingStrategy		Yes
type	enum	Altijd `static`. Mogelijke waarden: `static`	Yes

OpenAI.StaticChunkingStrategyResponseParam

Name	Type	Description	Required	Default
static	OpenAI.StaticChunkingStrategy		Yes
type	enum	Altijd `static`. Mogelijke waarden: `static`	Yes

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:

Type Value	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

Name	Type	Description	Required	Default
type	OpenAI.ToolType	Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.	Yes

OpenAI.ToolChoiceObject

Discriminator voor OpenAI.ToolChoiceObject

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

Type Value	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

Name	Type	Description	Required	Default
type	OpenAI.ToolChoiceObjectType	Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren.	Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `code_interpreter`	Yes

OpenAI.ToolChoiceObjectComputer

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `computer_use_preview`	Yes

OpenAI.ToolChoiceObjectFileSearch

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `file_search`	Yes

OpenAI.ToolChoiceObjectFunction

Gebruik deze optie om af te dwingen dat het model een specifieke functie aanroept.

Name	Type	Description	Required	Default
name	string	De naam van de functie die moet worden aangeroepen.	Yes
type	enum	Voor functie-aanroepen is het type altijd `function`. Mogelijke waarden: `function`	Yes

OpenAI.ToolChoiceObjectImageGen

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `image_generation`	Yes

OpenAI.ToolChoiceObjectMCP

Gebruik deze optie om af te dwingen dat het model een specifiek hulpprogramma aanroept op een externe MCP-server.

Name	Type	Description	Required
name	string	De naam van het hulpprogramma dat moet worden aangeroepen op de server.	No
server_label	string	Het label van de MCP-server die moet worden gebruikt.	Yes
type	enum	Voor MCP-hulpprogramma's is het type altijd `mcp`. Mogelijke waarden: `mcp`	Yes

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.

Type	string
Values	`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.

Name	Type	Description	Required	Default
type	enum	Mogelijke waarden: `web_search_preview`	Yes

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.
Type	string
Values	`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.
Type	string
Values	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell`

OpenAI.TopLogProb

De grootste logboekkans van een token.

Name	Type	Required
bytes	array	Yes
logprob	number	Yes
token	string	Yes

OpenAI.TranscriptionAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property	Value
Type	string
Values	`logprobs`

OpenAI.TranscriptionSegment

Name	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.	Yes
compression_ratio	number	Compressieverhouding van het segment. Als de waarde groter is dan 2,4, kunt u overwegen dat de compressie is mislukt.	Yes
end	number	Eindtijd van het segment in seconden.	Yes
id	integer	Unieke id van het segment.	Yes
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.	Yes
seek	integer	Verschuiving van het segment zoeken.	Yes
start	number	Begintijd van het segment in seconden.	Yes
temperature	number	Temperatuurparameter die wordt gebruikt voor het genereren van het segment.	Yes
text	string	Tekstinhoud van het segment.	Yes
tokens	array	Matrix van token-id's voor de tekstinhoud.	Yes

OpenAI.TranscriptionWord

Name	Type	Description	Required
end	number	Eindtijd van het woord in seconden.	Yes
start	number	Begintijd van het woord in seconden.	Yes
word	string	De tekstinhoud van het woord.	Yes

OpenAI.TranslationAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Name	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.	Yes

OpenAI.UpdateVectorStoreRequest

Name	Type	Description	Required
expires_after	object	Het verloopbeleid voor een vectorarchief.	No
└─ anchor	enum	Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: `last_active_at`. Mogelijke waarden: `last_active_at`	No
└─ days	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
name	string	De naam van het vectorarchief.	No

OpenAI.VadConfig

Name	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`	Yes

OpenAI.ValidateGraderRequest

Name	Type	Description	Required
grader	object	Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.	Yes
└─ calculate_output	string	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	string	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└─ input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└─ model	string	Het model dat moet worden gebruikt voor de evaluatie.	No
└─ name	string	De naam van de cijferaar.	No
└─ operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ range	array	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ reference	string	De tekst wordt beoordeeld op basis van.	No
└─ sampling_params		De steekproefparameters voor het model.	No
└─ source	string	De broncode van het Python-script.	No
└─ type	enum	Het objecttype, dat altijd `multi`is. Mogelijke waarden: `multi`	No

OpenAI.ValidateGraderResponse

Name	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	string	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	string	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
└─ input	array	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	No
└─ model	string	Het model dat moet worden gebruikt voor de evaluatie.	No
└─ name	string	De naam van de cijferaar.	No
└─ operation	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een van`eq`, `ne`, of `likeilike`. Mogelijke waarden: `eq`, `ne`, , `likeilike`	No
└─ range	array	Het bereik van de score. Standaard ingesteld op `[0, 1]`.	No
└─ reference	string	De tekst wordt beoordeeld op basis van.	No
└─ sampling_params		De steekproefparameters voor het model.	No
└─ source	string	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.

Name	Type	Description	Required	Default
anchor	enum	Ankertijdstempel waarna het verloopbeleid van toepassing is. Ondersteunde ankers: `last_active_at`. Mogelijke waarden: `last_active_at`	Yes
days	integer	Het aantal dagen na de ankertijd dat het vectorarchief verloopt.	Yes

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: object

OpenAI.VectorStoreFileBatchObject

Een batch bestanden die zijn gekoppeld aan een vectorarchief.

Name	Type	Description	Required
created_at	integer	De Unix-tijdstempel (in seconden) voor wanneer de batch vectoropslagbestanden is gemaakt.	Yes
file_counts	object		Yes
└─ cancelled	integer	Het aantal bestanden dat is geannuleerd.	No
└─ completed	integer	Het aantal bestanden dat is verwerkt.	No
└─ failed	integer	Het aantal bestanden dat niet kan worden verwerkt.	No
└─ in_progress	integer	Het aantal bestanden dat momenteel wordt verwerkt.	No
└─ total	integer	Het totale aantal bestanden.	No
id	string	De id waarnaar kan worden verwezen in API-eindpunten.	Yes
object	enum	Het objecttype, dat altijd `vector_store.file_batch`is. Mogelijke waarden: `vector_store.files_batch`	Yes
status	enum	De status van de bestandsbatch van de vectoropslag, die kan zijn`in_progress`, `completedcancelled` of `failed`. Mogelijke waarden: `in_progress`, `completed`, , `cancelledfailed`	Yes
vector_store_id	string	De id van het vectorarchief waaraan het bestand is gekoppeld.	Yes

OpenAI.VectorStoreFileObject

Een lijst met bestanden die zijn gekoppeld aan een vectorarchief.

Name	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
created_at	integer	De Unix-tijdstempel (in seconden) voor het moment dat het vectorarchiefbestand is gemaakt.	Yes
id	string	De id waarnaar kan worden verwezen in API-eindpunten.	Yes
last_error	object	De laatste fout die is gekoppeld aan dit vectorarchiefbestand. Dit gebeurt `null` als er geen fouten zijn.	Yes
└─ code	enum	Een van `server_error` of `rate_limit_exceeded`. Mogelijke waarden: `server_error`, `unsupported_fileinvalid_file`	No
└─ message	string	Een door mensen leesbare beschrijving van de fout.	No
object	enum	Het objecttype, dat altijd `vector_store.file`is. Mogelijke waarden: `vector_store.file`	Yes
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`	Yes
usage_bytes	integer	Het totale gebruik van vectoropslag in bytes. Houd er rekening mee dat dit mogelijk verschilt van de oorspronkelijke bestandsgrootte.	Yes
vector_store_id	string	De id van het vectorarchief waaraan het bestand is gekoppeld.	Yes

OpenAI.VectorStoreObject

Een vectorarchief is een verzameling verwerkte bestanden die door het file_search hulpprogramma kunnen worden gebruikt.

Name	Type	Description	Required
created_at	integer	De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief is gemaakt.	Yes
expires_after	OpenAI.VectorStoreExpirationAfter	Het verloopbeleid voor een vectorarchief.	No
expires_at	integer	De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief verloopt.	No
file_counts	object		Yes
└─ cancelled	integer	Het aantal geannuleerde bestanden.	No
└─ completed	integer	Het aantal bestanden dat is verwerkt.	No
└─ failed	integer	Het aantal bestanden dat niet kan worden verwerkt.	No
└─ in_progress	integer	Het aantal bestanden dat momenteel wordt verwerkt.	No
└─ total	integer	Het totale aantal bestanden.	No
id	string	De id waarnaar kan worden verwezen in API-eindpunten.	Yes
last_active_at	integer	De Unix-tijdstempel (in seconden) voor wanneer het vectorarchief voor het laatst actief was.	Yes
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.	Yes
name	string	De naam van het vectorarchief.	Yes
object	enum	Het objecttype, dat altijd `vector_store`is. Mogelijke waarden: `vector_store`	Yes
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`	Yes
usage_bytes	integer	Het totale aantal bytes dat door de bestanden in het vectorarchief wordt gebruikt.	Yes

OpenAI.VoiceIdsShared

Property	Value
Type	string
Values	`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:

Type Value	Schema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Name	Type	Description	Required	Default
type	OpenAI.WebSearchActionType		Yes

OpenAI.WebSearchActionFind

Actietype 'zoeken': zoekt naar een patroon binnen een geladen pagina.

Name	Type	Description	Required
pattern	string	Het patroon of de tekst die u op de pagina wilt zoeken.	Yes
type	enum	Het actietype. Mogelijke waarden: `find`	Yes
url	string	De URL van de pagina waarnaar het patroon is gezocht.	Yes

OpenAI.WebSearchActionOpenPage

Actietype 'open_page': hiermee opent u een specifieke URL uit zoekresultaten.

Name	Type	Description	Required	Default
type	enum	Het actietype. Mogelijke waarden: `open_page`	Yes
url	string	De URL die door het model is geopend.	Yes

OpenAI.WebSearchActionSearch

Actietype 'zoeken': voert een webzoekquery uit.

Name	Type	Description	Required	Default
query	string	De zoekquery.	Yes
type	enum	Het actietype. Mogelijke waarden: `search`	Yes

OpenAI.WebSearchActionType

Property	Value
Type	string
Values	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Type	Description	Required
search_context_size	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`	Yes
user_location	object		No
└─ type	OpenAI.LocationType		No

OpenAI.WebSearchToolCallItemParam

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Type	Description	Required
action	object		Yes
└─ type	OpenAI.WebSearchActionType		No
type	enum	Mogelijke waarden: `web_search_call`	Yes

OpenAI.WebSearchToolCallItemResource

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Type	Description	Required
action	object		Yes
└─ type	OpenAI.WebSearchActionType		No
status	enum	De status van de aanroep van het webzoekprogramma. Mogelijke waarden: `in_progress`, `searching`, , `completedfailed`	Yes
type	enum	Mogelijke waarden: `web_search_call`	Yes

PineconeChatDataSource

Name	Type	Description	Required	Default
parameters	object	De parameterinformatie voor het beheren van het gebruik van de pinecone-gegevensbron.	Yes
└─ 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	False
└─ authentication	object		No
└─ key	string		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
└─ environment	string	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	array		No
└─ content_fields_separator	string		No
└─ filepath_field	string		No
└─ title_field	string		No
└─ url_field	string		No
└─ in_scope	boolean	Of query's moeten worden beperkt tot het gebruik van de geïndexeerde gegevens.	No
└─ include_contexts	array	De eigenschappen van de uitvoercontext die moeten worden opgenomen in het antwoord. Bronvermeldingen en intenties worden standaard aangevraagd.	No	['citations', 'intent']
└─ index_name	string	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
└─ strictness	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`	Yes

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.
Type	string
Values	`high` `low`

ResponseFormatJSONSchemaRequest

Name	Type	Description	Required	Default
json_schema	object	JSON-schema voor de antwoordindeling	Yes
type	enum	Type antwoordindeling Mogelijke waarden: `json_schema`	Yes

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.

Name	Type	Description	Required
created_at	integer	Het tijdstip waarop de videogeneratie is gemaakt.	Yes
height	integer	De hoogte van de video.	Yes
id	string	De id van de videogeneratie.	Yes
job_id	string	De id van de taak voor het genereren van video's voor deze video.	Yes
n_seconds	integer	De duur van de videogeneratie.	Yes
object	enum	Mogelijke waarden: `video.generation`	Yes
prompt	string	De prompt voor deze videogeneratie.	Yes
width	integer	De breedte van de video.	Yes

VideoGenerationJob

Een videogeneratietaak.

Name	Type	Description	Required
created_at	integer	Het tijdstip waarop de taak is gemaakt.	Yes
expires_at	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
finished_at	integer	Het tijdstip waarop de taak klaar is met alle videogeneraties.	No
generations	array	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.	Yes
id	string	De id van de taak.	Yes
inpaint_items	array	Optionele inpainting-items voor deze videogeneratietaak.	No
model	string	De naam van de implementatie die moet worden gebruikt voor deze videogeneratietaak.	Yes
n_seconds	integer	De duur van de videogeneratietaak.	Yes
n_variants	integer	Het aantal video's dat moet worden gemaakt als varianten voor deze videogeneratietaak.	Yes
object	enum	Mogelijke waarden: `video.generation.job`	Yes
prompt	string	De prompt voor deze videogeneratietaak.	Yes
status	object	De status van een videogeneratietaak.	Yes
width	integer	De hoogte van de video.	Yes

VideoGenerationJobList

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

Name	Type	Description	Required
data	array	De lijst met taken voor het genereren van video's.	Yes
first_id	string	De id van de eerste taak op de huidige pagina, indien beschikbaar.	No
has_more	boolean	Een vlag die aangeeft of er meer taken beschikbaar zijn na de lijst.	Yes
last_id	string	De id van de laatste taak op de huidige pagina, indien beschikbaar.	No
object	enum	Mogelijke waarden: `list`	Yes

Next steps

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-04-30