Azure OpenAI responses

API-versie: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API's

Servervariabelen:

Variable	Verstek	Description
endpoint		Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam. Voorbeeld: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Authentication

ApiKeyAuth (API-sleutel)

Geef je API-sleutel in de api-key header.

ApiKeyAuth_ (API-sleutel)

Geef je API-sleutel in de authorization header.

OAuth2Auth (OAuth 2.0)

Flow: impliciet

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

Scopes:

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

Beveiligingsvereisten

Eindpunten accepteren een van de volgende authenticatiemethoden:

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (scopes: https://cognitiveservices.azure.com/.default)

Antwoord maken

POST {endpoint}/openai/v1/responses

Hiermee maakt u een modelantwoord.

URI-parameters

Name	In	Required	Typ	Description
endpoint	server	Yes	tekenreeks	Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam. Voorbeeld: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-versie	zoekopdracht	No	tekenreeks Mogelijke waarden: `v1`, `preview`	De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required
achtergrond	Booleaanse waarde of null		No
context_management	array van OpenAI.ContextManagementParam of null	Contextbeheerconfiguratie voor dit verzoek.	No
gesprek	OpenAI.ConversationParam of null		No
include	matrix van OpenAI.IncludeEnum of null		No
input	OpenAI.InputParam	Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie: - Tekstinvoer en -uitvoer - Afbeeldingsingangen - Bestandsinvoer - Gesprekstoestand - Functie-aanroep	No
aanwijzingen	tekenreeks of null		No
max_output_tokens	geheel getal of null		No
max_gereedschap_aanroepen	geheel getal of null		No
metadata	OpenAI.Metadata of null		No
model	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
parallel_gereedschapsoproepen	Booleaanse waarde of null		No
previous_response_id	tekenreeks of null		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
prompt_cache_retention	tekenreeks of null		No
reasoning	OpenAI.Reasoning of null		No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
store	Booleaanse waarde of null		No
stream	Booleaanse waarde of null		No
stream_options	OpenAI.ResponseStreamOptions of null		No
Temperatuur	getal of null		No
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. De twee categorieën tools die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. de mogelijkheden van het model, zoals het zoeken naar bestanden. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen zodat het uw eigen code kan aanroepen.	No
top_logprobs	geheel getal of null		No
top_p	getal of null		No
truncation	tekenreeks of null		No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object
text/event-stream	object

Name	Typ	Description	Required	Verstek
achtergrond	Booleaanse waarde of null		No
voltooid_op	tekenreeks of null		No
content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
gesprek	OpenAI.ConversationReference of null		No
aangemaakt_op	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
fout	OpenAI.ResponseError of null		Yes
id	tekenreeks	Unieke id voor dit antwoord.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails of null		Yes
aanwijzingen	tekenreeks of matrix van OpenAI.InputItem of null		Yes
max_output_tokens	geheel getal of null		No
max_gereedschap_aanroepen	geheel getal of null		No
metadata	OpenAI.Metadata of null		No
model	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
output	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
output_text	tekenreeks of null		No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
previous_response_id	tekenreeks of null		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
prompt_cache_retention	tekenreeks of null		No
reasoning	OpenAI.Reasoning of null		No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatuur	getal of null		No
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
top_logprobs	geheel getal of null		No
top_p	getal of null		No
truncation	tekenreeks of null		No
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Required
code	tekenreeks of null	Yes
inner_error		No
message	tekenreeks	Yes
param	tekenreeks of null	No
type	tekenreeks	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Examples

Voorbeeld

Een modelantwoord maken

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

Ontvang reactie

GET {endpoint}/openai/v1/responses/{response_id}

Haalt een modelantwoord op met de opgegeven id.

URI-parameters

Name	In	Required	Typ	Description
endpoint	server	Yes	tekenreeks	Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam. Voorbeeld: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-versie	zoekopdracht	No	tekenreeks Mogelijke waarden: `v1`, `preview`	De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	tekenreeks
include[]	zoekopdracht	No	gegevensreeks	Aanvullende velden die moeten worden opgenomen in het antwoord. Zie de include-parameter voor het maken van antwoorden hierboven voor meer informatie.
stream	zoekopdracht	No	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. Serialisatie: explode: false
starting_after	zoekopdracht	No	geheel getal (int32)	Het volgnummer van de gebeurtenis waarna de streaming moet worden gestart. Serialisatie: explode: false
include_obfuscation	zoekopdracht	No	boolean	Wanneer waar, wordt de verdoezeling van stromen ingeschakeld. Stream-obfuscatie voegt willekeurige tekens toe aan een `obfuscation` veld in streaming delta-evenementen om payloadgroottes te normaliseren als een mitigatie tegen bepaalde side-channel-aanvallen. Deze verborgen velden zijn standaard opgenomen, maar voegen een kleine hoeveelheid overhead toe aan de gegevensstroom. U kunt instellen `include_obfuscation` op false om te optimaliseren voor bandbreedte als u de netwerkkoppelingen tussen uw toepassing en de OpenAI-API vertrouwt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Description	Required	Verstek
achtergrond	Booleaanse waarde of null		No
voltooid_op	tekenreeks of null		No
content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
gesprek	OpenAI.ConversationReference of null		No
aangemaakt_op	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
fout	OpenAI.ResponseError of null		Yes
id	tekenreeks	Unieke id voor dit antwoord.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails of null		Yes
aanwijzingen	tekenreeks of matrix van OpenAI.InputItem of null		Yes
max_output_tokens	geheel getal of null		No
max_gereedschap_aanroepen	geheel getal of null		No
metadata	OpenAI.Metadata of null		No
model	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
output	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
output_text	tekenreeks of null		No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
previous_response_id	tekenreeks of null		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
prompt_cache_retention	tekenreeks of null		No
reasoning	OpenAI.Reasoning of null		No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatuur	getal of null		No
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
top_logprobs	geheel getal of null		No
top_p	getal of null		No
truncation	tekenreeks of null		No
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Required
code	tekenreeks of null	Yes
inner_error		No
message	tekenreeks	Yes
param	tekenreeks of null	No
type	tekenreeks	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Antwoord verwijderen

DELETE {endpoint}/openai/v1/responses/{response_id}

Verwijdert een antwoord per ID.

URI-parameters

Name	In	Required	Typ	Description
endpoint	server	Yes	tekenreeks	Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam. Voorbeeld: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-versie	zoekopdracht	No	tekenreeks Mogelijke waarden: `v1`, `preview`	De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	tekenreeks

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Description	Required
verwijderd	enum	Mogelijke waarden: `True`	Yes
id	tekenreeks		Yes
object	enum	Mogelijke waarden: `response.deleted`	Yes

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Required
code	tekenreeks of null	Yes
inner_error		No
message	tekenreeks	Yes
param	tekenreeks of null	No
type	tekenreeks	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Antwoord annuleren

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Annuleert een modelantwoord met de opgegeven id. Alleen antwoorden die zijn gemaakt met de achtergrondparameter ingesteld op True, kunnen worden geannuleerd.

URI-parameters

Name	In	Required	Typ	Description
endpoint	server	Yes	tekenreeks	Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam. Voorbeeld: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-versie	zoekopdracht	No	tekenreeks Mogelijke waarden: `v1`, `preview`	De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	tekenreeks

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Description	Required	Verstek
achtergrond	Booleaanse waarde of null		No
voltooid_op	tekenreeks of null		No
content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
gesprek	OpenAI.ConversationReference of null		No
aangemaakt_op	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
fout	OpenAI.ResponseError of null		Yes
id	tekenreeks	Unieke id voor dit antwoord.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails of null		Yes
aanwijzingen	tekenreeks of matrix van OpenAI.InputItem of null		Yes
max_output_tokens	geheel getal of null		No
max_gereedschap_aanroepen	geheel getal of null		No
metadata	OpenAI.Metadata of null		No
model	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
output	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
output_text	tekenreeks of null		No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
previous_response_id	tekenreeks of null		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
prompt_cache_retention	tekenreeks of null		No
reasoning	OpenAI.Reasoning of null		No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatuur	getal of null		No
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
top_logprobs	geheel getal of null		No
top_p	getal of null		No
truncation	tekenreeks of null		No
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Required
code	tekenreeks of null	Yes
inner_error		No
message	tekenreeks	Yes
param	tekenreeks of null	No
type	tekenreeks	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Invoeritems weergeven

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Retourneert een lijst met invoeritems voor een bepaald antwoord.

URI-parameters

Name	In	Required	Typ	Description
endpoint	server	Yes	tekenreeks	Een ondersteund Azure AI Foundry Models API-endpoint, inclusief protocol en hostnaam. Voorbeeld: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-versie	zoekopdracht	No	tekenreeks Mogelijke waarden: `v1`, `preview`	De expliciete API-versie van Azure AI Foundry Models die voor deze aanvraag moet worden gebruikt. `v1` als dit niet anders is opgegeven.
response_id	path	Yes	tekenreeks
limit	zoekopdracht	No	geheel getal (int32)	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20. Serialisatie: explode: false
order	zoekopdracht	No	tekenreeks Mogelijke waarden: `asc`, `desc`	Sorteer de volgorde op de `created_at` tijdstempel van de objecten. `asc` voor oplopende volgorde en`desc` voor aflopende volgorde. Serialisatie: explode: false
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `after` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen. Serialisatie: explode: false
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. `before` is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ResponseItemList

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	object

Name	Typ	Required
code	tekenreeks of null	Yes
inner_error		No
message	tekenreeks	Yes
param	tekenreeks of null	No
type	tekenreeks	No

Antwoordheaders:

Koptekst	Typ	Description
apim-request-id	tekenreeks	Een aanvraag-id die wordt gebruikt voor probleemoplossingsdoeleinden.

Components

AzureAIFoundryModelsApiVersion

Property	Value
Type	tekenreeks
waarden	`v1` `preview`

AzureContentFilterBlocklistResult

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

Name	Typ	Description	Required	Verstek
details	matrix van object	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 segment van voltooiingstekst zoals gebruikt door Azure OpenAI-inhoudsfilterresultaten.

Name	Typ	Description	Required	Verstek
completion_end_offset	geheel getal (int32)	Offset van het eerste UTF32-codepunt dat van het bereik is uitgesloten. 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	geheel getal (int32)	Verschuiving van het UTF32-codepunt dat begint met het bereik.	Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name	Typ	Description	Required
details	matrix van AzureContentFilterCompletionTextSpan	Gedetailleerde informatie over de gedetecteerde voltooide tekstdelen.	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	Typ	Description	Required	Verstek
details	matrix van object	De paren van individuele onderwerp-ID's en of ze worden herkend.	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	Typ	Description	Required	Verstek
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

AzureContentFilterForResponsesAPI

Name	Typ	Description	Required
geblokkeerd	boolean	Geef aan of het antwoord is geblokkeerd.	Yes
content_filter_offsets	AzureContentFilterResultOffsets		Yes
content_filter_results	AzureContentFilterResultsForResponsesAPI		Yes
└custom_blocklists	AzureContentFilterBlocklistResult	Een verzameling binaire filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└custom_topics	AzureContentFilterCustomTopicResult	Een verzameling binaire filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ fout	object	Indien aanwezig, details over een fout waardoor het filteren van inhoud niet kan worden voltooid.	No
└─ code	geheel getal (int32)	Een afzonderlijke, machineleesbare code die aan de fout is gekoppeld.	Yes
└• bericht	tekenreeks	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	Yes
└─ haat	AzureContentFilterSeverityResult	Een inhoudsfiltercategorie die kan verwijzen naar inhoud die wordt aangevallen of gebruikmaakt van pejoratieve of discriminerende inhoud taal met verwijzing naar een persoon of identiteitsgroep op basis van bepaalde differentiërende kenmerken van deze groepen inclusief, maar niet beperkt tot ras, etniciteit, nationaliteit, genderidentiteit en expressie, seksuele geaardheid, religie, immigratiestatus, vaardigheidsstatus, persoonlijk uiterlijk en lichaamsgrootte.	No
└indirecte_aanval	AzureContentFilterDetectionResult	Een detectieresultaat dat aanvallen beschrijft op systemen die worden aangedreven door Generatieve AI-modellen die elke keer kunnen optreden een toepassing verwerkt informatie die niet rechtstreeks is geschreven door de ontwikkelaar van de toepassing of de gebruiker.	No
└* jailbreak	AzureContentFilterDetectionResult	Een detectieresultaat dat gebruikerspromptinjectieaanvallen beschrijft, waarbij kwaadwillende gebruikers opzettelijk misbruik maken van systeemproblemen om niet-geautoriseerd gedrag van de LLM te voorkomen. Dit kan leiden tot ongepaste inhoud het genereren of schenden van door het systeem opgelegde beperkingen.	Yes
└personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Een detectieresultaat dat overeenkomsten beschrijft op basis van persoonsgegevens met configureerbare subcategorieën.	No
└* grof taalgebruik	AzureContentFilterDetectionResult	Een detectieresultaat waarmee wordt aangegeven of de taal van ruwe, vulgare of anderszins bezwaartaal aanwezig is in de Inhoud.	No
└protected_material_code	object	Een detectieresultaat waarmee een overeenkomst wordt beschreven op basis van gelicentieerde code of ander beveiligd bronmateriaal.	No
└─ bronvermelding	object	Indien beschikbaar, worden de bronvermeldingsgegevens beschreven die de bijbehorende licentie en de locatie ervan beschrijven.	No
└* URL	tekenreeks (URI)	De URL die is gekoppeld aan de licentie.	No
└• licentie	tekenreeks	De naam of id van de licentie die is gekoppeld aan de detectie.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
└protected_material_text	AzureContentFilterDetectionResult	Een detectieresultaat dat een overeenkomst beschrijft tegen tekst die wordt beschermd onder copyright of een andere status.	No
└zelfbeschadiging	AzureContentFilterSeverityResult	Een inhoudsfiltercategorie die de taal beschrijft die betrekking heeft op fysieke acties die bedoeld zijn om opzettelijk pijn te doen, verwonden, schade aan het lichaam of dood jezelf.	No
└* seksueel	AzureContentFilterSeverityResult	Een inhoudsfiltercategorie voor taal met betrekking tot anatomische organen en geslachtsdelen, romantische relaties, handelingen geportretteerd in erotische of genegenheid termen, zwangerschap, fysieke seksuele handelingen, waaronder die afgebeeld als een aanval of een gedwongen seksuele gewelddadige daad tegen wil, prostitutie, pornografie en misbruik.	No
└task_adherence	AzureContentFilterDetectionResult	Een detectieresultaat dat aangeeft of de uitvoeringsstroom het plan nog steeds vasthoudt.	Yes
└ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└* geweld	AzureContentFilterSeverityResult	Een inhoudsfiltercategorie voor taal die betrekking heeft op fysieke acties die zijn bedoeld om pijn te doen, verwonden, beschadigen of doden iemand of zo; beschrijft wapens, wapens en gerelateerde entiteiten, zoals vervaardigingen, verenigingen, wetgeving, enzovoort.	No
source_type	tekenreeks	De naam van het brontype van het bericht.	Yes
tool_call_id	tekenreeks	De ID van de tool-aanroep die bij dit contentfilterresultaat hoort, indien van toepassing.	No

AzureContentFilterPersonallyIdentifiableInformationResult (AzureContentFilterPersoonlijkIdentificeerbareInformatieResultaat)

Een resultaat voor het detecteren van inhoudsfilters voor persoonsgegevens die schadelijke extensies bevat.

Name	Typ	Description	Required
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
redacted_text	tekenreeks	De geredigeerde tekst met PII-informatie is verwijderd of gemaskeerd.	No
subcategorieën	matrix van AzurePiiSubCategoryResult	Gedetailleerde resultaten voor afzonderlijke PIIHarmSubCategorieën.	No

AzureContentFilterResultOffsets

Name	Typ	Required
check_offset	geheel getal (int32)	Yes
end_offset	geheel getal (int32)	Yes
start_offset	geheel getal (int32)	Yes

AzureContentFilterResultsForResponsesAPI

Name	Typ	Description	Required
custom_blocklists	AzureContentFilterBlocklistResult	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste bloklijsten.	No
└─ details weergeven	matrix van object	De paren van afzonderlijke bloklijst-id's en of ze hebben geresulteerd in een filteractie.	No
└* gefilterd	boolean	Een waarde die aangeeft of de bloklijst een filteractie heeft geproduceerd.	Yes
└─ id	tekenreeks	De id van de aangepaste blokkeringslijst die wordt geëvalueerd.	Yes
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde bloklijsten heeft geresulteerd in een filteractie.	Yes
aangepaste_onderwerpen	AzureContentFilterCustomTopicResult	Een verzameling waar-/onwaar-filterresultaten voor geconfigureerde aangepaste onderwerpen.	No
└─ details weergeven	matrix van object	De paren van individuele onderwerp-ID's en of ze worden herkend.	No
└gedetecteerd.	boolean	Een waarde die aangeeft of het onderwerp wordt gedetecteerd.	Yes
└─ id	tekenreeks	De id van het aangepaste onderwerp dat wordt geëvalueerd.	Yes
└* gefilterd	boolean	Een waarde die aangeeft of een van de gedetailleerde onderwerpen heeft geresulteerd in een filteractie.	Yes
fout	object	Indien aanwezig, details over een fout waardoor het filteren van inhoud niet kan worden voltooid.	No
└─ code	geheel getal (int32)	Een afzonderlijke, machineleesbare code die aan de fout is gekoppeld.	Yes
└• bericht	tekenreeks	Een door mensen leesbaar bericht dat aan de fout is gekoppeld.	Yes
hate	AzureContentFilterSeverityResult	Een gelabeld resultaat item van het inhoudsfilter dat aangeeft of de inhoud is gefilterd en wat de kwalitatieve beoordeling is. ernstniveau van de inhoud is, zoals geëvalueerd op basis van de configuratie van het inhoudsfilter voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	Yes
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	Yes
indirect_attack	AzureContentFilterDetectionResult	Een gelabeld resultaat van het inhoudsfilter dat aangeeft of de inhoud is gedetecteerd en wat er met de inhoud is gebeurd. Gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
jailbreak	AzureContentFilterDetectionResult	Een gelabeld resultaat van het inhoudsfilter dat aangeeft of de inhoud is gedetecteerd en wat er met de inhoud is gebeurd. Gefilterd.	Yes
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
persoonlijk identificeerbare informatie	AzureContentFilterPersonallyIdentifiableInformationResult	Een resultaat voor het detecteren van inhoudsfilters voor persoonsgegevens die schadelijke extensies bevat.	No
└ redacted_text	tekenreeks	De geredigeerde tekst met PII-informatie is verwijderd of gemaskeerd.	No
└ subcategorieën	matrix van AzurePiiSubCategoryResult	Gedetailleerde resultaten voor afzonderlijke PIIHarmSubCategorieën.	No
profanity	AzureContentFilterDetectionResult	Een gelabeld resultaat van het inhoudsfilter dat aangeeft of de inhoud is gedetecteerd en wat er met de inhoud is gebeurd. Gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
protected_material_code	object	Een detectieresultaat waarmee een overeenkomst wordt beschreven op basis van gelicentieerde code of ander beveiligd bronmateriaal.	No
└─ bronvermelding	object	Indien beschikbaar, worden de bronvermeldingsgegevens beschreven die de bijbehorende licentie en de locatie ervan beschrijven.	No
└* URL	tekenreeks (URI)	De URL die is gekoppeld aan de licentie.	No
└• licentie	tekenreeks	De naam of id van de licentie die is gekoppeld aan de detectie.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
protected_material_text	AzureContentFilterDetectionResult	Een gelabeld resultaat van het inhoudsfilter dat aangeeft of de inhoud is gedetecteerd en wat er met de inhoud is gebeurd. Gefilterd.	No
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
self_harm	AzureContentFilterSeverityResult	Een gelabeld resultaat item van het inhoudsfilter dat aangeeft of de inhoud is gefilterd en wat de kwalitatieve beoordeling is. ernstniveau van de inhoud is, zoals geëvalueerd op basis van de configuratie van het inhoudsfilter voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	Yes
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	Yes
sexual	AzureContentFilterSeverityResult	Een gelabeld resultaat item van het inhoudsfilter dat aangeeft of de inhoud is gefilterd en wat de kwalitatieve beoordeling is. ernstniveau van de inhoud is, zoals geëvalueerd op basis van de configuratie van het inhoudsfilter voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	Yes
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	Yes
task_adherence	AzureContentFilterDetectionResult	Een gelabeld resultaat van het inhoudsfilter dat aangeeft of de inhoud is gedetecteerd en wat er met de inhoud is gebeurd. Gefilterd.	Yes
└gedetecteerd.	boolean	Of de gelabelde inhoudscategorie is gedetecteerd in de inhoud.	Yes
└* gefilterd	boolean	Of de inhoudsdetectie heeft geresulteerd in een filteractie voor inhoud.	Yes
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	AzureContentFilterSeverityResult	Een gelabeld resultaat item van het inhoudsfilter dat aangeeft of de inhoud is gefilterd en wat de kwalitatieve beoordeling is. ernstniveau van de inhoud is, zoals geëvalueerd op basis van de configuratie van het inhoudsfilter voor de categorie.	No
└* gefilterd	boolean	Of de ernst van de inhoud heeft geresulteerd in een inhoudsfilteractie.	Yes
└─ Ernst	enum	De gelabelde ernst van de inhoud. Mogelijke waarden: `safe`, `low`, , `mediumhigh`	Yes

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	Typ	Description	Required	Verstek
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

AzurePiiSubCategoryResult

Details van resultaten voor afzonderlijke PIIHarmSubCategory(s).

Name	Typ	Description	Required
detected	boolean	Of de subcategorie voor gelabelde inhoud is gedetecteerd in de inhoud.	Yes
filtered	boolean	Of de inhoudsdetectie heeft geresulteerd in een inhoudsfilteractie voor deze subcategorie.	Yes
Geredigeerd	boolean	Of de inhoud is bewerkt voor deze subcategorie.	Yes
sub_category	tekenreeks	De geëvalueerde PIIHarmSubCategory.	Yes

AzureToolApprovalRequest

Azure tool approval request

Een goedkeuringsverzoek van Azure-tools in de responsuitvoer.

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
call_id	tekenreeks	De ID van de tool roept op dat goedkeuring vereist is.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
label	tekenreeks	Het label van het gereedschap (bijvoorbeeld 'remote_functions').	Yes
naam	tekenreeks	De naam van de toolfunctie (bijv. 'output_binding').	Yes
type	enum	Het type item. Altijd `tool_approval_request`. Mogelijke waarden: `tool_approval_request`	Yes

AzureToolApprovalResponse

Azure tool approval response

Een goedkeuringsantwoord van het Azure-tool in de verzoekinvoer.

Name	Typ	Description	Required
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
type	enum	Het type item. Altijd `tool_approval_response`. Mogelijke waarden: `tool_approval_response`	Yes

OpenAI.Annotation

Een aantekening die van toepassing is op een reeks uitvoerteksten.

Discriminateur voor OpenAI.Annotatie

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

Typewaarde	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Typ	Description	Required	Verstek
type	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

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

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Type	tekenreeks
waarden	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Pas patch call outputstatus toe

Resultaatwaarden gerapporteerd voor uitvoer van apply_patch hulpprogramma-aanroep.

Property	Value
Type	tekenreeks
waarden	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Pas patch call status toe

Statuswaarden gerapporteerd voor apply_patch hulpprogramma-aanroepen.

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Patch aanmaken file-operatie

Instructies voor het maken van een bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Diff om toe te passen.	Yes
path	tekenreeks	Pad van het te maken bestand.	Yes
type	enum	Maak een nieuw bestand met de opgegeven diff. Mogelijke waarden: `create_file`	Yes	create_file

OpenAI.ApplyPatchCreateFileOperationParam

Patch aanmaken file-operatie

Instructies voor het maken van een nieuw bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Uniforme diff-inhoud die moet worden toegepast bij het maken van het bestand. Beperkingen: maxLength: 10485760	Yes
path	tekenreeks	Pad van het bestand dat moet worden gemaakt ten opzichte van de hoofdmap van de werkruimte. Beperkingen: minLength: 1	Yes
type	enum	Het bewerkingstype. Altijd `create_file`. Mogelijke waarden: `create_file`	Yes	create_file

OpenAI.ApplyPatchDeleteFileOperation

Apply patch delete file operatie

Instructies voor het verwijderen van een bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
path	tekenreeks	Pad van het bestand dat u wilt verwijderen.	Yes
type	enum	Verwijder het opgegeven bestand. Mogelijke waarden: `delete_file`	Yes	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Apply patch delete file operatie

Instructie voor het verwijderen van een bestaand bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
path	tekenreeks	Pad van het bestand dat moet worden verwijderd ten opzichte van de hoofdmap van de werkruimte. Beperkingen: minLength: 1	Yes
type	enum	Het bewerkingstype. Altijd `delete_file`. Mogelijke waarden: `delete_file`	Yes	delete_file

OpenAI.ApplyPatchFileOperation

Pas patch-operatie toe

Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.

Discriminator voor OpenAI.ApplyPatchFileOperation

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

Typewaarde	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Typ	Description	Required	Verstek
type	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Property	Value
Type	tekenreeks
waarden	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Pas patch-operatie toe

Een van de create_file-, delete_file- of update_file bewerkingen die aan het hulpprogramma apply_patch worden geleverd.

Discriminator voor OpenAI.ApplyPatchOperationParam

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

Typewaarde	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

Property	Value
Type	tekenreeks
waarden	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Apply patch tool

Stelt de assistent in staat om bestanden aan te maken, verwijderen of bijwerken met behulp van unified diffs.

Name	Typ	Description	Required	Verstek
type	enum	Het type hulpprogramma. Altijd `apply_patch`. Mogelijke waarden: `apply_patch`	Yes	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Toepassing van patch-update file operatie

Instructies voor het bijwerken van een bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Diff om toe te passen.	Yes
path	tekenreeks	Pad van het bestand dat moet worden bijgewerkt.	Yes
type	enum	Werk een bestaand bestand bij met de opgegeven diff. Mogelijke waarden: `update_file`	Yes	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Toepassing van patch-update file operatie

Instructies voor het bijwerken van een bestaand bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Geïntegreerde diff-inhoud die moet worden toegepast op het bestaande bestand. Beperkingen: maxLength: 10485760	Yes
path	tekenreeks	Pad van het bestand dat moet worden bijgewerkt ten opzichte van de hoofdmap van de werkruimte. Beperkingen: minLength: 1	Yes
type	enum	Het bewerkingstype. Altijd `update_file`. Mogelijke waarden: `update_file`	Yes	update_file

OpenAI.ApproximateLocation

Name	Typ	Description	Required	Verstek
city	tekenreeks of null		No
country	tekenreeks of null		No
region	tekenreeks of null		No
timezone	tekenreeks of null		No
type	enum	Het type locatie-benadering. Altijd `approximate`. Mogelijke waarden: `approximate`	Yes	benadering

OpenAI.AutoCodeInterpreterToolParam

Parameters van het automatische code-interpreterhulpmiddel

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

Name	Typ	Description	Required	Verstek
file_ids	array van tekenreeksen	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code. Beperkingen: maxItems: 50	No
geheugenlimiet	OpenAI.ContainerMemoryLimit of null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Netwerktoegangsbeleid voor de container.	No
type	enum	Altijd `auto`. Mogelijke waarden: `auto`	Yes	Auto

OpenAI.ClickButtonType

Property	Value
Type	tekenreeks
waarden	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Een klikactie.

Name	Typ	Description	Required	Verstek
knop	OpenAI.ClickButtonType		Yes
keys	matrix van tekenreeks of null		No
type	enum	Hiermee geeft u het gebeurtenistype. Voor een klikactie is deze eigenschap altijd `click`. Mogelijke waarden: `click`	Yes	klikken
x	integer	De x-coördinaat waar de klik heeft plaatsgevonden.	Yes
y	integer	De y-coördinaat waar de klik heeft plaatsgevonden.	Yes

OpenAI.CodeInterpreterOutputImage

Code-interpreter uitvoerbeeld

De beelduitvoer van de code-interpreter.

Name	Typ	Description	Required	Verstek
type	enum	Het type uitvoer. Altijd `image`. Mogelijke waarden: `image`	Yes	image
URL	tekenreeks (URI)	De URL van de beelduitvoer van de code-interpreter.	Yes

OpenAI.CodeInterpreterOutputLogs

Code-interpreter uitvoerlogs

De logboekuitvoer van de code-interpreter.

Name	Typ	Description	Required	Verstek
logs	tekenreeks	De logboekuitvoer van de code-interpreter.	Yes
type	enum	Het type uitvoer. Altijd `logs`. Mogelijke waarden: `logs`	Yes	logs

OpenAI.CodeInterpreterTool

Code-interpreter

Een hulpprogramma waarmee Python-code wordt uitgevoerd om een reactie op een prompt te genereren.

Name	Typ	Description	Required	Verstek
container	string of OpenAI.AutoCodeInterpreterToolParam	De container voor code-interpreters. Kan een container-id of een object zijn dat geeft geüploade bestands-id's op die beschikbaar moeten worden gesteld aan uw code, samen met een optionele `memory_limit` instelling.	Yes
type	enum	Het type code interpreter-programma. Altijd `code_interpreter`. Mogelijke waarden: `code_interpreter`	Yes

OpenAI.ComparisonFilter

Vergelijkingsfilter

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

Name	Typ	Description	Required	Verstek
sleutel	tekenreeks	De sleutel die moet worden vergeleken met de waarde.	Yes
type	enum	Specificeert de vergelijkingsoperator: `eq`, , , `ne`, `gt`, `gte`, `ltlte`, , `innin`. - `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 - `in`:Inch - `nin`: niet in Mogelijke waarden: `eq`, `ne`, `gt`, `gte`, `lt`, , `lteinnin`	Yes	Eq
value	string of number of boolean of array of string of number	De waarde die moet worden vergeleken met de kenmerksleutel; ondersteunt tekenreeks-, getal- of booleaanse typen.	Yes

OpenAI.CompoundFilter

Samengesteld filter

Meerdere filters combineren met and of or.

Name	Typ	Description	Required	Verstek
filters	matrix van OpenAI.ComparisonFilter of object	Matrix van filters die moeten worden gecombineerd. Items kunnen `ComparisonFilter` of `CompoundFilter`.	Yes
type	enum	Type van 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:

Typewaarde	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.WaitParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionList

Computer Actielijst

Afgeplatte batchacties voor computer_use. Elke actie bevat een type discriminator en actiespecifieke velden.

Array van: OpenAI.ComputerAction

OpenAI.ComputerActionType

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

OpenAI.ComputerCallSafetyCheckParam

Een veiligheidscontrole in behandeling voor de computeroproep.

Name	Typ	Description	Required
code	tekenreeks of null		No
id	tekenreeks	De ID van de lopende veiligheidscontrole.	Yes
message	tekenreeks of null		No

OpenAI.ComputerEnvironment

Property	Value
Type	tekenreeks
waarden	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Computerscreenshot

Een schermopname van een computer.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks of null		Yes
image_url	tekenreeks of null		Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schermafbeelding van een computer is deze eigenschap altijd ingesteld op `computer_screenshot`. Mogelijke waarden: `computer_screenshot`	Yes	computer_screenshot

OpenAI.ComputerScreenshotImage

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

Name	Typ	Description	Required	Verstek
file_id	tekenreeks	De id van een geüpload bestand dat de schermopname bevat.	No
image_url	tekenreeks (URI)	De URL van de schermopname.	No
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schermafbeelding van een computer is deze eigenschap altijd ingesteld op `computer_screenshot`. Mogelijke waarden: `computer_screenshot`	Yes	computer_screenshot

OpenAI.ComputerTool

Computer

Een hulpprogramma waarmee een virtuele computer wordt bestuurd.

Name	Typ	Description	Required	Verstek
type	enum	Het type computergereedschap. Altijd `computer`. Mogelijke waarden: `computer`	Yes	Computer

OpenAI.ComputerUsePreviewTool

Computergebruikspreview

Een hulpprogramma waarmee een virtuele computer wordt bestuurd.

Name	Typ	Description	Required	Verstek
schermhoogte	integer	De hoogte van de computerweergave.	Yes
weergavebreedte	integer	De breedte van de computerweergave.	Yes
environment	OpenAI.ComputerEnvironment		Yes
type	enum	Het type hulpprogramma voor computergebruik. Altijd `computer_use_preview`. Mogelijke waarden: `computer_use_preview`	Yes	computer_use_preview

OpenAI.ContainerAutoParam

Name	Typ	Description	Required	Verstek
file_ids	array van tekenreeksen	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code. Beperkingen: maxItems: 50	No
geheugenlimiet	OpenAI.ContainerMemoryLimit of null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Netwerktoegangsbeleid voor de container.	No
Vaardigheden	array van OpenAI.ContainerSkill	Een optionele lijst van vaardigheden die worden aangeduid door id of inline data. Beperkingen: maxItems: 200	No
type	enum	Maakt automatisch een container aan voor dit verzoek Mogelijke waarden: `container_auto`	Yes	container_auto

OpenAI.ContainerFileCitationBody

Containerbestand-citatie

Een citatie voor een containerbestand dat wordt gebruikt om een modelantwoord te genereren.

Name	Typ	Description	Required	Verstek
container_id	tekenreeks	De ID van het containerbestand.	Yes
end_index	integer	De index van het laatste teken van de containerbestand-citatie in het bericht.	Yes
file_id	tekenreeks	De id van het bestand.	Yes
filename	tekenreeks	De bestandsnaam van het genoemde containerbestand.	Yes
start_index	integer	De index van het eerste teken van de containerbestandcitatie in het bericht.	Yes
type	enum	Het type containerbestand, citaat. Altijd `container_file_citation`. Mogelijke waarden: `container_file_citation`	Yes	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Value
Type	tekenreeks
waarden	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Description	Required	Verstek
allowed_domains	array van tekenreeksen	Een lijst van toegestane domeinen wanneer type is `allowlist`. Beperkingen: minItems: 1	Yes
type	enum	Sta uitgaande netwerktoegang alleen toe naar bepaalde domeinen. Altijd `allowlist`. Mogelijke waarden: `allowlist`	Yes	Toestemmingslijst

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Typ	Description	Required	Verstek
type	enum	Schakel uitgaande netwerktoegang uit. Altijd `disabled`. Mogelijke waarden: `disabled`	Yes	uitgeschakeld

OpenAI.ContainerNetworkPolicyParam

Netwerktoegangsbeleid voor de container.

Discriminator voor OpenAI.ContainerNetworkPolicyParam

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

Typewaarde	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ContainerNetworkPolicyParamType		Yes

OpenAI.ContainerNetworkPolicyParamType

Property	Value
Type	tekenreeks
waarden	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

Containerreferentie

Vertegenwoordigt een container die is gemaakt met /v1/containers.

Name	Typ	Description	Required	Verstek
container_id	tekenreeks		Yes
type	enum	Het type omgeving. Altijd `container_reference`. Mogelijke waarden: `container_reference`	Yes	container_reference

OpenAI.ContainerSkill

Discriminator voor OpenAI.ContainerSkill

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

Typewaarde	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ContainerSkillType		Yes

OpenAI.ContainerSkillType

Property	Value
Type	tekenreeks
waarden	`skill_reference` `inline`

OpenAI.ContextManagementParam

Name	Typ	Description	Required	Verstek
compact_threshold	geheel getal of null		No
type	tekenreeks	Het type contextbeheer-invoer. Momenteel wordt alleen 'compactie' ondersteund.	Yes

OpenAI.ConversationParam

Het gesprek waartoe dit antwoord behoort. Items uit dit gesprek worden voorafgegaan aan input_items deze antwoordaanvraag. Invoeritems en uitvoeritems uit dit antwoord worden automatisch toegevoegd aan dit gesprek nadat dit antwoord is voltooid.

Dit onderdeel kan een van de volgende zijn:

string
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Gespreksobject

Het gesprek waartoe dit antwoord behoort.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke id van het gesprek.	Yes

OpenAI.ConversationReference

Gesprek

Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke id van het gesprek waaraan dit antwoord is gekoppeld.	Yes

OpenAI.CoordParam

Coördinaat

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

Name	Typ	Description	Required	Verstek
x	integer	De x-coördinaat.	Yes
y	integer	De y-coördinaat.	Yes

OpenAI.CreateResponse

Name	Typ	Description	Required
achtergrond	Booleaanse waarde of null		No
context_management	array van OpenAI.ContextManagementParam of null	Contextbeheerconfiguratie voor dit verzoek.	No
gesprek	OpenAI.ConversationParam of null		No
include	matrix van OpenAI.IncludeEnum of null		No
input	OpenAI.InputParam	Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie: - Tekstinvoer en -uitvoer - Afbeeldingsingangen - Bestandsinvoer - Gesprekstoestand - Functie-aanroep	No
aanwijzingen	tekenreeks of null		No
max_output_tokens	geheel getal of null		No
max_gereedschap_aanroepen	geheel getal of null		No
metadata	OpenAI.Metadata of null		No
model	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
parallel_gereedschapsoproepen	Booleaanse waarde of null		No
previous_response_id	tekenreeks of null		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
prompt_cache_retention	tekenreeks of null		No
reasoning	OpenAI.Reasoning of null		No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
store	Booleaanse waarde of null		No
stream	Booleaanse waarde of null		No
stream_options	OpenAI.ResponseStreamOptions of null		No
Temperatuur	getal of null		No
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. De twee categorieën tools die u kunt opgeven, zijn: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. de mogelijkheden van het model, zoals het zoeken naar bestanden. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen zodat het uw eigen code kan aanroepen.	No
top_logprobs	geheel getal of null		No
top_p	getal of null		No
truncation	tekenreeks of null		No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No

OpenAI.CustomGrammarFormatParam

Grammaticaformaat

Een grammatica gedefinieerd door de gebruiker.

Name	Typ	Description	Required	Verstek
definitie	tekenreeks	De grammaticale definitie.	Yes
syntaxis	OpenAI.GrammarSyntax1		Yes
type	enum	Grammaticale formaat. Altijd `grammar`. Mogelijke waarden: `grammar`	Yes	Grammatica

OpenAI.CustomTextFormatParam

Tekstopmaak

Onbeperkte vrije vorm tekst.

Name	Typ	Description	Required	Verstek
type	enum	Onbeperkt tekstformaat. Altijd `text`. Mogelijke waarden: `text`	Yes	tekst

OpenAI.CustomToolParam

Aangepaste tool

Een aangepaste tool die input verwerkt met een gespecificeerd formaat. Lees meer over aangepaste tools

Name	Typ	Description	Required	Verstek
defer_loading	boolean	Of deze tool uitgesteld en ontdekt moet worden via tool search.	No
beschrijving	tekenreeks	Optionele beschrijving van de aangepaste tool, gebruikt om meer context te bieden.	No
format	OpenAI.CustomToolParamFormat	Het invoerformaat voor de aangepaste tool. Standaard is onbeperkte tekst.	No
└type.	OpenAI.CustomToolParamFormatType		Yes
naam	tekenreeks	De naam van de aangepaste tool, gebruikt om deze te identificeren in tool-aanroepen.	Yes
type	enum	Het type aangepaste tool. Altijd `custom`. Mogelijke waarden: `custom`	Yes	custom

OpenAI.CustomToolParamFormat

Het invoerformaat voor de aangepaste tool. Standaard is onbeperkte tekst.

Discriminator voor OpenAI.CustomToolParamFormat

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

Typewaarde	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Typ	Description	Required	Verstek
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Property	Value
Type	tekenreeks
waarden	`text` `grammar`

OpenAI.DetailEnum

Property	Value
Type	tekenreeks
waarden	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

Een actie met dubbelklikken.

Name	Typ	Description	Required	Verstek
keys	matrix van tekenreeks of null		Yes
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	double_click
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.DragParam

Drag

Een sleepactie.

Name	Typ	Description	Required	Verstek
keys	matrix van tekenreeks of null		No
path	array van OpenAI.CoordParam	Een matrix met coördinaten die het pad van de sleepactie vertegenwoordigen. Coördinaten worden weergegeven als een matrix van objecten, bijvoorbeeld `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een sleepactie is deze eigenschap altijd ingesteld op `drag`. Mogelijke waarden: `drag`	Yes	Drag

OpenAI.EasyInputMessage

Invoerbericht

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	Typ	Description	Required
inhoud	tekenreeks of OpenAI.InputMessageContentList	Tekst, afbeelding of audio-invoer voor het model, dat wordt gebruikt om een antwoord te genereren. Kan ook eerdere antwoorden van assistenten bevatten.	Yes
phase	OpenAI.MessagePhase of null		No
role	enum	De rol van de berichtinvoer. Een van`user`, `assistant`, of `system` `developer`. Mogelijke waarden: `user`, `assistant`, , `systemdeveloper`	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`	No
type	enum	Het type berichtinvoer. Altijd `message`. Mogelijke waarden: `message`	Yes

OpenAI.EmptyModelParam

Type: objecten

OpenAI.FileCitationBody

Bestandsbronvermelding

Een bronvermelding naar een bestand.

Name	Typ	Description	Required	Verstek
file_id	tekenreeks	De id van het bestand.	Yes
filename	tekenreeks	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	file_citation

OpenAI.FileInputDetail

Property	Value
Type	tekenreeks
waarden	`low` `high`

OpenAI.FilePath

Bestandspad

Een pad naar een bestand.

Name	Typ	Description	Required
file_id	tekenreeks	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.FileSearchTool

Zoeken naar bestanden

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

Name	Typ	Description	Required	Verstek
filters	OpenAI.Filters of null		No
max_aantal_resultaten	integer	Het maximum aantal resultaten dat moet worden geretourneerd. Dit getal moet tussen 1 en 50 liggen.	No
rangschikkingsopties	OpenAI.RankingOptions		No
└hybrid_search	OpenAI.HybridSearchOptions	Gewichten die bepalen hoe reciprocal rank fusion semantische embeddingmatches in balans brengt versus spaarzame trefwoordmatches wanneer hybride zoeken is ingeschakeld.	No
Rangschikker	OpenAI.RankerVersionType	De ranker die moet worden gebruikt voor het zoeken naar bestanden.	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	file_search
vector_store_ids	array van tekenreeksen	De id's van de vectorarchieven om te zoeken.	Yes

OpenAI.FileSearchToolCallResults

Name	Typ	Required
attributes	OpenAI.VectorStoreFileAttributes of null	No
file_id	tekenreeks	No
filename	tekenreeks	No
Score	nummer (float)	No
tekst	tekenreeks	No

OpenAI.Filters

Type: OpenAI.ComparisonFilter of OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Discriminator voor OpenAI.FunctionAndCustomToolCallOutput

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

Typewaarde	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Invoerbestand

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.FileInputDetail		No
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks of null		No
file_url	tekenreeks (URI)	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd `input_file`. Mogelijke waarden: `input_file`	Yes	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Invoerafbeelding

Een afbeeldingsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks of null		No
image_url	tekenreeks of null		No
type	enum	Het type invoeritem. Altijd `input_image`. Mogelijke waarden: `input_image`	Yes	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Invoertekst

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Yes	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Property	Value
Type	tekenreeks
waarden	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Actie van de Shell executive

Voer een shell-opdracht uit.

Name	Typ	Required
Opdrachten	array van tekenreeksen	Yes
max_output_length	geheel getal of null	Yes
timeout_ms (milliseconden)	geheel getal of null	Yes

OpenAI.FunctionShellActionParam

Granaatwerking

Opdrachten en limieten voor het uitvoeren van de aanroep van het shell-hulpprogramma.

Name	Typ	Description	Required
Opdrachten	array van tekenreeksen	Geordende shell-opdrachten voor de uitvoeringsomgeving die moet worden uitgevoerd.	Yes
max_output_length	geheel getal of null		No
timeout_ms (milliseconden)	geheel getal of null		No

OpenAI.FunctionShellCallEnvironment

Discriminator voor OpenAI.FunctionShellCallEnvironment

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

Typewaarde	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellCallEnvironmentType		Yes

OpenAI.FunctionShellCallEnvironmentType

Property	Value
Type	tekenreeks
waarden	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

De omgeving waarin de shell-commando's worden uitgevoerd.

Discriminator voor OpenAI.FunctionShellCallItemParamEnvironment

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

Typewaarde	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellCallItemParamEnvironmentType		Yes

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Typ	Description	Required	Verstek
container_id	tekenreeks	De ID van de genoemde container.	Yes
type	enum	Verwijst naar een container die is aangemaakt met het /v1/containers-eindpunt Mogelijke waarden: `container_reference`	Yes	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Name	Typ	Description	Required	Verstek
Vaardigheden	array van OpenAI.LocalSkillParam	Een optionele lijst met vaardigheden. Beperkingen: maxItems: 200	No
type	enum	Gebruik een lokale computeromgeving. Mogelijke waarden: `local`	Yes	lokaal

OpenAI.FunctionShellCallItemParamEnvironmentType

Property	Value
Type	tekenreeks
waarden	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Status van shell-oproep

Statuswaarden gerapporteerd voor shell-hulpprogramma-aanroepen.

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Shell-aanroep uitvoerinhoud

De inhoud van een shell-hulpprogramma roept uitvoer aan die is verzonden.

Name	Typ	Description	Required
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
resultaat	OpenAI.FunctionShellCallOutputOutcome	Vertegenwoordigt een afsluitresultaat (met een afsluitcode) of een time-outresultaat voor een shell-aanroepuitvoersegment.	Yes
└type.	OpenAI.FunctionShellCallOutputOutcomeType		Yes
Stderr	tekenreeks	De standaardfoutuitvoer die is vastgelegd.	Yes
stdout	tekenreeks	De standaarduitvoer die is vastgelegd.	Yes

OpenAI.FunctionShellCallOutputContentParam

Shell-uitvoerinhoud

Vastgelegde stdout en stderr voor een deel van de uitvoer van een shell-hulpprogramma.

Name	Typ	Description	Required
resultaat	OpenAI.FunctionShellCallOutputOutcomeParam	Het afsluit- of time-outresultaat dat is gekoppeld aan deze shell-aanroep.	Yes
└type.	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
Stderr	tekenreeks	Vastgelegde stderr-uitvoer voor de shell-aanroep. Beperkingen: maxLength: 10485760	Yes
stdout	tekenreeks	Vastgelegde stdout-uitvoer voor de shell-aanroep. Beperkingen: maxLength: 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Uitkomst van de Shell Call exit

Geeft aan dat de shell-commando's zijn voltooid en een exitcode hebben teruggegeven.

Name	Typ	Description	Required	Verstek
exit_code	integer	Sluit code uit het shell-proces.	Yes
type	enum	Het type resultaat. Altijd `exit`. Mogelijke waarden: `exit`	Yes	exit

OpenAI.FunctionShellCallOutputExitOutcomeParam

Uitkomst van de Shell Call exit

Geeft aan dat de shell-commando's zijn voltooid en een exitcode hebben teruggegeven.

Name	Typ	Description	Required	Verstek
exit_code	integer	De exitcode die door het shellproces wordt teruggegeven.	Yes
type	enum	Het type resultaat. Altijd `exit`. Mogelijke waarden: `exit`	Yes	exit

OpenAI.FunctionShellCallOutputOutcome

Uitkomst van de shell call

Vertegenwoordigt een afsluitresultaat (met een afsluitcode) of een time-outresultaat voor een shell-aanroepuitvoersegment.

Discriminator voor OpenAI.FunctionShellCallOutputOutcome

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

Typewaarde	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

Uitkomst van de shell call

Het afsluit- of time-outresultaat dat is gekoppeld aan deze shell-aanroep.

Discriminator voor OpenAI.FunctionShellCallOutputOutcomeParam

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

Typewaarde	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Value
Type	tekenreeks
waarden	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Type	tekenreeks
waarden	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Uitkomst van time-out voor shell-oproep

Geeft aan dat de shell-oproep de geconfigureerde tijdslimiet heeft overschreden.

Name	Typ	Description	Required	Verstek
type	enum	Het type resultaat. Altijd `timeout`. Mogelijke waarden: `timeout`	Yes	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Uitkomst van time-out voor shell-oproep

Geeft aan dat de shell-oproep de geconfigureerde tijdslimiet heeft overschreden.

Name	Typ	Description	Required	Verstek
type	enum	Het type resultaat. Altijd `timeout`. Mogelijke waarden: `timeout`	Yes	timeout

OpenAI.FunctionShellCallStatus

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Schelpengereedschap

Een tool waarmee het model shell-commando's kan uitvoeren.

Name	Typ	Description	Required	Verstek
environment	OpenAI.FunctionShellToolParamEnvironment of null		No
type	enum	Het type schelpgereedschap. Altijd `shell`. Mogelijke waarden: `shell`	Yes	Shell

OpenAI.FunctionShellToolParamEnvironment

Discriminator voor OpenAI.FunctionShellToolParamEnvironment

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

Typewaarde	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellToolParamEnvironmentType		Yes

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Typ	Description	Required	Verstek
container_id	tekenreeks	De ID van de genoemde container.	Yes
type	enum	Verwijst naar een container die is aangemaakt met het /v1/containers-eindpunt Mogelijke waarden: `container_reference`	Yes	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Typ	Description	Required	Verstek
Vaardigheden	array van OpenAI.LocalSkillParam	Een optionele lijst met vaardigheden. Beperkingen: maxItems: 200	No
type	enum	Gebruik een lokale computeromgeving. Mogelijke waarden: `local`	Yes	lokaal

OpenAI.FunctionShellToolParamEnvironmentType

Property	Value
Type	tekenreeks
waarden	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Function

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

Name	Typ	Description	Required	Verstek
defer_loading	boolean	Of deze functie wordt uitgesteld en geladen via toolzoek.	No
beschrijving	tekenreeks of null		No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
parameters	object of null		Yes
streng	Booleaanse waarde of null		Yes
type	enum	Het type functiehulpmiddel. Altijd `function`. Mogelijke waarden: `function`	Yes	function

OpenAI.FunctionToolParam

Name	Typ	Description	Required	Verstek
defer_loading	boolean	Of deze functie uitgesteld en ontdekt moet worden via tool search.	No
beschrijving	tekenreeks of null		No
naam	tekenreeks	Beperkingen: minLengte: 1, maxLengte: 128, patroon: `^[a-zA-Z0-9_-]+$`	Yes
parameters	OpenAI.EmptyModelParam of null		No
streng	Booleaanse waarde of null		No
type	enum	Mogelijke waarden: `function`	Yes	function

OpenAI.GrammarSyntax1

Property	Value
Type	tekenreeks
waarden	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Typ	Description	Required	Verstek
embedding_weight	number	Het gewicht van de inbedding in de reciproke rangfusie.	Yes
text_weight	number	Het gewicht van de tekst in de wederzijdse rangordeningsfusie.	Yes

OpenAI.ImageDetail

Property	Value
Type	tekenreeks
waarden	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Property	Value
Type	tekenreeks
waarden	`generate` `edit` `auto`

OpenAI.ImageGenTool

Beeldgeneratietool

Een tool die afbeeldingen genereert met behulp van de GPT-beeldmodellen.

Geldige modellen:

gpt-image-1
gpt-image-1-mini
gpt-image-1.5

Name	Typ	Description	Required	Verstek
action	OpenAI.ImageGenActionEnum		No
achtergrond	enum	Achtergrondtype voor de gegenereerde afbeelding. Eén van `transparent`, `opaque`, of `auto`. Standaard: `auto`. Mogelijke waarden: `transparent`, `opaqueauto`	No	Auto
invoergetrouwheid	OpenAI.InputFidelity of null		No
invoer_afbeelding_masker	OpenAI.ImageGenToolInputImageMask		No
└─file_id	tekenreeks		No
└─image_url	tekenreeks (URI)		No
model	tekenreeks (zie geldige modellen hieronder)		No
moderation	enum	Beheerniveau voor de gegenereerde afbeelding. Standaard: `auto`. Mogelijke waarden: `auto`, `low`	No	Auto
uitvoercompressie	integer	Compressieniveau voor de uitvoerafbeelding. Standaard: 100. Beperkingen: min. 0, max: 100	No	100
uitvoerformaat	enum	De uitvoerindeling van de gegenereerde afbeelding. Een van `png`, `webp`of `jpeg`. Standaard: `png`. Mogelijke waarden: `png`, `webpjpeg`	No	PNG
gedeeltelijke_afbeeldingen	integer	Aantal gedeeltelijke afbeeldingen dat moet worden gegenereerd in de streamingmodus, van 0 (standaardwaarde) tot 3. Beperkingen: min. 0, max: 3	No
kwaliteit	enum	De kwaliteit van de gegenereerde afbeelding. Een van `low`, `medium`, `high` of `auto`. Standaard: `auto`. Mogelijke waarden: `low`, `medium`, , `highauto`	No	Auto
size	tekenreeks (zie geldige modellen hieronder)	De grootte van de gegenereerde afbeeldingen. Voor `gpt-image-2` en `gpt-image-2-2026-04-21`worden willekeurige resoluties ondersteund als `WIDTHxHEIGHT` strings, bijvoorbeeld `1536x864`. Breedte en hoogte moeten beide deelbaar zijn door 16 en de gevraagde beeldverhouding moet tussen 1:3 en 3:1 liggen. De bovenstaande `2560x1440` resoluties zijn experimenteel, en de maximaal ondersteunde resolutie is `3840x2160`. De gevraagde grootte moet ook voldoen aan de huidige pixel- en randlimieten van het model. De standaardgroottes `1024x1024`, `1536x1024`, en `1024x1536` worden ondersteund door de GPT-afbeeldingsmodellen; `auto` wordt ondersteund voor modellen die automatische dimensionering toestaan. Voor `dall-e-2`, gebruik een van `256x256`, `512x512`, of `1024x1024`. Voor `dall-e-3`, gebruik een van `1024x1024`, `1792x1024`, of `1024x1792`.	No
type	enum	Het type tool voor het genereren van beelden. Altijd `image_generation`. Mogelijke waarden: `image_generation`	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Typ	Description	Required	Verstek
file_id	tekenreeks		No
image_url	tekenreeks (URI)		No

OpenAI.IncludeEnum

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

web_search_call.results: Voeg de zoekresultaten van de webzoektool-call op.
web_search_call.action.sources: Neem de bronnen van de aanroep van het webzoekprogramma op.
code_interpreter_call.outputs: Bevat de output van de uitvoering van Python-code in aanroepitems van het code-interpreterprogramma.
computer_call_output.output.image_url: Neem afbeeldings-URL's op uit de uitkomst 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 in assistentberichten.
reasoning.encrypted_content: Bevat een versleutelde versie van redeneringstokens in de uitvoer van redeneringsitems. Hierdoor kunnen redeneringscomponenten worden gebruikt in gesprekken met meerdere beurten wanneer de antwoorden-API staatloos gebruikt kan worden (zoals wanneer de store parameter is ingesteld op false, of wanneer een organisatie is ingeschreven in het programma voor gegevens zonder retentie).

Property	Value
Description	Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn: - `web_search_call.results`: Voeg de zoekresultaten van de webzoektool-call op. - `web_search_call.action.sources`: Voeg de bronnen van de zoektool-call op. - `code_interpreter_call.outputs`: Bevat de uitvoer van Python-code-uitvoering in aanroepitems van het code-interpreter-hulpprogramma. - `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`: Voeg logprobs toe aan assistentberichten. - `reasoning.encrypted_content`: Bevat een versleutelde versie van redeneringstokens in redeneeruitvoeritems. Hierdoor kunnen redeneringscomponenten worden gebruikt in gesprekken met meerdere beurten wanneer de antwoorden-API staatloos gebruikt kan worden (zoals wanneer de `store` parameter is ingesteld op `false`, of wanneer een organisatie is ingeschreven in het programma voor gegevens zonder retentie).
Type	tekenreeks
waarden	`file_search_call.results` `web_search_call.results` `web_search_call.action.sources` `message.input_image.image_url` `computer_call_output.output.image_url` `code_interpreter_call.outputs` `reasoning.encrypted_content` `message.output_text.logprobs`

OpenAI.InlineSkillParam

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De beschrijving van de vaardigheid.	Yes
naam	tekenreeks	De naam van de vaardigheid.	Yes
bron	OpenAI.InlineSkillSourceParam	Inline vaardigheidslading	Yes
└* gegevens	tekenreeks	Base64-gecodeerde skill zip-bundel. Beperkingen: minLengte: 1, maxLengte: 70254592	Yes
└─ media_type	enum	Het mediatype van de inline vaardigheidslading. Moet `application/zip`zijn. Mogelijke waarden: `application/zip`	Yes	toepassing/zip
└type.	enum	Het type inline vaardigheidsbron. Moet `base64`zijn. Mogelijke waarden: `base64`	Yes	base64
type	enum	Definieert een inline vaardigheid voor dit verzoek. Mogelijke waarden: `inline`	Yes	inline

OpenAI.InlineSkillSourceParam

Inline vaardigheidslading

Name	Typ	Description	Required	Verstek
data	tekenreeks	Base64-gecodeerde skill zip-bundel. Beperkingen: minLengte: 1, maxLengte: 70254592	Yes
media_type	enum	Het mediatype van de inline vaardigheidslading. Moet `application/zip`zijn. Mogelijke waarden: `application/zip`	Yes	toepassing/zip
type	enum	Het type inline vaardigheidsbron. Moet `base64`zijn. Mogelijke waarden: `base64`	Yes	base64

OpenAI.InputContent

Discriminator voor OpenAI.InputContent

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

Typewaarde	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Typ	Description	Required	Verstek
type	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Invoerbestand

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.FileInputDetail		No
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks of null		No
file_url	tekenreeks (URI)	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd `input_file`. Mogelijke waarden: `input_file`	Yes	input_file

OpenAI.InputContentInputImageContent

Invoerafbeelding

Een afbeeldingsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks of null		No
image_url	tekenreeks of null		No
type	enum	Het type invoeritem. Altijd `input_image`. Mogelijke waarden: `input_image`	Yes	input_image

OpenAI.InputContentInputTextContent

Invoertekst

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Yes	input_text

OpenAI.InputContentType

Property	Value
Type	tekenreeks
waarden	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Bepaal hoeveel inspanning het model zal uitoefenen om overeen te komen met de stijl en kenmerken, met name gezichtskenmerken, van invoerafbeeldingen. Deze parameter wordt alleen ondersteund voor gpt-image-1 en gpt-image-1.5 en latere modellen, niet ondersteund voor gpt-image-1-mini. Ondersteunt high en low. Wordt standaard ingesteld op low.

Property	Value
Type	tekenreeks
waarden	`high` `low`

OpenAI.InputFileContent

Invoerbestand

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.FileInputDetail		No
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks of null		No
file_url	tekenreeks (URI)	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd `input_file`. Mogelijke waarden: `input_file`	Yes	input_file

OpenAI.InputFileContentParam

Invoerbestand

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.FileInputDetail		No
file_data	tekenreeks of null		No
file_id	tekenreeks of null		No
file_url	tekenreeks of null		No
filename	tekenreeks of null		No
type	enum	Het type invoeritem. Altijd `input_file`. Mogelijke waarden: `input_file`	Yes	input_file

OpenAI.InputImageContent

Invoerafbeelding

Een afbeeldingsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks of null		No
image_url	tekenreeks of null		No
type	enum	Het type invoeritem. Altijd `input_image`. Mogelijke waarden: `input_image`	Yes	input_image

OpenAI.InputImageContentParamAutoParam

Invoerafbeelding

Een afbeeldingsinvoer voor het model. Leer over beeldinvoer

Name	Typ	Description	Required	Verstek
detail	OpenAI.DetailEnum of null		No
file_id	tekenreeks of null		No
image_url	tekenreeks of null		No
type	enum	Het type invoeritem. Altijd `input_image`. Mogelijke waarden: `input_image`	Yes	input_image

OpenAI.InputItem

Een item dat een deel van de context vertegenwoordigt voor het antwoord dat door het model wordt gegenereerd. Kan tekst, afbeeldingen en audio-invoer bevatten, evenals eerdere antwoorden van assistenten en uitvoer van hulpprogramma-oproepen.

Discriminator voor OpenAI.InputItem

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

Typewaarde	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`tool_search_call`	OpenAI.InputItemToolSearchCallItemParam
`tool_search_output`	OpenAI.InputItemToolSearchOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall
`tool_approval_response`	AzureToolApprovalResponse

Name	Typ	Description	Required	Verstek
type	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

Apply patch tool aanroep

Een hulpprogramma-aanroep die een aanvraag vertegenwoordigt voor het maken, verwijderen of bijwerken van bestanden met behulp van diff-patches.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks of null		No
operatie	OpenAI.ApplyPatchOperationParam	Een van de create_file-, delete_file- of update_file bewerkingen die aan het hulpprogramma apply_patch worden geleverd.	Yes
└type.	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Statuswaarden gerapporteerd voor apply_patch hulpprogramma-aanroepen.	Yes
type	enum	Het type item. Altijd `apply_patch_call`. Mogelijke waarden: `apply_patch_call`	Yes	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Patch tool aanroepuitvoer toepassen

De gestreamde uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks of null		No
output	tekenreeks of null		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Resultaatwaarden gerapporteerd voor uitvoer van apply_patch hulpprogramma-aanroep.	Yes
type	enum	Het type item. Altijd `apply_patch_call_output`. Mogelijke waarden: `apply_patch_call_output`	Yes	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Code-interpreter tool-aanroep

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks of null		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage of null		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijn`in_progress`, , , `completed`en `incompleteinterpretingfailed`. Mogelijke waarden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd `code_interpreter_call`. Mogelijke waarden: `code_interpreter_call`	Yes	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Verdichtingsitem

Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.

Name	Typ	Description	Required	Verstek
encrypted_content	tekenreeks	De versleutelde inhoud van de compressiesamenvatting. Beperkingen: maxLength: 10485760	Yes
id	tekenreeks of null		No
type	enum	Het type item. Altijd `compaction`. Mogelijke waarden: `compaction`	Yes	Verdichting

OpenAI.InputItemComputerCallOutputItemParam

Computertool-oproepuitvoer

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	array van OpenAI.ComputerCallSafetyCheckParam of null		No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks of null		No
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	OpenAI.FunctionCallItemStatus of null		No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd `computer_call_output`. Mogelijke waarden: `computer_call_output`	Yes	computer_call_output

OpenAI.InputItemComputerToolCall

Computertooloproep

Een oproep aan een computergebruikshulpmiddel.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Afgeplatte batchacties voor `computer_use`. Elke actie bevat een `type` discriminator- en actiespecifieke velden.	No
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren 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	Het type computeroproep. Altijd `computer_call`. Mogelijke waarden: `computer_call`	Yes	computer_call

OpenAI.InputItemCustomToolCall

Aangepaste tooloproep

Een aanroep naar een aangepaste tool die door het model is gemaakt.

Name	Typ	Description	Required
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
namespace	tekenreeks	De naamruimte van de aangepaste tool die wordt aangeroepen.	No
type	enum	Het type custom tool-oproep. Altijd `custom_tool_call`. Mogelijke waarden: `custom_tool_call`	Yes

OpenAI.InputItemCustomToolCallOutput

Aangepaste tool-aanroepuitvoer

De uitvoer van een aangepaste hulpprogramma-aanroep vanuit uw code, die naar het model wordt verzonden.

Name	Typ	Description	Required
call_id	tekenreeks	De aanroep-id, die wordt gebruikt om de uitvoer van deze aangepaste hulpprogramma-aanroep toe te wijzen aan een aangepaste aanroep.	Yes
id	tekenreeks	De unieke id van de uitvoer van de aangepaste tooloproep in het OpenAI-platform.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de aanroep van het aangepaste hulpprogramma die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
type	enum	Het type van de uitvoer van de aangepaste hulpprogramma-aanroep. Altijd `custom_tool_call_output`. Mogelijke waarden: `custom_tool_call_output`	Yes

OpenAI.InputItemFileSearchToolCall

Bestandszoektool-aanroep

De resultaten van een aanroep van een zoekprogramma voor bestanden.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults of null		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van `in_progress`, `searching`, `incomplete` of `failed` Mogelijke waarden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd `file_search_call`. Mogelijke waarden: `file_search_call`	Yes

OpenAI.InputItemFunctionCallOutputItemParam

Functie-tool aanroep-uitvoer

De uitvoer van een functiehulpmiddeloproep.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks of null		No
output	tekenreeks of matrix van OpenAI.InputTextContentParam of OpenAI.InputImageContentParamAutoParam of OpenAI.InputFileContentParam	Tekst, afbeelding of bestandsuitvoer van de aanroep van het functiehulpmiddel.	Yes
status	OpenAI.FunctionCallItemStatus of null		No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd `function_call_output`. Mogelijke waarden: `function_call_output`	Yes	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Shell-gereedschap roep

Een hulpprogramma dat een aanvraag vertegenwoordigt voor het uitvoeren van een of meer shell-opdrachten.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellActionParam	Opdrachten en limieten voor het uitvoeren van de aanroep van het shell-hulpprogramma.	Yes
└opdrachten.	array van tekenreeksen	Geordende shell-opdrachten voor de uitvoeringsomgeving die moet worden uitgevoerd.	Yes
└max_output_length	geheel getal of null		No
└timeout_ms	geheel getal of null		No
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
environment	OpenAI.FunctionShellCallItemParamEnvironment of null		No
id	tekenreeks of null		No
status	OpenAI.FunctionShellCallItemStatus of null		No
type	enum	Het type item. Altijd `shell_call`. Mogelijke waarden: `shell_call`	Yes	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Shell tool oproepuitvoer

De gestreamde uitvoeritems die worden verzonden door een shell-hulpprogramma-aanroep.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks of null		No
max_output_length	geheel getal of null		No
output	matrix van OpenAI.FunctionShellCallOutputContentParam	Vastgelegde segmenten van stdout- en stderr-uitvoer, samen met de bijbehorende resultaten.	Yes
status	OpenAI.FunctionShellCallItemStatus of null		No
type	enum	Het type item. Altijd `shell_call_output`. Mogelijke waarden: `shell_call_output`	Yes	shell_call_output

OpenAI.InputItemFunctionToolCall

Functietool-oproep

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks (alleen-lezen)	De unieke id van de aanroep van het functiehulpmiddel.	Yes
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
namespace	tekenreeks	De naamruimte van de functie die uitgevoerd moet worden.	No
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`	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd `function_call`. Mogelijke waarden: `function_call`	Yes

OpenAI.InputItemImageGenToolCall

Beeldgeneratieoproep

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks of null		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: `in_progress`, `completed`, , `generatingfailed`	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd `image_generation_call`. Mogelijke waarden: `image_generation_call`	Yes

OpenAI.InputItemLocalShellToolCall

Lokale schelproep

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

Name	Typ	Description	Required
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: `in_progress`, `completedincomplete`	Yes
type	enum	Het type lokale schelproep. Altijd `local_shell_call`. Mogelijke waarden: `local_shell_call`	Yes

OpenAI.InputItemLocalShellToolCallOutput

Lokale shell-oproepuitvoer

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	tekenreeks of null		No
type	enum	Het type van de lokale shell-tool call output. Altijd `local_shell_call_output`. Mogelijke waarden: `local_shell_call_output`	Yes

OpenAI.InputItemMcpApprovalRequest

MCP-goedkeuringsverzoek

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd `mcp_approval_request`. Mogelijke waarden: `mcp_approval_request`	Yes

OpenAI.InputItemMcpApprovalResponse

MCP-goedkeuringsreactie

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks of null		No
reden	tekenreeks of null		No
type	enum	Het type item. Altijd `mcp_approval_response`. Mogelijke waarden: `mcp_approval_response`	Yes

OpenAI.InputItemMcpListTools

MCP-lijsttools

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

Name	Typ	Description	Required
fout	OpenAI.RealtimeMCPError		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd `mcp_list_tools`. Mogelijke waarden: `mcp_list_tools`	Yes

OpenAI.InputItemMcpToolCall

MCP-tooloproep

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required
approval_request_id	tekenreeks of null		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	OpenAI.RealtimeMCPError		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks of null		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd `mcp_call`. Mogelijke waarden: `mcp_call`	Yes

OpenAI.InputItemOutputMessage

Uitvoerbericht

Een uitvoerbericht van het model.

Name	Typ	Description	Required
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
phase	OpenAI.MessagePhase of null		No
role	enum	De rol van het uitvoerbericht. Altijd `assistant`. Mogelijke waarden: `assistant`	Yes
status	enum	De status van de berichtinvoer. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Yes
type	enum	Het type van het uitvoerbericht. Altijd `message`. Mogelijke waarden: `output_message`	Yes

OpenAI.InputItemReasoningItem

Reasoning

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	Typ	Description	Required
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks of null		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	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`	No
samenvatting	array van OpenAI.SamenvattingTekstInhoud	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd `reasoning`. Mogelijke waarden: `reasoning`	Yes

OpenAI.InputItemToolSearchCallItemParam

Name	Typ	Description	Required	Verstek
arguments	OpenAI.EmptyModelParam		Yes
call_id	tekenreeks of null		No
uitvoering	OpenAI.ToolSearchExecutionType		No
id	tekenreeks of null		No
status	OpenAI.FunctionCallItemStatus of null		No
type	enum	Het itemtype. Altijd `tool_search_call`. Mogelijke waarden: `tool_search_call`	Yes	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Name	Typ	Description	Required	Verstek
call_id	tekenreeks of null		No
uitvoering	OpenAI.ToolSearchExecutionType		No
id	tekenreeks of null		No
status	OpenAI.FunctionCallItemStatus of null		No
tools	matrix van OpenAI.Tool	De geladen tooldefinities worden teruggegeven door de tool-zoekoutput.	Yes
type	enum	Het itemtype. Altijd `tool_search_output`. Mogelijke waarden: `tool_search_output`	Yes	tool_search_output

OpenAI.InputItemType

Property Value

Type tekenreeks

waarden message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
tool_search_call
tool_search_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference
tool_approval_response

OpenAI.InputItemWebSearchToolCall

Web zoektool-oproep

De resultaten van een aanroep van een webzoektool.

Name	Typ	Description	Required
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web gebruikte (zoeken, open_page, find_in_page).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: `in_progress`, `searching`, , `completedfailed`	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd `web_search_call`. Mogelijke waarden: `web_search_call`	Yes

OpenAI.InputMessageContentList

Invoeritem inhoudslijst

Een lijst met een of veel invoeritems voor het model, met verschillende inhoudstypen.

Matrix van: OpenAI.InputContent

OpenAI.InputParam

Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie:

Tekstinvoer en -uitvoer
Beeldinvoer
Bestandsinvoer
Gespreksstatus
Functie aanroepen

Dit onderdeel kan een van de volgende zijn:

string
array

OpenAI.InputTextContent

Invoertekst

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Yes	input_text

OpenAI.InputTextContentParam

Invoertekst

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model. Beperkingen: maxLength: 10485760	Yes
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Yes	input_text

OpenAI.ItemReferenceParam

Itemreferentie

Een interne id voor een item waarnaar moet worden verwezen.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De id van het item waarnaar moet worden verwezen.	Yes
type	enum	Het type item waarnaar moet worden verwezen. Altijd `item_reference`. Mogelijke waarden: `item_reference`	Yes	item_reference

OpenAI.ItemResource

Inhoudsitem dat wordt gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.ItemResource

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

Typewaarde	Schema
`message`	OpenAI.ItemResourceInputMessage
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutput
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCall
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutput
`tool_search_call`	OpenAI.ItemResourceToolSearchCall
`tool_search_output`	OpenAI.ItemResourceToolSearchOutput
`reasoning`	OpenAI.ItemResourceReasoningItem
`compaction`	OpenAI.ItemResourceCompactBody
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall
`custom_tool_call`	OpenAI.ItemResourceCustomToolCallResource
`custom_tool_call_output`	OpenAI.ItemResourceCustomToolCallOutputResource

Name	Typ	Description	Required	Verstek
type	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Apply patch tool aanroep

Een aanroep van een hulpprogramma waarmee bestandsverschil wordt toegepast door bestanden te maken, te verwijderen of bij te werken.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep patchtool toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
operatie	OpenAI.ApplyPatchFileOperation	Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.	Yes
└type.	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Het type item. Altijd `apply_patch_call`. Mogelijke waarden: `apply_patch_call`	Yes	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Patch tool aanroepuitvoer toepassen

De uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die dit hulpprogramma heeft gemaakt, roept uitvoer aan.	No
id	tekenreeks	De unieke id van de uitvoer van de patchtool-aanroep toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks of null		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Het type item. Altijd `apply_patch_call_output`. Mogelijke waarden: `apply_patch_call_output`	Yes	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Code-interpreter tool-aanroep

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks of null		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage of null		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijn`in_progress`, , , `completed`en `incompleteinterpretingfailed`. Mogelijke waarden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd `code_interpreter_call`. Mogelijke waarden: `code_interpreter_call`	Yes	code_interpreter_call

OpenAI.ItemResourceCompactBody

Verdichtingsitem

Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.

Name	Typ	Description	Required	Verstek
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
encrypted_content	tekenreeks	De versleutelde inhoud die is geproduceerd door compressie.	Yes
id	tekenreeks	De unieke ID van het compactie-item.	Yes
type	enum	Het type item. Altijd `compaction`. Mogelijke waarden: `compaction`	Yes	Verdichting

OpenAI.ItemResourceComputerToolCall

Computertooloproep

Een oproep aan een computergebruikshulpmiddel.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Afgeplatte batchacties voor `computer_use`. Elke actie bevat een `type` discriminator- en actiespecifieke velden.	No
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren 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	Het type computeroproep. Altijd `computer_call`. Mogelijke waarden: `computer_call`	Yes	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Computertool-oproepuitvoer

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Yes
id	tekenreeks (alleen-lezen)	De id van de uitvoer van de computertooloproep.	Yes
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	enum	De status van de berichtinvoer. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd `computer_call_output`. Mogelijke waarden: `computer_call_output`	Yes	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Typ	Description	Required
call_id	tekenreeks	De aanroep-id, die wordt gebruikt om de uitvoer van deze aangepaste hulpprogramma-aanroep toe te wijzen aan een aangepaste aanroep.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de aangepaste tooloproep in het OpenAI-platform.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de aanroep van het aangepaste hulpprogramma die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
status	OpenAI.FunctionCallOutputStatusEnum		Yes
type	enum	Het type van de uitvoer van de aangepaste hulpprogramma-aanroep. Altijd `custom_tool_call_output`. Mogelijke waarden: `custom_tool_call_output`	Yes

OpenAI.ItemResourceCustomToolCallResource

ResponseCustomToolCallItem

Name	Typ	Description	Required
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
namespace	tekenreeks	De naamruimte van de aangepaste tool die wordt aangeroepen.	No
status	OpenAI.FunctionCallStatus		Yes
type	enum	Het type custom tool-oproep. Altijd `custom_tool_call`. Mogelijke waarden: `custom_tool_call`	Yes

OpenAI.ItemResourceFileSearchToolCall

Bestandszoektool-aanroep

De resultaten van een aanroep van een zoekprogramma voor bestanden.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults of null		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van `in_progress`, `searching`, `incomplete` of `failed` Mogelijke waarden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd `file_search_call`. Mogelijke waarden: `file_search_call`	Yes

OpenAI.ItemResourceFunctionShellCall

Shell-gereedschap roep

Een hulpprogramma-aanroep waarmee een of meer shell-opdrachten in een beheerde omgeving worden uitgevoerd.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellAction	Voer een shell-opdracht uit.	Yes
└opdrachten.	array van tekenreeksen		Yes
└max_output_length	geheel getal of null		Yes
└timeout_ms	geheel getal of null		Yes
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
environment	OpenAI.FunctionShellCallEnvironment of null		Yes
id	tekenreeks	De unieke id van de aanroep van het shell-hulpprogramma. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
status	OpenAI.FunctionShellCallStatus		Yes
type	enum	Het type item. Altijd `shell_call`. Mogelijke waarden: `shell_call`	Yes	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Shell-oproepuitgang

De uitvoer van een shell-hulpprogramma-aanroep die is verzonden.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de shell-aanroep. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
max_output_length	geheel getal of null		Yes
output	matrix van OpenAI.FunctionShellCallOutputContent	Een matrix met uitvoerinhoud van shell-aanroep	Yes
status	OpenAI.FunctionShellCallOutputStatusEnum		Yes
type	enum	Het type uitvoer van de shell-aanroep. Altijd `shell_call_output`. Mogelijke waarden: `shell_call_output`	Yes	shell_call_output

OpenAI.ItemResourceFunctionToolCall

Functietool-oproep

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks (alleen-lezen)	De unieke id van de aanroep van het functiehulpmiddel.	Yes
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
namespace	tekenreeks	De naamruimte van de functie die uitgevoerd moet worden.	No
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`	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd `function_call`. Mogelijke waarden: `function_call`	Yes

OpenAI.ItemResourceFunctionToolCallOutput

Functie-tool aanroep-uitvoer

De uitvoer van een functiehulpmiddeloproep.

Name	Typ	Description	Required
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks (alleen-lezen)	De unieke ID van de uitvoer van het functiehulpmiddel. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de functie-aanroep die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	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`	No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd `function_call_output`. Mogelijke waarden: `function_call_output`	Yes

OpenAI.ItemResourceImageGenToolCall

Beeldgeneratieoproep

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks of null		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: `in_progress`, `completed`, , `generatingfailed`	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd `image_generation_call`. Mogelijke waarden: `image_generation_call`	Yes

OpenAI.ItemResourceInputMessage

Invoerbericht

Name	Typ	Description	Required	Verstek
inhoud	OpenAI.InputMessageContentList	Een lijst met een of veel invoeritems voor het model, met verschillende inhoud types.	Yes
id	tekenreeks (alleen-lezen)	De unieke id van de berichtinvoer.	Yes
role	enum	De rol van de berichtinvoer. Een van `user`, `system`of `developer`. Mogelijke waarden: `user`, `systemdeveloper`	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`	No
type	enum	Het type berichtinvoer. Altijd ingesteld op `message`. Mogelijke waarden: `message`	Yes	message

OpenAI.ItemResourceLocalShellToolCall

Lokale schelproep

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

Name	Typ	Description	Required
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: `in_progress`, `completedincomplete`	Yes
type	enum	Het type lokale schelproep. Altijd `local_shell_call`. Mogelijke waarden: `local_shell_call`	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

Lokale shell-oproepuitvoer

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	tekenreeks of null		No
type	enum	Het type van de lokale shell-tool call output. Altijd `local_shell_call_output`. Mogelijke waarden: `local_shell_call_output`	Yes

OpenAI.ItemResourceMcpApprovalRequest

MCP-goedkeuringsverzoek

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd `mcp_approval_request`. Mogelijke waarden: `mcp_approval_request`	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

MCP-goedkeuringsreactie

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks	De unieke id van het goedkeuringsantwoord	Yes
reden	tekenreeks of null		No
type	enum	Het type item. Altijd `mcp_approval_response`. Mogelijke waarden: `mcp_approval_response`	Yes

OpenAI.ItemResourceMcpListTools

MCP-lijsttools

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

Name	Typ	Description	Required
fout	OpenAI.RealtimeMCPError		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd `mcp_list_tools`. Mogelijke waarden: `mcp_list_tools`	Yes

OpenAI.ItemResourceMcpToolCall

MCP-tooloproep

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required
approval_request_id	tekenreeks of null		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	OpenAI.RealtimeMCPError		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks of null		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd `mcp_call`. Mogelijke waarden: `mcp_call`	Yes

OpenAI.ItemResourceOutputMessage

Uitvoerbericht

Een uitvoerbericht van het model.

Name	Typ	Description	Required
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
phase	OpenAI.MessagePhase of null		No
role	enum	De rol van het uitvoerbericht. Altijd `assistant`. Mogelijke waarden: `assistant`	Yes
status	enum	De status van de berichtinvoer. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Yes
type	enum	Het type van het uitvoerbericht. Altijd `message`. Mogelijke waarden: `output_message`	Yes

OpenAI.ItemResourceReasoningItem

Reasoning

Name	Typ	Description	Required
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks of null		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	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`	No
samenvatting	array van OpenAI.SamenvattingTekstInhoud	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd `reasoning`. Mogelijke waarden: `reasoning`	Yes

OpenAI.ItemResourceToolSearchCall

Name	Typ	Description	Required	Verstek
arguments		Argumenten gebruikt voor de toolzoekopdracht.	Yes
call_id	tekenreeks of null		Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
uitvoering	OpenAI.ToolSearchExecutionType		Yes
id	tekenreeks	De unieke ID van het toolzoek-aanroepitem.	Yes
status	OpenAI.FunctionCallStatus		Yes
type	enum	Het type item. Altijd `tool_search_call`. Mogelijke waarden: `tool_search_call`	Yes	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Name	Typ	Description	Required	Verstek
call_id	tekenreeks of null		Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
uitvoering	OpenAI.ToolSearchExecutionType		Yes
id	tekenreeks	De unieke ID van het zoekresultaat van het tool.	Yes
status	OpenAI.FunctionCallOutputStatusEnum		Yes
tools	matrix van OpenAI.Tool	De geladen tooldefinities werden teruggegeven door tool search.	Yes
type	enum	Het type item. Altijd `tool_search_output`. Mogelijke waarden: `tool_search_output`	Yes	tool_search_output

OpenAI.ItemResourceType

Property Value

Type tekenreeks

OpenAI.ItemResourceWebSearchToolCall

Web zoektool-oproep

De resultaten van een aanroep van een webzoektool.

Name	Typ	Description	Required
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web gebruikte (zoeken, open_page, find_in_page).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: `in_progress`, `searching`, , `completedfailed`	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd `web_search_call`. Mogelijke waarden: `web_search_call`	Yes

OpenAI.KeyPressAction

KeyPress

Een verzameling toetsaanslagen die het model graag zou willen uitvoeren.

Name	Typ	Description	Required	Verstek
keys	array van tekenreeksen	De toetsencombinatie die het model aanraadt om in te drukken. 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	Toetsdruk

OpenAI.LocalEnvironmentResource

Lokale omgeving

Vertegenwoordigt het gebruik van een lokale omgeving om shell-acties uit te voeren.

Name	Typ	Description	Required	Verstek
type	enum	Het type omgeving. Altijd `local`. Mogelijke waarden: `local`	Yes	lokaal

OpenAI.LocalShellExecAction

Lokale actie van de schotdienst

Voer een shell-opdracht uit op de server.

Name	Typ	Description	Required	Verstek
command	array van tekenreeksen	De opdracht die moet worden uitgevoerd.	Yes
Env	object	Omgevingsvariabelen die moeten worden ingesteld voor de opdracht.	Yes
timeout_ms (milliseconden)	geheel getal of null		No
type	enum	Het type lokale shell-actie. Altijd `exec`. Mogelijke waarden: `exec`	Yes	exec
user	tekenreeks of null		No
working_directory	tekenreeks of null		No

OpenAI.LocalShellToolParam

Lokaal schelpengereedschap

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

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

OpenAI.LocalSkillParam

Name	Typ	Description	Required
beschrijving	tekenreeks	De beschrijving van de vaardigheid.	Yes
naam	tekenreeks	De naam van de vaardigheid.	Yes
path	tekenreeks	Het pad naar de map met de vaardigheid.	Yes

OpenAI.LogProb

Logkansen

De logaritmische waarschijnlijkheid van een token.

Name	Typ	Required
bytes	matrix van geheel getal	Yes
logprob	number	Yes
token	tekenreeks	Yes
top_logprobs	matrix van OpenAI.TopLogProb	Yes

OpenAI.MCPListToolsTool

MCP-lijstgereedschap

Een hulpprogramma dat beschikbaar is op een MCP-server.

Name	Typ	Description	Required
annotations	OpenAI.MCPListToolsToolAnnotations of null		No
beschrijving	tekenreeks of null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
naam	tekenreeks	De naam van het hulpprogramma.	Yes

OpenAI.MCPListToolsToolAnnotations

Type: objecten

OpenAI.MCPListToolsToolInputSchema

Type: objecten

OpenAI.MCPTool

MCP-hulpprogramma

Geef het model toegang tot aanvullende tools via externe MCP-servers (Model Context Protocol).

Name	Typ	Description	Required
toegestane_hulpmiddelen	matrix van tekenreeks of OpenAI.MCPToolFilter of null		No
authorization	tekenreeks	Een OAuth access token die gebruikt kan worden met een externe MCP-server, ofwel met een aangepaste MCP-server-URL of een serviceconnector. Uw toepassing moet de OAuth-autorisatiestroom verwerken en hier het token opgeven.	No
connector_id	enum	Identifier voor serviceconnectors, zoals die beschikbaar zijn in ChatGPT. Een van `server_url` of `connector_id` moet worden verstrekt. Meer informatie over service Connectoren hier. Momenteel ondersteunde `connector_id` waarden zijn: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Agenda: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - Outlook Agenda: `connector_outlookcalendar` - E-mail van Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Mogelijke waarden: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, , `connector_outlookcalendarconnector_outlookemailconnector_sharepoint`	No
defer_loading	boolean	Of deze MCP-tool wordt uitgesteld en ontdekt via toolzoek.	No
headers	object of null		No
goedkeuring vereist	OpenAI.MCPToolRequireApproval of tekenreeks of null		No
server_description	tekenreeks	Optionele beschrijving van de MCP-server, gebruikt om meer context te bieden.	No
server_label	tekenreeks	Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.	Yes
server_url	tekenreeks (URI)	De URL voor de MCP-server. Een van of `server_url` moet een van `connector_id` de verstrekt.	No
type	enum	Het type van de MCP-tool. Altijd `mcp`. Mogelijke waarden: `mcp`	Yes

OpenAI.MCPToolCallStatus

Property	Value
Type	tekenreeks
waarden	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

MCP-toolfilter

Een filterobject om aan te geven welke tools zijn toegestaan.

Name	Typ	Description	Required	Verstek
read_only	boolean	Geeft aan of een tool data wijzigt of alleen-lezen is. Als een MCP-server wordt geannoteerd met `readOnlyHint`, deze komt overeen met dit filter.	No
tool_names	array van tekenreeksen	Lijst met toegestane namen van hulpprogramma's.	No

OpenAI.MCPToolRequireApproval

Name	Typ	Description	Required	Verstek
always	OpenAI.MCPToolFilter	Een filterobject om aan te geven welke tools zijn toegestaan.	No
nooit	OpenAI.MCPToolFilter	Een filterobject om aan te geven welke tools zijn toegestaan.	No

OpenAI.MessageContent

Een inhoudsonderdeel dat een invoer- of uitvoeritem vormt.

Discriminator voor OpenAI.MessageContent

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

Typewaarde	Schema
`text`	OpenAI.TextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent
`summary_text`	OpenAI.SummaryTextContent

Name	Typ	Description	Required	Verstek
type	OpenAI.MessageContentType		Yes

OpenAI.MessageContentInputFileContent

Invoerbestand

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.FileInputDetail		No
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks of null		No
file_url	tekenreeks (URI)	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd `input_file`. Mogelijke waarden: `input_file`	Yes	input_file

OpenAI.MessageContentInputImageContent

Invoerafbeelding

Een afbeeldingsinvoer voor het model.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks of null		No
image_url	tekenreeks of null		No
type	enum	Het type invoeritem. Altijd `input_image`. Mogelijke waarden: `input_image`	Yes	input_image

OpenAI.MessageContentInputTextContent

Invoertekst

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd `input_text`. Mogelijke waarden: `input_text`	Yes	input_text

OpenAI.MessageContentOutputTextContent

Uitvoertekst

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
annotations	matrix van OpenAI.Annotation	De annotaties van de tekstuitvoer.	Yes
logprobs	matrix van OpenAI.LogProb		Yes
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd `output_text`. Mogelijke waarden: `output_text`	Yes	output_text

OpenAI.MessageContentReasoningTextContent

Redeneringstekst

Redenerende tekst uit het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De redeneringstekst van het model.	Yes
type	enum	Het type redeneringstekst. Altijd `reasoning_text`. Mogelijke waarden: `reasoning_text`	Yes	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

Een weigering van het model.

Name	Typ	Description	Required	Verstek
weigering	tekenreeks	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd `refusal`. Mogelijke waarden: `refusal`	Yes	weigering

OpenAI.MessageContentType

Property	Value
Type	tekenreeks
waarden	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

Labelt een assistant bericht als tussentijdse commentaar (commentary) of het eindantwoord (final_answer). Voor modellen zoals en gpt-5.3-codex daarna, bewaar en stuur bij het versturen van opvolgverzoeken de fase van alle assistentberichten opnieuw — het wegvallen ervan kan de prestaties verminderen. Niet gebruikt voor gebruikersberichten.

Property	Value
Type	tekenreeks
waarden	`commentary` `final_answer`

OpenAI.Metadata

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.

Type: objecten

OpenAI.MoveParam

Move

Een actie voor het verplaatsen van de muis.

Name	Typ	Description	Required	Verstek
keys	matrix van tekenreeks of null		No
type	enum	Hiermee geeft u het gebeurtenistype. Voor een verplaatsingsactie is deze eigenschap altijd ingesteld op `move`. Mogelijke waarden: `move`	Yes	move
x	integer	De x-coördinaat om naartoe te verplaatsen.	Yes
y	integer	De y-coördinaat om naar te verplaatsen.	Yes

OpenAI.NamespaceToolParam

Namespace

Groepfunctie/aangepaste tools onder een gedeelde naamruimte.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een beschrijving van de naamruimte die aan het model wordt getoond. Beperkingen: minLength: 1	Yes
naam	tekenreeks	De naamruimtenaam die wordt gebruikt in tool-aanroepen (bijvoorbeeld `crm`). Beperkingen: minLength: 1	Yes
tools	array van OpenAI.FunctionToolParam of OpenAI.CustomToolParam	De functie/aangepaste tools die beschikbaar zijn binnen deze naamruimte. Beperkingen: minItems: 1	Yes
type	enum	Het type hulpprogramma. Altijd `namespace`. Mogelijke waarden: `namespace`	Yes	namespace

OpenAI.OutputContent

Discriminator voor OpenAI.OutputContent

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

Typewaarde	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Typ	Description	Required	Verstek
type	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Uitvoertekst

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
annotations	matrix van OpenAI.Annotation	De annotaties van de tekstuitvoer.	Yes
logprobs	matrix van OpenAI.LogProb		Yes
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd `output_text`. Mogelijke waarden: `output_text`	Yes	output_text

OpenAI.OutputContentReasoningTextContent

Redeneringstekst

Redenerende tekst uit het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De redeneringstekst van het model.	Yes
type	enum	Het type redeneringstekst. Altijd `reasoning_text`. Mogelijke waarden: `reasoning_text`	Yes	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

Een weigering van het model.

Name	Typ	Description	Required	Verstek
weigering	tekenreeks	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd `refusal`. Mogelijke waarden: `refusal`	Yes	weigering

OpenAI.OutputContentType

Property	Value
Type	tekenreeks
waarden	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Discriminator voor OpenAI.OutputItem

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

Typewaarde	Schema
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.OutputItemFunctionToolCallOutput
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemComputerToolCallOutput
`reasoning`	OpenAI.OutputItemReasoningItem
`tool_search_call`	OpenAI.OutputItemToolSearchCall
`tool_search_output`	OpenAI.OutputItemToolSearchOutput
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.OutputItemLocalShellToolCallOutput
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMMcpApprovalRequest
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

Name	Typ	Description	Required	Verstek
type	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Apply patch tool aanroep

Een aanroep van een hulpprogramma waarmee bestandsverschil wordt toegepast door bestanden te maken, te verwijderen of bij te werken.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep patchtool toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
operatie	OpenAI.ApplyPatchFileOperation	Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.	Yes
└type.	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Het type item. Altijd `apply_patch_call`. Mogelijke waarden: `apply_patch_call`	Yes	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Patch tool aanroepuitvoer toepassen

De uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die dit hulpprogramma heeft gemaakt, roept uitvoer aan.	No
id	tekenreeks	De unieke id van de uitvoer van de patchtool-aanroep toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks of null		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Het type item. Altijd `apply_patch_call_output`. Mogelijke waarden: `apply_patch_call_output`	Yes	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Code-interpreter tool-aanroep

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks of null		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage of null		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijn`in_progress`, , , `completed`en `incompleteinterpretingfailed`. Mogelijke waarden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd `code_interpreter_call`. Mogelijke waarden: `code_interpreter_call`	Yes	code_interpreter_call

OpenAI.OutputItemCompactionBody

Verdichtingsitem

Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.

Name	Typ	Description	Required	Verstek
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
encrypted_content	tekenreeks	De versleutelde inhoud die is geproduceerd door compressie.	Yes
id	tekenreeks	De unieke ID van het compactie-item.	Yes
type	enum	Het type item. Altijd `compaction`. Mogelijke waarden: `compaction`	Yes	Verdichting

OpenAI.OutputItemComputerToolCall

Computertooloproep

Een oproep aan een computergebruikshulpmiddel.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Afgeplatte batchacties voor `computer_use`. Elke actie bevat een `type` discriminator- en actiespecifieke velden.	No
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren 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	Het type computeroproep. Altijd `computer_call`. Mogelijke waarden: `computer_call`	Yes	computer_call

OpenAI.OutputItemComputerToolCallOutput

Computertool-oproepuitvoer

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Yes
id	tekenreeks (alleen-lezen)	De id van de uitvoer van de computertooloproep.	Yes
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	enum	De status van de berichtinvoer. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd `computer_call_output`. Mogelijke waarden: `computer_call_output`	Yes	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Typ	Description	Required
call_id	tekenreeks	De aanroep-id, die wordt gebruikt om de uitvoer van deze aangepaste hulpprogramma-aanroep toe te wijzen aan een aangepaste aanroep.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de aangepaste tooloproep in het OpenAI-platform.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de aanroep van het aangepaste hulpprogramma die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
status	OpenAI.FunctionCallOutputStatusEnum		Yes
type	enum	Het type van de uitvoer van de aangepaste hulpprogramma-aanroep. Altijd `custom_tool_call_output`. Mogelijke waarden: `custom_tool_call_output`	Yes

OpenAI.OutputItemCustomToolCallResource

ResponseCustomToolCallItem

Name	Typ	Description	Required
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
namespace	tekenreeks	De naamruimte van de aangepaste tool die wordt aangeroepen.	No
status	OpenAI.FunctionCallStatus		Yes
type	enum	Het type custom tool-oproep. Altijd `custom_tool_call`. Mogelijke waarden: `custom_tool_call`	Yes

OpenAI.OutputItemFileSearchToolCall

Bestandszoektool-aanroep

De resultaten van een aanroep van een zoekprogramma voor bestanden.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults of null		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van `in_progress`, `searching`, `incomplete` of `failed` Mogelijke waarden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd `file_search_call`. Mogelijke waarden: `file_search_call`	Yes

OpenAI.OutputItemFunctionShellCall

Shell-gereedschap roep

Een hulpprogramma-aanroep waarmee een of meer shell-opdrachten in een beheerde omgeving worden uitgevoerd.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellAction	Voer een shell-opdracht uit.	Yes
└opdrachten.	array van tekenreeksen		Yes
└max_output_length	geheel getal of null		Yes
└timeout_ms	geheel getal of null		Yes
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
environment	OpenAI.FunctionShellCallEnvironment of null		Yes
id	tekenreeks	De unieke id van de aanroep van het shell-hulpprogramma. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
status	OpenAI.FunctionShellCallStatus		Yes
type	enum	Het type item. Altijd `shell_call`. Mogelijke waarden: `shell_call`	Yes	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Shell-oproepuitgang

De uitvoer van een shell-hulpprogramma-aanroep die is verzonden.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de shell-aanroep. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
max_output_length	geheel getal of null		Yes
output	matrix van OpenAI.FunctionShellCallOutputContent	Een matrix met uitvoerinhoud van shell-aanroep	Yes
status	OpenAI.FunctionShellCallOutputStatusEnum		Yes
type	enum	Het type uitvoer van de shell-aanroep. Altijd `shell_call_output`. Mogelijke waarden: `shell_call_output`	Yes	shell_call_output

OpenAI.OutputItemFunctionToolCall

Functietool-oproep

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks (alleen-lezen)	De unieke id van de aanroep van het functiehulpmiddel.	Yes
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
namespace	tekenreeks	De naamruimte van de functie die uitgevoerd moet worden.	No
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`	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd `function_call`. Mogelijke waarden: `function_call`	Yes

OpenAI.OutputItemFunctionToolCallOutput

Functie-tool aanroep-uitvoer

De uitvoer van een functiehulpmiddeloproep.

Name	Typ	Description	Required
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks (alleen-lezen)	De unieke ID van de uitvoer van het functiehulpmiddel. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de functie-aanroep die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	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`	No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd `function_call_output`. Mogelijke waarden: `function_call_output`	Yes

OpenAI.OutputItemImageGenToolCall

Beeldgeneratieoproep

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks of null		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: `in_progress`, `completed`, , `generatingfailed`	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd `image_generation_call`. Mogelijke waarden: `image_generation_call`	Yes

OpenAI.OutputItemLocalShellToolCall

Lokale schelproep

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

Name	Typ	Description	Required
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: `in_progress`, `completedincomplete`	Yes
type	enum	Het type lokale schelproep. Altijd `local_shell_call`. Mogelijke waarden: `local_shell_call`	Yes

OpenAI.OutputItemLocalShellToolCallOutput

Lokale shell-oproepuitvoer

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	tekenreeks of null		No
type	enum	Het type van de lokale shell-tool call output. Altijd `local_shell_call_output`. Mogelijke waarden: `local_shell_call_output`	Yes

OpenAI.OutputItemMMcpApprovalRequest

MCP-goedkeuringsverzoek

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd `mcp_approval_request`. Mogelijke waarden: `mcp_approval_request`	Yes

OpenAI.OutputItemMcpApprovalResponseResource

MCP-goedkeuringsreactie

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks	De unieke id van het goedkeuringsantwoord	Yes
reden	tekenreeks of null		No
type	enum	Het type item. Altijd `mcp_approval_response`. Mogelijke waarden: `mcp_approval_response`	Yes

OpenAI.OutputItemMcpListTools

MCP-lijsttools

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

Name	Typ	Description	Required
fout	OpenAI.RealtimeMCPError		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd `mcp_list_tools`. Mogelijke waarden: `mcp_list_tools`	Yes

OpenAI.OutputItemMcpToolCall

MCP-tooloproep

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required
approval_request_id	tekenreeks of null		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	OpenAI.RealtimeMCPError		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks of null		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd `mcp_call`. Mogelijke waarden: `mcp_call`	Yes

OpenAI.OutputItemOutputMessage

Uitvoerbericht

Een uitvoerbericht van het model.

Name	Typ	Description	Required
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
phase	OpenAI.MessagePhase of null		No
role	enum	De rol van het uitvoerbericht. Altijd `assistant`. Mogelijke waarden: `assistant`	Yes
status	enum	De status van de berichtinvoer. Een van `in_progress`, `completed`of `incomplete`. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: `in_progress`, `completedincomplete`	Yes
type	enum	Het type van het uitvoerbericht. Altijd `message`. Mogelijke waarden: `output_message`	Yes

OpenAI.OutputItemReasoningItem

Reasoning

Name	Typ	Description	Required
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks of null		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	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`	No
samenvatting	array van OpenAI.SamenvattingTekstInhoud	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd `reasoning`. Mogelijke waarden: `reasoning`	Yes

OpenAI.OutputItemToolSearchCall

Name	Typ	Description	Required	Verstek
arguments		Argumenten gebruikt voor de toolzoekopdracht.	Yes
call_id	tekenreeks of null		Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
uitvoering	OpenAI.ToolSearchExecutionType		Yes
id	tekenreeks	De unieke ID van het toolzoek-aanroepitem.	Yes
status	OpenAI.FunctionCallStatus		Yes
type	enum	Het type item. Altijd `tool_search_call`. Mogelijke waarden: `tool_search_call`	Yes	tool_search_call

OpenAI.OutputItemToolSearchOutput

Name	Typ	Description	Required	Verstek
call_id	tekenreeks of null		Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
uitvoering	OpenAI.ToolSearchExecutionType		Yes
id	tekenreeks	De unieke ID van het zoekresultaat van het tool.	Yes
status	OpenAI.FunctionCallOutputStatusEnum		Yes
tools	matrix van OpenAI.Tool	De geladen tooldefinities werden teruggegeven door tool search.	Yes
type	enum	Het type item. Altijd `tool_search_output`. Mogelijke waarden: `tool_search_output`	Yes	tool_search_output

OpenAI.OutputItemType

Property Value

Type tekenreeks

waarden output_message
file_search_call
function_call
function_call_output
web_search_call
computer_call
computer_call_output
reasoning
tool_search_call
tool_search_output
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
mcp_approval_response
custom_tool_call
custom_tool_call_output
tool_approval_request

OpenAI.OutputItemWebSearchToolCall

Web zoektool-oproep

De resultaten van een aanroep van een webzoektool.

Name	Typ	Description	Required
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web gebruikte (zoeken, open_page, find_in_page).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: `in_progress`, `searching`, , `completedfailed`	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd `web_search_call`. Mogelijke waarden: `web_search_call`	Yes

OpenAI.OutputMessageContent

Discriminator voor OpenAI.OutputMessageContent

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

Typewaarde	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Typ	Description	Required	Verstek
type	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Uitvoertekst

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
annotations	matrix van OpenAI.Annotation	De annotaties van de tekstuitvoer.	Yes
logprobs	matrix van OpenAI.LogProb		Yes
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd `output_text`. Mogelijke waarden: `output_text`	Yes	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Een weigering van het model.

Name	Typ	Description	Required	Verstek
weigering	tekenreeks	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd `refusal`. Mogelijke waarden: `refusal`	Yes	weigering

OpenAI.OutputMessageContentType

Property	Value
Type	tekenreeks
waarden	`output_text` `refusal`

OpenAI.Prompt

Verwijzing naar een promptsjabloon en de bijbehorende variabelen.

Name	Typ	Description	Required
id	tekenreeks	De unieke identificatie van de promptsjabloon die moet worden gebruikt.	Yes
variables	OpenAI.ResponsePromptVariables of null		No
version	tekenreeks of null		No

OpenAI.RankerVersionType

Property	Value
Type	tekenreeks
waarden	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Typ	Description	Required
hybrid_search	OpenAI.HybridSearchOptions		No
└embedding_weight	number	Het gewicht van de inbedding in de reciproke rangfusie.	Yes
└text_weight	number	Het gewicht van de tekst in de wederzijdse rangordeningsfusie.	Yes
rangschikker	OpenAI.RankerVersionType		No
score-drempelwaarde	number	De scoredrempel voor het zoeken naar bestanden, een getal tussen 0 en 1. Getallen dichter bij 1 proberen alleen de meest relevante resultaten te retourneren, maar kunnen minder resultaten opleveren.	No

OpenAI.RealtimeMCPError

Discriminator voor OpenAI.RealtimeMCPError

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

Typewaarde	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Name	Typ	Description	Required	Verstek
type	OpenAI.RealtimeMcpErrorType		Yes

OpenAI.RealtimeMCPHTTPError

Realtime MCP HTTP-fout

Name	Typ	Description	Required
code	integer		Yes
message	tekenreeks		Yes
type	enum	Mogelijke waarden: `http_error`	Yes

OpenAI.RealtimeMCPProtocolError

Realtime MCP-protocolfout

Name	Typ	Description	Required
code	integer		Yes
message	tekenreeks		Yes
type	enum	Mogelijke waarden: `protocol_error`	Yes

OpenAI.RealtimeMCPToolExecutionError

Realtime MCP-uitvoeringsfout

Name	Typ	Description	Required	Verstek
message	tekenreeks		Yes
type	enum	Mogelijke waarden: `tool_execution_error`	Yes

OpenAI.RealtimeMcpErrorType

Property	Value
Type	tekenreeks
waarden	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

Alleen GPT-5 en O-serie modellen Configuratieopties voor redeneermodellen.

Name	Typ	Description	Required
effort	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn `none`, , , `minimal`, `lowmedium`, en `highxhigh`. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - `gpt-5.1` wordt standaard ingesteld `none`op , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor `gpt-5.1` zijn `none`, `low`, , `medium`en `high`. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór `gpt-5.1` de standaardinstelling voor `medium` redenering en bieden geen ondersteuning `none`voor . - Het `gpt-5-pro` model is standaard ingesteld op (en ondersteunt alleen) `high` redeneringsinspanningen. - `xhigh` wordt ondersteund voor alle modellen na `gpt-5.1-codex-max`.	No
generate_summary	tekenreeks of null		No
samenvatting	tekenreeks of null		No

OpenAI.ReasoningEffort

Beperkt de inspanning voor redenering bij redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.

gpt-5.1 standaard op none, wat geen redeneren uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1.
Alle modellen vóór gpt-5.1 de standaard gebruiken medium redeneerinspanning, en ondersteunen nonegeen .
Het gpt-5-pro model gebruikt standaard (en ondersteunt alleen) high redeneerinspanning.
xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.

Property	Value
Description	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn `none`, , , `minimal`, `lowmedium`, en `highxhigh`. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - `gpt-5.1` wordt standaard ingesteld `none`op , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor `gpt-5.1` zijn `none`, `low`, , `medium`en `high`. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór `gpt-5.1` de standaardinstelling voor `medium` redenering en bieden geen ondersteuning `none`voor . - Het `gpt-5-pro` model is standaard ingesteld op (en ondersteunt alleen) `high` redeneringsinspanningen. - `xhigh` wordt ondersteund voor alle modellen na `gpt-5.1-codex-max`.
Type	tekenreeks
waarden	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Redeneringstekst

Redenerende tekst uit het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De redeneringstekst van het model.	Yes
type	enum	Het type redeneringstekst. Altijd `reasoning_text`. Mogelijke waarden: `reasoning_text`	Yes	reasoning_text

OpenAI.Response

Het responsobject

Name	Typ	Description	Required	Verstek
achtergrond	Booleaanse waarde of null		No
voltooid_op	tekenreeks of null		No
content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
gesprek	OpenAI.ConversationReference of null		No
aangemaakt_op	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
fout	OpenAI.ResponseError of null		Yes
id	tekenreeks	Unieke id voor dit antwoord.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails of null		Yes
aanwijzingen	tekenreeks of matrix van OpenAI.InputItem of null		Yes
max_output_tokens	geheel getal of null		No
max_gereedschap_aanroepen	geheel getal of null		No
metadata	OpenAI.Metadata of null		No
model	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
output	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
output_text	tekenreeks of null		No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
previous_response_id	tekenreeks of null		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
prompt_cache_retention	tekenreeks of null		No
reasoning	OpenAI.Reasoning of null		No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatuur	getal of null		No
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
top_logprobs	geheel getal of null		No
top_p	getal of null		No
truncation	tekenreeks of null		No
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No

OpenAI.ResponseAudioDeltaEvent

Verzonden wanneer er sprake is van een gedeeltelijk audio-antwoord.

Name	Typ	Description	Required
delta	tekenreeks	Een segment van met Base64 gecodeerde audiobytes voor antwoorden. Beperkingen: codering: base64	Yes
sequence_number	integer	Een volgnummer voor dit segment van het streamantwoord.	Yes
type	enum	Het type gebeurtenis. Altijd `response.audio.delta`. Mogelijke waarden: `response.audio.delta`	Yes

OpenAI.ResponseAudioDoneEvent

Verzonden wanneer het audio-antwoord is voltooid.

Name	Typ	Description	Required	Verstek
sequence_number	integer	Het volgnummer van de delta.	Yes
type	enum	Het type gebeurtenis. Altijd `response.audio.done`. Mogelijke waarden: `response.audio.done`	Yes

OpenAI.ResponseAudioTranscriptDeltaEvent

Verzonden wanneer er een gedeeltelijke transcriptie van audio is.

Name	Typ	Description	Required
delta	tekenreeks	Het gedeeltelijke transcript van het audioantwoord.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.audio.transcript.delta`. Mogelijke waarden: `response.audio.transcript.delta`	Yes

OpenAI.ResponseAudioTranscriptDoneEvent

Uitgezonden wanneer het volledige audiotranscript is voltooid.

Name	Typ	Description	Required	Verstek
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.audio.transcript.done`. Mogelijke waarden: `response.audio.transcript.done`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Name	Typ	Description	Required
delta	tekenreeks	Het gedeeltelijke codefragment dat wordt gestreamd door de code-interpreter.	Yes
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de code wordt gestreamd.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis, dat wordt gebruikt om streaming-gebeurtenissen te orden.	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	Typ	Description	Required
code	tekenreeks	De uiteindelijke uitvoer van het codefragment door de code-interpreter.	Yes
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de code is voltooid.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis, dat wordt gebruikt om streaming-gebeurtenissen te orden.	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	Typ	Description	Required
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de aanroep van de code-interpreter is voltooid.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis, dat wordt gebruikt om streaming-gebeurtenissen te orden.	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	Typ	Description	Required
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de aanroep van de code-interpreter wordt uitgevoerd.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis, dat wordt gebruikt om streaming-gebeurtenissen te orden.	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	Typ	Description	Required
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	integer	De index van het uitvoeritem in het antwoord waarvoor de code-interpreter code interpreteert.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis, dat wordt gebruikt om streaming-gebeurtenissen te orden.	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	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└* achtergrond	Booleaanse waarde of null		No
└completed_at	string of null (unixTimestamp)		No
└content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
└gesprek.	OpenAI.ConversationReference of null		No
└ created_at	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError of null		Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails of null		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem of null		Yes
└─max_output_tokens	geheel getal of null		No
└─ max_tool_calls	geheel getal of null		No
└* metagegevens	OpenAI.Metadata of null		No
└model.	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks of null		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks of null		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
└prompt_cache_retention	tekenreeks of null		No
└* redenering	OpenAI.Reasoning of null		No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
└─ Status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	getal of null		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	geheel getal of null		No
└─ top_p	getal of null		No	1
└─ afkapping	tekenreeks of null		No	uitgeschakeld
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.completed`. Mogelijke waarden: `response.completed`	Yes

OpenAI.ResponseContentPartAddedEvent

Verzonden wanneer een nieuw inhoudsonderdeel wordt toegevoegd.

Name	Typ	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat is toegevoegd.	Yes
item_id	tekenreeks	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
deel	OpenAI.OutputContent		Yes
└type.	OpenAI.OutputContentType		Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
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	Typ	Description	Required
content_index	integer	De index van het inhoudsonderdeel dat wordt uitgevoerd.	Yes
item_id	tekenreeks	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
deel	OpenAI.OutputContent		Yes
└type.	OpenAI.OutputContentType		Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
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 gecreëerd.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└* achtergrond	Booleaanse waarde of null		No
└completed_at	string of null (unixTimestamp)		No
└content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
└gesprek.	OpenAI.ConversationReference of null		No
└ created_at	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError of null		Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails of null		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem of null		Yes
└─max_output_tokens	geheel getal of null		No
└─ max_tool_calls	geheel getal of null		No
└* metagegevens	OpenAI.Metadata of null		No
└model.	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks of null		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks of null		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
└prompt_cache_retention	tekenreeks of null		No
└* redenering	OpenAI.Reasoning of null		No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
└─ Status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	getal of null		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	geheel getal of null		No
└─ top_p	getal of null		No	1
└─ afkapping	tekenreeks of null		No	uitgeschakeld
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.created`. Mogelijke waarden: `response.created`	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Gebeurtenis die een delta vertegenwoordigt (gedeeltelijke update) voor de invoer van een aangepaste tool-aanroep.

Name	Typ	Description	Required
delta	tekenreeks	De incrementele invoergegevens (delta) voor de aanroep van het aangepaste hulpprogramma.	Yes
item_id	tekenreeks	Unieke id voor het API-item dat aan deze gebeurtenis is gekoppeld.	Yes
output_index	integer	De index van de uitvoer waar deze delta op van toepassing is.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	De id van het gebeurtenistype. Mogelijke waarden: `response.custom_tool_call_input.delta`	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

ResponseCustomToolCallInputDone

Gebeurtenis die aangeeft dat de invoer voor een aangepaste tool-aanroep is voltooid.

Name	Typ	Description	Required
input	tekenreeks	De volledige invoergegevens voor de aanroep van het aangepaste hulpprogramma.	Yes
item_id	tekenreeks	Unieke id voor het API-item dat aan deze gebeurtenis is gekoppeld.	Yes
output_index	integer	De index van de output waarop dit evenement van toepassing is.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	De id van het gebeurtenistype. Mogelijke waarden: `response.custom_tool_call_input.done`	Yes

OpenAI.ResponseError

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

Name	Typ	Description	Required	Verstek
code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	Yes
message	tekenreeks	Een door mensen leesbare beschrijving van de fout.	Yes

OpenAI.ResponseErrorCode

De foutcode voor het antwoord.

Property	Value
Type	tekenreeks
waarden	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Verzonden wanneer er een fout optreedt.

Name	Typ	Description	Required
code	tekenreeks of null		Yes
message	tekenreeks	Het foutbericht.	Yes
param	tekenreeks of null		Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `error`. Mogelijke waarden: `error`	Yes

OpenAI.ResponseFailedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord mislukt.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└* achtergrond	Booleaanse waarde of null		No
└completed_at	string of null (unixTimestamp)		No
└content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
└gesprek.	OpenAI.ConversationReference of null		No
└ created_at	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError of null		Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails of null		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem of null		Yes
└─max_output_tokens	geheel getal of null		No
└─ max_tool_calls	geheel getal of null		No
└* metagegevens	OpenAI.Metadata of null		No
└model.	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks of null		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks of null		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
└prompt_cache_retention	tekenreeks of null		No
└* redenering	OpenAI.Reasoning of null		No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
└─ Status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	getal of null		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	geheel getal of null		No
└─ top_p	getal of null		No	1
└─ afkapping	tekenreeks of null		No	uitgeschakeld
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
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	Typ	Description	Required
item_id	tekenreeks	De ID van het uitvoeritem waarmee de aanroep voor het zoeken van bestanden wordt gestart.	Yes
output_index	integer	De index van het uitvoeritem waarmee de zoekopdracht naar bestanden wordt gestart.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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	Typ	Description	Required
item_id	tekenreeks	De ID van het uitvoeritem waarmee de aanroep voor het zoeken van bestanden wordt gestart.	Yes
output_index	integer	De index van het uitvoeritem waarmee de zoekopdracht naar bestanden wordt gestart.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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	Typ	Description	Required
item_id	tekenreeks	De ID van het uitvoeritem waarmee 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
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.file_search_call.searching`. Mogelijke waarden: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormatJsonSchemaSchema

JSON-schema

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

Type: objecten

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

Name	Typ	Description	Required
delta	tekenreeks	De toegevoegde delta voor de argumenten van de functieaanroep.	Yes
item_id	tekenreeks	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
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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	Typ	Description	Required
arguments	tekenreeks	De functieoproep-argumenten.	Yes
item_id	tekenreeks	De id van het item.	Yes
naam	tekenreeks	De naam van de bijeenkomst die werd genoemd.	Yes
output_index	integer	De index van het uitvoeritem.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Mogelijke waarden: `response.function_call_arguments.done`	Yes

OpenAI.ResponseImageGenCallCompletedEvent

ResponseImageGenCallCompletedEvent

Uitgevoerd wanneer de aanroep van het hulpprogramma voor het genereren van afbeeldingen is voltooid en de uiteindelijke afbeelding beschikbaar is.

Name	Typ	Description	Required
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.completed'. Mogelijke waarden: `response.image_generation_call.completed`	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

Wordt gegenereerd wanneer een afbeeldingsgeneratiehulpprogramma actief een afbeelding genereert (tussenstatus).

Name	Typ	Description	Required
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.generating'. Mogelijke waarden: `response.image_generation_call.generating`	Yes

OpenAI.ResponseImageGenCallInProgressEvent

ResponseImageGenCallInProgressEvent

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

Name	Typ	Description	Required
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van het item voor het genereren van afbeeldingen dat wordt verwerkt.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.in_progress'. Mogelijke waarden: `response.image_generation_call.in_progress`	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

ResponseImageGenCallPartialImageEvent

Verzonden wanneer een gedeeltelijke afbeelding beschikbaar is tijdens beeldgeneratie streaming.

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

OpenAI.ResponseInProgressEvent

Uitgezonden wanneer het antwoord in uitvoering is.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└* achtergrond	Booleaanse waarde of null		No
└completed_at	string of null (unixTimestamp)		No
└content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
└gesprek.	OpenAI.ConversationReference of null		No
└ created_at	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError of null		Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails of null		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem of null		Yes
└─max_output_tokens	geheel getal of null		No
└─ max_tool_calls	geheel getal of null		No
└* metagegevens	OpenAI.Metadata of null		No
└model.	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks of null		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks of null		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
└prompt_cache_retention	tekenreeks of null		No
└* redenering	OpenAI.Reasoning of null		No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
└─ Status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	getal of null		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	geheel getal of null		No
└─ top_p	getal of null		No	1
└─ afkapping	tekenreeks of null		No	uitgeschakeld
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.in_progress`. Mogelijke waarden: `response.in_progress`	Yes

OpenAI.ResponseIncompleteDetails

Name	Typ	Description	Required	Verstek
reden	enum	Mogelijke waarden: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

Een gebeurtenis die wordt gegenereerd wanneer een reactie eindigt als onvolledig.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└* achtergrond	Booleaanse waarde of null		No
└completed_at	string of null (unixTimestamp)		No
└content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
└gesprek.	OpenAI.ConversationReference of null		No
└ created_at	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError of null		Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails of null		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem of null		Yes
└─max_output_tokens	geheel getal of null		No
└─ max_tool_calls	geheel getal of null		No
└* metagegevens	OpenAI.Metadata of null		No
└model.	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks of null		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks of null		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
└prompt_cache_retention	tekenreeks of null		No
└* redenering	OpenAI.Reasoning of null		No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
└─ Status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	getal of null		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	geheel getal of null		No
└─ top_p	getal of null		No	1
└─ afkapping	tekenreeks of null		No	uitgeschakeld
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.incomplete`. Mogelijke waarden: `response.incomplete`	Yes

OpenAI.ResponseItemList

Een lijst met antwoorditems.

Name	Typ	Description	Required
data	matrix van OpenAI.ItemResource	Een lijst met items die worden gebruikt om dit antwoord te genereren.	Yes
first_id	tekenreeks	De ID van het eerste item in de lijst.	Yes
heeft_meer	boolean	Of er meer items beschikbaar zijn.	Yes
last_id	tekenreeks	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.ResponseLogProb

Een logprob is de logaritmische kans die het model toewijst aan het produceren van een bepaald token op een bepaalde positie in de reeks. Minder negatieve (hogere) logprobwaarden geven een groter modelvertrouwen in die tokenkeuze aan.

Name	Typ	Description	Required
logprob	number	De logboekkans van dit token.	Yes
token	tekenreeks	Een mogelijk teksttoken.	Yes
top_logprobs	matrix van OpenAI.ResponseLogProbTopLogprobs	De log-waarschijnlijkheden van maximaal 20 van de meest waarschijnlijke tokens.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Typ	Description	Required	Verstek
logprob	number		No
token	tekenreeks		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

ReactieMCPCallArgumentsDeltaEvent

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

Name	Typ	Description	Required
delta	tekenreeks	Een JSON-tekenreeks met de gedeeltelijke update van de argumenten voor de aanroep van het MCP-hulpprogramma.	Yes
item_id	tekenreeks	De unieke id van het oproepitem van het MCP-hulpprogramma dat wordt verwerkt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call_arguments.delta'. Mogelijke waarden: `response.mcp_call_arguments.delta`	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

ReactieMCPCallArgumentsDoneEvent

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

Name	Typ	Description	Required
arguments	tekenreeks	Een JSON-tekenreeks met de voltooide argumenten voor de MCP-hulpprogramma-aanroep.	Yes
item_id	tekenreeks	De unieke id van het oproepitem van het MCP-hulpprogramma dat wordt verwerkt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call_arguments.done'. Mogelijke waarden: `response.mcp_call_arguments.done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

ResponseMCPCallCompletedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is voltooid.

Name	Typ	Description	Required
item_id	tekenreeks	De id van het MCP-hulpprogramma oproepitem dat is voltooid.	Yes
output_index	integer	De index van het uitgevoerde item dat is voltooid.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.completed'. Mogelijke waarden: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

ResponseMCPCallFailedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is mislukt.

Name	Typ	Description	Required
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat is mislukt.	Yes
output_index	integer	De index van het uitvoeritem dat is mislukt.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.failed'. Mogelijke waarden: `response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep wordt uitgevoerd.

Name	Typ	Description	Required
item_id	tekenreeks	De unieke id van het oproepitem van het MCP-hulpprogramma dat wordt verwerkt.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.in_progress'. Mogelijke waarden: `response.mcp_call.in_progress`	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

ResponseMCPListToolsCompletedEvent

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

Name	Typ	Description	Required
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat deze uitvoer heeft geproduceerd.	Yes
output_index	integer	De index van het uitvoerende item dat is verwerkt.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.completed'. Mogelijke waarden: `response.mcp_list_tools.completed`	Yes

OpenAI.ResponseMCPListToolsFailedEvent

ResponseMCPListToolsFailedEvent

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

Name	Typ	Description	Required
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat is mislukt.	Yes
output_index	integer	De index van het uitvoeritem dat is mislukt.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.failed'. Mogelijke waarden: `response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

ResponseMCPListToolsInProgressEvent

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

Name	Typ	Description	Required
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat wordt verwerkt.	Yes
output_index	integer	De index van het uitvoeritem dat wordt verwerkt.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd '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	Typ	Description	Required
item	OpenAI.OutputItem		Yes
└type.	OpenAI.OutputItemType		Yes
output_index	integer	De index van het uitvoeritem dat is toegevoegd.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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	Typ	Description	Required
item	OpenAI.OutputItem		Yes
└type.	OpenAI.OutputItemType		Yes
output_index	integer	De index van het uitvoeritem dat is gemarkeerd als voltooid.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.output_item.done`. Mogelijke waarden: `response.output_item.done`	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

ResponseOutputTextAnnotationAddedEvent

Verzonden wanneer een aantekening wordt toegevoegd aan de inhoud van de uitvoertekst.

Name	Typ	Description	Required
annotation	OpenAI.Annotatie	Een aantekening die van toepassing is op een reeks uitvoerteksten.	Yes
└type.	OpenAI.AnnotationType		Yes
annotation_index	integer	De index van de aantekening binnen het inhoudsonderdeel.	Yes
content_index	integer	De index van het inhoudsonderdeel in het uitvoeritem.	Yes
item_id	tekenreeks	De unieke id van het item waaraan de aantekening wordt toegevoegd.	Yes
output_index	integer	De index van het uitvoeritem in de uitvoermatrix van het antwoord.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.output_text.annotation.added'. Mogelijke waarden: `response.output_text.annotation.added`	Yes

OpenAI.ResponsePromptVariables

Promptvariabelen

Optionele lijst van waardes om variabelen in uw prompt te vervangen. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.

Type: objecten

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Wordt uitgezonden wanneer een antwoord in de wachtrij staat en op verwerking wacht.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└* achtergrond	Booleaanse waarde of null		No
└completed_at	string of null (unixTimestamp)		No
└content_filters	matrix van AzureContentFilterForResponsesAPI	De resultaten van het inhoudsfilter van RAI.	No
└gesprek.	OpenAI.ConversationReference of null		No
└ created_at	geheel getal (Unixtime)	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError of null		Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails of null		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem of null		Yes
└─max_output_tokens	geheel getal of null		No
└─ max_tool_calls	geheel getal of null		No
└* metagegevens	OpenAI.Metadata of null		No
└model.	tekenreeks	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals `gpt-4o` of `o3`. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestaties kenmerken en prijspunten. Raadpleeg de modelgids om door beschikbare modellen te bladeren en te vergelijken.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op `response`. Mogelijke waarden: `response`	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de `output` matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de `output` matrix en ervan uitgaande dat het een `assistant` bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de `output_text` eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks of null		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks of null		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het `user` veld.	No
└prompt_cache_retention	tekenreeks of null		No
└* redenering	OpenAI.Reasoning of null		No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De ID's moeten een string zijn die elke gebruiker uniek identificeert, met een maximale lengte van 64 tekens. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Beperkingen: maxLengte: 64	No
└─ Status	enum	De status van de reactiegeneratie. Een van `completed`, `failed` `in_progress`, `cancelled`, `queued` of `incomplete`. Mogelijke waarden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└─ temperatuur	getal of null		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - Tekstinvoer en -uitvoer - Gestructureerde uitvoer	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de `tool_choice` parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoekopdrachten Of het zoeken in bestanden. Meer informatie over ingebouwde gereedschappen. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	geheel getal of null		No
└─ top_p	getal of null		No	1
└─ afkapping	tekenreeks of null		No	uitgeschakeld
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door `safety_identifier` en `prompt_cache_key`. Gebruik `prompt_cache_key` in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen.	No
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd 'response.queued'. Mogelijke waarden: `response.queued`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Verzonden wanneer een nieuw redeneringssamenvattingsonderdeel wordt toegevoegd.

Name	Typ	Description	Required
item_id	tekenreeks	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
deel	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└─ tekst	tekenreeks		Yes
└type.	enum	Mogelijke waarden: `summary_text`	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
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.ResponseReasoningSummaryPartAddedEventPart

Name	Typ	Description	Required	Verstek
tekst	tekenreeks		Yes
type	enum	Mogelijke waarden: `summary_text`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Verzonden wanneer een samenvattingsonderdeel met redenering is voltooid.

Name	Typ	Description	Required
item_id	tekenreeks	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
deel	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└─ tekst	tekenreeks		Yes
└type.	enum	Mogelijke waarden: `summary_text`	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
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.ResponseReasoningSummaryPartDoneEventPart

Name	Typ	Description	Required	Verstek
tekst	tekenreeks		Yes
type	enum	Mogelijke waarden: `summary_text`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Verzonden wanneer een delta wordt toegevoegd aan een redeneringssamenvattingstekst.

Name	Typ	Description	Required
delta	tekenreeks	De tekst delta die is toegevoegd aan de samenvatting.	Yes
item_id	tekenreeks	De ID van het item waarmee deze delta van de samenvattingstekst is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee deze delta van de samenvattingstekst is verbonden.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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	Typ	Description	Required
item_id	tekenreeks	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
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
summary_index	integer	De index van het samenvattingsonderdeel in de redeneringssamenvatting.	Yes
tekst	tekenreeks	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.ResponseReasoningTextDeltaEvent

Verzonden wanneer een delta wordt toegevoegd aan een redeneringstekst.

Name	Typ	Description	Required
content_index	integer	De index van het redenerende inhoudsonderdeel waarmee deze delta is gekoppeld.	Yes
delta	tekenreeks	De tekst delta die is toegevoegd aan de redeneringsinhoud.	Yes
item_id	tekenreeks	De id van het item waarmee deze redeneringstekst delta is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee deze redenerende tekstdelta wordt gekoppeld.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
type	enum	Het type gebeurtenis. Altijd `response.reasoning_text.delta`. Mogelijke waarden: `response.reasoning_text.delta`	Yes

OpenAI.ResponseReasoningTextDoneEvent

Verzonden wanneer een redeneringstekst is voltooid.

Name	Typ	Description	Required
content_index	integer	Het deel over de inhoud van de redenering.	Yes
item_id	tekenreeks	De id van het item waarmee deze redeneringstekst is gekoppeld.	Yes
output_index	integer	De index van het uitvoeritem waarmee deze redeneertekst is gekoppeld.	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	Yes
tekst	tekenreeks	De volledige tekst van de voltooide redeneringsinhoud.	Yes
type	enum	Het type gebeurtenis. Altijd `response.reasoning_text.done`. Mogelijke waarden: `response.reasoning_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Verzonden wanneer er sprake is van een gedeeltelijke weigeringstekst.

Name	Typ	Description	Required
content_index	integer	De index van het inhoudsonderdeel waaraan de weigeringstekst wordt toegevoegd.	Yes
delta	tekenreeks	De weigeringstekst die wordt toegevoegd.	Yes
item_id	tekenreeks	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
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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	Typ	Description	Required
content_index	integer	De index van het inhoudsdeel waarbij de weigeringstekst wordt afgerond.	Yes
item_id	tekenreeks	De id van het uitvoeritem waarvan de weigeringstekst is voltooid.	Yes
output_index	integer	De index van het uitvoeritem waarin de weigeringstekst is afgerond.	Yes
weigering	tekenreeks	De afgeronde weigeringstekst	Yes
sequence_number	integer	Het volgnummer van deze gebeurtenis.	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:

Typewaarde	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptDoneEvent
`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
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`response.custom_tool_call_input.delta`	OpenAI.ResponseCustomToolCallInputDeltaEvent
`response.custom_tool_call_input.done`	OpenAI.ResponseCustomToolCallInputDoneEvent
`error`	OpenAI.ResponseErrorEvent
`response.failed`	OpenAI.ResponseFailedEvent
`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.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.in_progress`	OpenAI.ResponseInProgressEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`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.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.output_text.annotation.added`	OpenAI.ResponseOutputTextAnnotationAddedEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`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.reasoning_text.delta`	OpenAI.ResponseReasoningTextDeltaEvent
`response.reasoning_text.done`	OpenAI.ResponseReasoningTextDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.audio.delta`	OpenAI.ResponseAudioDeltaEvent

Name	Typ	Description	Required	Verstek
type	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Property Value

Type tekenreeks

waarden response.audio.delta
response.audio.done
response.audio.transcript.delta
response.audio.transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.reasoning_text.delta
response.reasoning_text.done
response.refusal.delta
response.refusal.done
response.output_text.delta
response.output_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.output_text.annotation.added
response.queued
response.custom_tool_call_input.delta
response.custom_tool_call_input.done

OpenAI.ResponseStreamOptions

Opties voor streamingreacties. Stel dit alleen in wanneer u instelt stream: true.

Name	Typ	Description	Required	Verstek
include_obfuscation	boolean	Wanneer waar, wordt de verdoezeling van stromen ingeschakeld. Stream-verdoofing voegt toe willekeurige tekens naar een `obfuscation` veld bij streaming-deltagebeurtenissen naar normaliseer nettoladinggrootten als een beperking voor bepaalde side-channel-aanvallen. Deze verborgen velden zijn standaard opgenomen, maar voeg een kleine hoeveelheid toe overhead naar de gegevensstroom. U kunt instellen `include_obfuscation` op false om te optimaliseren voor bandbreedte als u de netwerkkoppelingen tussen uw toepassing en de OpenAI-API.	No

OpenAI.ResponseTextDeltaEvent

Verzonden wanneer er een extra tekstdelta is.

Name	Typ	Description	Required
content_index	integer	De index van het inhoudsonderdeel waaraan de tekstdelta is toegevoegd.	Yes
delta	tekenreeks	De tekstdelta die is toegevoegd.	Yes
item_id	tekenreeks	De ID van het uitvoerelement waaraan de tekstdelta is toegevoegd.	Yes
logprobs	matrix van OpenAI.ResponseLogProb	De logboekkans van de tokens in de delta.	Yes
output_index	integer	De index van het uitvoeritem waaraan de tekstdelta is toegevoegd.	Yes
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	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	Typ	Description	Required
content_index	integer	De index van het inhoudsonderdeel waar de tekstinhoud wordt afgerond.	Yes
item_id	tekenreeks	De id van het uitvoeritem waarvan de tekstinhoud is voltooid.	Yes
logprobs	matrix van OpenAI.ResponseLogProb	De logboekkans van de tokens in de delta.	Yes
output_index	integer	De index van het uitvoeritem waarvoor de tekstinhoud is voltooid.	Yes
sequence_number	integer	Het volgnummer voor deze gebeurtenis.	Yes
tekst	tekenreeks	De inhoud van de tekst die is voltooid.	Yes
type	enum	Het type gebeurtenis. Altijd `response.output_text.done`. Mogelijke waarden: `response.output_text.done`	Yes

OpenAI.ResponseTextParam

Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn. Meer informatie:

Tekstinvoer en -uitvoer
Gestructureerde uitvoer

Name	Typ	Description	Required	Verstek
format	OpenAI.TextResponseFormatConfiguration	Een object dat de indeling aangeeft die het model moet uitvoeren. `{ "type": "json_schema" }` Configureren maakt gestructureerde uitvoer mogelijk, dit zorgt ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie in de De standaardindeling is `{ "type": "text" }` zonder extra opties. Niet aanbevolen voor gpt-4o- en nieuwere modellen: Instellen van `{ "type": "json_object" }` schakelt de oudere JSON-modus in, die zorgt ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruiken van `json_schema` heeft de voorkeur voor modellen die dit ondersteunen.	No
langdradigheid	OpenAI.Verbosity	Beperkt de omvangrijkheid van het antwoord van het model. Lagere waarden resulteren in beknoptere antwoorden, terwijl hogere waarden leiden tot uitgebreidere antwoorden. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`.	No

OpenAI.ResponseUsage

Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.

Name	Typ	Description	Required
input_tokens	integer	Het aantal invoertokens.	Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└ cached_tokens	integer		Yes
output_tokens	integer	Het aantal uitvoertokens.	Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ redeneertokens	integer		Yes
total_tokens	integer	Het totale aantal gebruikte tokens.	Yes

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Required	Verstek
cached_tokens	integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Required	Verstek
redeneringssymbolen	integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Typ	Description	Required
item_id	tekenreeks	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
sequence_number	integer	Het volgnummer van de webzoekopdracht die wordt verwerkt.	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	Typ	Description	Required
item_id	tekenreeks	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
sequence_number	integer	Het volgnummer van de webzoekopdracht die wordt verwerkt.	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	Typ	Description	Required
item_id	tekenreeks	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
sequence_number	integer	Het volgnummer van de webzoekopdracht die wordt verwerkt.	Yes
type	enum	Het type gebeurtenis. Altijd `response.web_search_call.searching`. Mogelijke waarden: `response.web_search_call.searching`	Yes

OpenAI.ScreenshotParam

Screenshot

Een schermopnameactie.

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

OpenAI.ScrollParam

Scroll

Een scrollactie.

Name	Typ	Description	Required	Verstek
keys	matrix van tekenreeks of null		No
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	Schuiven
x	integer	De x-coördinaat waar de scrollactie heeft plaatsgevonden.	Yes
y	integer	De y-coördinaat waar de scroll heeft plaatsgevonden.	Yes

OpenAI.SearchContentType

Property	Value
Type	tekenreeks
waarden	`text` `image`

OpenAI.SearchContextSize

Property	Value
Type	tekenreeks
waarden	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Typ	Description	Required	Verstek
skill_id	tekenreeks	De ID van de genoemde vaardigheid. Beperkingen: minLength: 1, maxLength: 64	Yes
type	enum	Verwijst naar een vaardigheid die is gemaakt met het /v1/skills-eindpunt. Mogelijke waarden: `skill_reference`	Yes	skill_reference
version	tekenreeks	Optionele vaardigheidsversie. Gebruik een positief geheel getal of 'laatste'. Laat weg voor standaard.	No

OpenAI.SpecificApplyPatchParam

Specifieke keuze voor toepassing van patch tool

Hiermee dwingt u het model om het apply_patch hulpprogramma aan te roepen bij het uitvoeren van een hulpprogramma-aanroep.

Name	Typ	Description	Required	Verstek
type	enum	Het hulpprogramma dat moet worden aangeroepen. Altijd `apply_patch`. Mogelijke waarden: `apply_patch`	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Specifieke keuze voor shellgereedschap

Dwingt het model om het shell-hulpprogramma aan te roepen wanneer een hulpprogramma-aanroep is vereist.

Name	Typ	Description	Required	Verstek
type	enum	Het hulpprogramma dat moet worden aangeroepen. Altijd `shell`. Mogelijke waarden: `shell`	Yes	Shell

OpenAI.SummaryTextContent

Samenvattende tekst

Een samenvattende tekst van het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	Een samenvatting van de redeneerresultaten van het model tot nu toe.	Yes
type	enum	Het type van het object. Altijd `summary_text`. Mogelijke waarden: `summary_text`	Yes	summary_text

OpenAI.TextContent

Tekstinhoud

Een tekstinhoud.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks		Yes
type	enum	Mogelijke waarden: `text`	Yes	tekst

OpenAI.TextResponseFormatConfiguration

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. Meer informatie in de

De standaardindeling is { "type": "text" } zonder extra opties. Niet aanbevolen voor GPT-4o en nieuwere modellen: Instellen om de oudere JSON-modus in { "type": "json_object" } te schakelen, die ervoor zorgt dat het bericht dat het model genereert geldige JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.

Discriminator voor OpenAI.TextResponseFormatConfiguration

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

Typewaarde	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Typ	Description	Required	Verstek
type	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON-object

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	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_object`. Mogelijke waarden: `json_object`	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.

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

OpenAI.TextResponseFormatConfigurationType

Property	Value
Type	tekenreeks
waarden	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

JSON-schema

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

Name	Typ	Description	Required
beschrijving	tekenreeks	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om bepalen hoe moet worden gereageerd volgens de voorgeschreven manier.	No
naam	tekenreeks	De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 zijn, of bevatten onderstrepingstekens en streepjes, met een maximale lengte van 64 tekens.	Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	Yes
streng	Booleaanse waarde of null		No
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd `json_schema`. Mogelijke waarden: `json_schema`	Yes

OpenAI.Tool

Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.Tool

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

Typewaarde	Schema
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam
`computer`	OpenAI.ComputerTool
`namespace`	OpenAI.NamespaceToolParam
`tool_search`	OpenAI.ToolSearchToolParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Toegestane tools

Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set.

Name	Typ	Description	Required
modus	enum	Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set. `auto` hiermee kan het model kiezen uit de toegestane hulpprogramma's en een bericht. `required` vereist dat het model een of meer van de toegestane hulpprogramma's aanroept. Mogelijke waarden: `auto`, `required`	Yes
tools	matrix van object	Een lijst met hulpprogrammadefinities die het model mag aanroepen. Voor de Antwoorden-API kan de lijst met hulpprogrammadefinities er als volgt uitzien: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Yes
type	enum	Toegestaan configuratietype voor hulpprogramma's. Altijd `allowed_tools`. Mogelijke waarden: `allowed_tools`	Yes

OpenAI.ToolChoiceCodeInterpreter

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `code_interpreter`	Yes

OpenAI.ToolChoiceComputer

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `computer`	Yes

OpenAI.ToolChoiceComputerUse

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `computer_use`	Yes

OpenAI.ToolChoiceComputerUsePreview

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `computer_use_preview`	Yes

OpenAI.ToolChoiceCustom

Aangepaste tool

Gebruik deze optie om af te dwingen dat het model een specifiek aangepast hulpprogramma aanroept.

Name	Typ	Description	Required	Verstek
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat moet worden aangeroepen.	Yes
type	enum	Voor het aanroepen van aangepaste hulpprogramma's is het type altijd `custom`. Mogelijke waarden: `custom`	Yes

OpenAI.ToolChoiceFileSearch

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `file_search`	Yes

OpenAI.ToolChoiceFunction

Functie-instrument

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

Name	Typ	Description	Required	Verstek
naam	tekenreeks	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.ToolChoiceImageGeneration

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `image_generation`	Yes

OpenAI.ToolChoiceMCP

MCP-hulpprogramma

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

Name	Typ	Description	Required
naam	tekenreeks of null		No
server_label	tekenreeks	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.ToolChoiceOptions

Gereedschapskeuzemodus

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
Type	tekenreeks
waarden	`none` `auto` `required`

OpenAI.ToolChoiceParam

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.

Discriminator voor OpenAI.ToolChoiceParam

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

Typewaarde	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.ToolChoiceComputerUse
`function`	OpenAI.ToolChoiceFunction

Name	Typ	Description	Required	Verstek
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Property	Value
Type	tekenreeks
waarden	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter` `computer` `computer_use`

OpenAI.ToolChoiceWebSearchPreview

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `web_search_preview`	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `web_search_preview_2025_03_11`	Yes

OpenAI.ToolSearchExecutionType

Property	Value
Type	tekenreeks
waarden	`server` `client`

OpenAI.ToolSearchToolParam

Toolzoektool

Gehoste of BYOT-toolzoekconfiguratie voor uitgestelde tools.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks of null		No
uitvoering	OpenAI.ToolSearchExecutionType		No
parameters	OpenAI.EmptyModelParam of null		No
type	enum	Het type hulpprogramma. Altijd `tool_search`. Mogelijke waarden: `tool_search`	Yes	tool_search

OpenAI.ToolType

Property	Value
Type	tekenreeks
waarden	`function` `file_search` `computer` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `namespace` `tool_search` `web_search_preview` `apply_patch`

OpenAI.ToolsArray

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. We ondersteunen de volgende categorieën hulpprogramma's:

Ingebouwde tools: Tools die door OpenAI worden aangeboden en de mogelijkheden van het model uitbreiden, zoals webzoeken of bestandszoeken. Lees meer over ingebouwde tools.
MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors zoals Google Drive en SharePoint. Lees meer over MCP Tools.
Functie-aanroepen (aangepaste hulpprogramma's): functies die door u worden gedefinieerd, zodat het model uw eigen code kan aanroepen met sterk getypte argumenten en uitvoer. Meer informatie over het aanroepen van functies. U kunt ook aangepaste hulpprogramma's gebruiken om uw eigen code aan te roepen.

Matrix van: OpenAI.Tool

OpenAI.TopLogProb

Top log-waarschijnlijkheid

De hoogste logaritmische waarschijnlijkheid van een token.

Name	Typ	Required
bytes	matrix van geheel getal	Yes
logprob	number	Yes
token	tekenreeks	Yes

OpenAI.TypeParam

Type

Een actie om tekst te typen.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	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	type

OpenAI.UrlCitationBody

URL-citatie

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

Name	Typ	Description	Required	Verstek
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	tekenreeks	De titel van de webresource.	Yes
type	enum	Het type URL-bronvermelding. Altijd `url_citation`. Mogelijke waarden: `url_citation`	Yes	url_citation
URL	tekenreeks (URI)	De URL van de webresource.	Yes

OpenAI.VectorStoreFileAttributes

Type: objecten

OpenAI.Verbosity

Beperkt de omvangrijkheid van het antwoord van het model. Lagere waarden zorgen voor beknoptere antwoorden, terwijl hogere waarden meer uitgebreide antwoorden opleveren. Momenteel ondersteunde waarden zijn low, mediumen high.

Property	Value
Description	Beperkt de omvangrijkheid van het antwoord van het model. Lagere waarden resulteren in beknoptere antwoorden, terwijl hogere waarden leiden tot uitgebreidere antwoorden. Momenteel ondersteunde waarden zijn `low`, `medium`en `high`.
Type	tekenreeks
waarden	`low` `medium` `high`

OpenAI.WaitParam

Wait

Een wachtactie.

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

OpenAI.WebSearchActionFind

Actie vinden

Actietype "find_in_page": Zoekt naar een patroon binnen een geladen pagina.

Name	Typ	Description	Required
pattern	tekenreeks	Het patroon of de tekst die u op de pagina wilt zoeken.	Yes
type	enum	Het actietype. Mogelijke waarden: `find_in_page`	Yes
URL	tekenreeks (URI)	De URL van de pagina waarnaar het patroon is gezocht.	Yes

OpenAI.WebSearchActionOpenPage

Open pagina actie

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

Name	Typ	Description	Required	Verstek
type	enum	Het actietype. Mogelijke waarden: `open_page`	Yes
URL	tekenreeks of null	De URL die door het model is geopend.	No

OpenAI.WebSearchActionSearch

Zoekactie

Actietype 'zoeken': voert een webzoekquery uit.

Name	Typ	Description	Required
queries	array van tekenreeksen	De zoekquery's.	No
zoekopdracht	tekenreeks (afgeschaft)	[AFGESCHAFT] De zoekquery.	Yes
Bronnen	matrix van OpenAI.WebSearchActionSearchSources	De bronnen die bij het zoeken zijn gebruikt.	No
type	enum	Het actietype. Mogelijke waarden: `search`	Yes

OpenAI.WebSearchActionSearchSources

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: `url`	Yes
URL	tekenreeks (URI)		Yes

OpenAI.WebSearchApproximateLocation

Webzoekopdracht bij benaderende locatie

De ongeveer locatie van de gebruiker.

Name	Typ	Description	Required	Verstek
city	tekenreeks of null		No
country	tekenreeks of null		No
region	tekenreeks of null		No
timezone	tekenreeks of null		No
type	enum	Het type locatie-benadering. Altijd `approximate`. Mogelijke waarden: `approximate`	Yes	benadering

OpenAI.WebSearchPreviewTool

Voorvertoning van webzoekopdrachten

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Typ	Description	Required	Verstek
search_content_types	array van OpenAI.SearchContentType		No
zoek_context_grootte	OpenAI.SearchContextSize		No
type	enum	Het type webzoekprogramma. Een van `web_search_preview` of `web_search_preview_2025_03_11`. Mogelijke waarden: `web_search_preview`	Yes	web_search_preview
gebruikerslocatie	OpenAI.ApproximateLocation of null		No

OpenAI.WebSearchTool

Zoeken op internet

Opmerking: web_search is nog niet beschikbaar via Azure OpenAI.

Name	Typ	Description	Required	Verstek
filters	OpenAI.WebSearchToolFilters of null		No
zoek_context_grootte	enum	Richtlijnen op hoog niveau voor de hoeveelheid contextvensterruimte die moet worden gebruikt voor de zoekopdracht. Een van `low`, `medium`of `high`. `medium` is de standaardwaarde. Mogelijke waarden: `low`, `mediumhigh`	No	Gemiddeld
type	enum	Het type webzoekprogramma. Een van `web_search` of `web_search_2025_08_26`. Mogelijke waarden: `web_search`	Yes	webzoekopdracht
gebruikerslocatie	OpenAI.WebSearchApproximateLocation of null		No

OpenAI.WebSearchToolFilters

Name	Typ	Description	Required	Verstek
allowed_domains	matrix van tekenreeks of null		No

Last updated on 2026-07-10