Azure OpenAI responses

API-version: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models-API:er

Servervariabler:

Variabel	Standardinställning	Description
endpoint		Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Authentication

ApiKeyAuth (API-nyckel)

Skicka din API-nyckel i api-key headern.

ApiKeyAuth_ (API-nyckel)

Skicka din API-nyckel i authorization headern.

OAuth2Auth (OAuth 2.0)

Flöde: implicit

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

Scope:

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

Säkerhetskrav

Endpoints accepterar någon av följande autentiseringsmetoder:

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

Skapa svar

POST {endpoint}/openai/v1/responses

Skapar ett modellsvar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
API-version	query	No	string Möjliga värden: `v1`, `preview`	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. `v1` om inget annat anges.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
bakgrund	booleskt värde eller null		No
context_management	array av OpenAI.ContextManagementParam eller null	Konfiguration av kontexthantering för denna förfrågan.	No
konversation	OpenAI.ConversationParam eller null		No
include	matris med OpenAI.IncludeEnum eller null		No
Input	OpenAI.InputParam	Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer: – Textindata och utdata - Bildingångar - Filindata - Konversationstillstånd - Funktionsanrop	No
instructions	sträng eller null		No
max_output_tokens	heltal eller null		No
max_verktygs_anrop	heltal eller null		No
metadata	OpenAI.Metadata eller null		No
model	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
parallella verktygsanrop	booleskt värde eller null		No
previous_response_id	sträng eller null		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
prompt_cache_retention	sträng eller null		No
reasoning	OpenAI.Reasoning eller null		No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
Lagra	booleskt värde eller null		No
stream	booleskt värde eller null		No
stream_options	OpenAI.ResponseStreamOptions eller null		No
Temperatur	tal eller null		No
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . De två kategorier av verktyg som du kan tillhandahålla modellen är: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel filsökning. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, så att modellen kan anropa din egen kod.	No
top_logprobs	heltal eller null		No
top_p	tal eller null		No
truncation	sträng eller null		No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object
text/event-stream	object

Name	Type	Description	Obligatoriskt	Standardinställning
bakgrund	booleskt värde eller null		No
klarad_vid	sträng eller null		No
content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
konversation	OpenAI.ConversationReference eller null		No
skapad_tid	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
fel	OpenAI.ResponseError eller null		Ja
id	string	Unik identifierare för det här svaret.	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails eller null		Ja
instructions	sträng eller matris med OpenAI.InputItem eller null		Ja
max_output_tokens	heltal eller null		No
max_verktygs_anrop	heltal eller null		No
metadata	OpenAI.Metadata eller null		No
model	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
object	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
output	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
output_text	sträng eller null		No
parallella verktygsanrop	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
previous_response_id	sträng eller null		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
prompt_cache_retention	sträng eller null		No
reasoning	OpenAI.Reasoning eller null		No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatur	tal eller null		No
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
top_logprobs	heltal eller null		No
top_p	tal eller null		No
truncation	sträng eller null		No
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Obligatoriskt
code	sträng eller null	Ja
inner_error		No
message	string	Ja
Param	sträng eller null	No
type	string	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Examples

Example

Skapa ett modellsvar

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

Hämta svar

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

Hämtar ett modellsvar med angivet ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
API-version	query	No	string Möjliga värden: `v1`, `preview`	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. `v1` om inget annat anges.
response_id	path	Ja	string
include[]	query	No	Array	Ytterligare fält som ska inkluderas i svaret. Mer information finns i include-parametern för skapande av svar ovan.
stream	query	No	boolean	Om värdet är true strömmas modellsvarsdata till klienten när de genereras med hjälp av serverutskickade händelser. Serialisering: explode: false
starting_after	query	No	heltal (int32)	Sekvensnumret för händelsen varefter strömning ska startas. Serialisering: explode: false
include_obfuscation	query	No	boolean	När det är sant aktiveras fördunkling av dataströmmar. Strömfördunkling lägger till slumpmässiga tecken i ett `obfuscation` fält på strömmande deltahändelser för att normalisera nyttelaststorlekar som en åtgärd mot vissa sidokanalattacker. Dessa fördunklingsfält ingår som standard, men lägger till en liten mängd omkostnader i dataströmmen. Du kan ange `include_obfuscation` falskt för att optimera bandbredden om du litar på nätverkslänkarna mellan ditt program och OpenAI-API:et. Serialisering: explode: false

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Description	Obligatoriskt	Standardinställning
bakgrund	booleskt värde eller null		No
klarad_vid	sträng eller null		No
content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
konversation	OpenAI.ConversationReference eller null		No
skapad_tid	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
fel	OpenAI.ResponseError eller null		Ja
id	string	Unik identifierare för det här svaret.	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails eller null		Ja
instructions	sträng eller matris med OpenAI.InputItem eller null		Ja
max_output_tokens	heltal eller null		No
max_verktygs_anrop	heltal eller null		No
metadata	OpenAI.Metadata eller null		No
model	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
object	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
output	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
output_text	sträng eller null		No
parallella verktygsanrop	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
previous_response_id	sträng eller null		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
prompt_cache_retention	sträng eller null		No
reasoning	OpenAI.Reasoning eller null		No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatur	tal eller null		No
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
top_logprobs	heltal eller null		No
top_p	tal eller null		No
truncation	sträng eller null		No
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Obligatoriskt
code	sträng eller null	Ja
inner_error		No
message	string	Ja
Param	sträng eller null	No
type	string	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Ta bort svar

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

Tar bort ett svar med ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
API-version	query	No	string Möjliga värden: `v1`, `preview`	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. `v1` om inget annat anges.
response_id	path	Ja	string

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Description	Obligatoriskt
borttagen	enum	Möjliga värden: `True`	Ja
id	string		Ja
object	enum	Möjliga värden: `response.deleted`	Ja

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Obligatoriskt
code	sträng eller null	Ja
inner_error		No
message	string	Ja
Param	sträng eller null	No
type	string	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Avbryt svar

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

Avbryter ett modellsvar med angivet ID. Endast svar som skapats med bakgrundsparametern inställd på true kan avbrytas.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
API-version	query	No	string Möjliga värden: `v1`, `preview`	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. `v1` om inget annat anges.
response_id	path	Ja	string

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Description	Obligatoriskt	Standardinställning
bakgrund	booleskt värde eller null		No
klarad_vid	sträng eller null		No
content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
konversation	OpenAI.ConversationReference eller null		No
skapad_tid	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
fel	OpenAI.ResponseError eller null		Ja
id	string	Unik identifierare för det här svaret.	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails eller null		Ja
instructions	sträng eller matris med OpenAI.InputItem eller null		Ja
max_output_tokens	heltal eller null		No
max_verktygs_anrop	heltal eller null		No
metadata	OpenAI.Metadata eller null		No
model	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
object	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
output	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
output_text	sträng eller null		No
parallella verktygsanrop	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
previous_response_id	sträng eller null		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
prompt_cache_retention	sträng eller null		No
reasoning	OpenAI.Reasoning eller null		No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatur	tal eller null		No
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
top_logprobs	heltal eller null		No
top_p	tal eller null		No
truncation	sträng eller null		No
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Obligatoriskt
code	sträng eller null	Ja
inner_error		No
message	string	Ja
Param	sträng eller null	No
type	string	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Lista indataobjekt

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

Returnerar en lista över indataobjekt för ett givet svar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	server	Ja	string	Ett stödd Azure AI Foundry Models API-endpoint, inklusive protokoll och värdnamn. Ett exempel: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
API-version	query	No	string Möjliga värden: `v1`, `preview`	Den explicita AZURE AI Foundry Models API-versionen som ska användas för den här begäran. `v1` om inget annat anges.
response_id	path	Ja	string
limit	query	No	heltal (int32)	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20. Serialisering: explode: false
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning. Serialisering: explode: false
Efter	query	No	string	En markör för användning i paginering. `after` är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan. Serialisering: explode: false
före	query	No	string	En markör för användning i paginering. `before` är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan. Serialisering: explode: false

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ResponseItemList

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	object

Name	Type	Obligatoriskt
code	sträng eller null	Ja
inner_error		No
message	string	Ja
Param	sträng eller null	No
type	string	No

Svarshuvuden:

Header	Type	Description
apim-request-id	string	Ett begärande-ID som används för felsökning.

Components

AzureAIFoundryModelsApiVersion

Property	Value
Type	string
Värden	`v1` `preview`

AzureContentFilterBlocklistResult

En samling true/false-filtreringsresultat för konfigurerade anpassade blocklistor.

Name	Type	Description	Obligatoriskt	Standardinställning
details	matris med objekt	Paren med enskilda blocklist-ID:er och om de resulterade i en filtreringsåtgärd.	No
Filtrerade	boolean	Ett värde som anger om någon av de detaljerade blocklisterna resulterade i en filtreringsåtgärd.	Ja

AzureContentFilterCompletionTextSpan

En representation av ett avslutningstextintervall som används av resultat från Azure OpenAI-innehållsfilter.

Name	Type	Description	Obligatoriskt	Standardinställning
completion_end_offset	heltal (int32)	Förskjutning av den första UTF32-kodpunkten som är undantagen från intervallet. Det här fältet är alltid lika med completion_start_offset för tomma intervall. Det här fältet är alltid större än completion_start_offset för intervall som inte är tomma.	Ja
completion_start_offset	heltal (int32)	Förskjutning av UTF32-kodpunkten som markerar början på intervallet.	Ja

AzureContentFilterCompletionTextSpanDetectionResult

Name	Type	Description	Obligatoriskt
details	matris med AzureContentFilterCompletionTextSpan	Detaljerad information om det identifierade slutförandetextintervallet.	Ja
Upptäckt	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
Filtrerade	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja

Azure-Innehållsfilter Anpassat Ämnesresultat

En samling filtreringsresultat av typen ja/nej för konfigurerade skräddarsydda ämnen.

Name	Type	Description	Obligatoriskt	Standardinställning
details	matris med objekt	Par av enskilda ämnes-ID:er och huruvida de upptäcks.	No
Filtrerade	boolean	Ett värde som anger om något av de detaljerade ämnena resulterade i en filtreringsåtgärd.	Ja

AzureContentFilterDetectionResult

Ett resultatobjekt med etiketterat innehållsfilter som anger om innehållet har identifierats och om innehållet har filtrerats.

Name	Type	Description	Obligatoriskt	Standardinställning
Upptäckt	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
Filtrerade	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja

AzureContentFilterForResponsesAPI

Name	Type	Description	Obligatoriskt
Blockerade	boolean	Ange om svaret är blockerat.	Ja
content_filter_offsets	AzureContentFilterResultOffsets		Ja
content_filter_results	AzureContentFilterResultsForResponsesAPI		Ja
└– anpassade_blocklistor	AzureContentFilterBlocklistResult	En samling binära filtreringsresultat för konfigurerade anpassade blocklistor.	No
└– custom_topics	AzureContentFilterCustomTopicResult	En samling binära filtreringsresultat för konfigurerade anpassade ämnen.	No
└– fel	object	Om det finns information om ett fel som hindrade innehållsfiltrering från att slutföra utvärderingen.	No
└– kod	heltal (int32)	En distinkt, maskinläsbar kod som är associerad med felet.	Ja
└– meddelande	string	Ett läsbart meddelande som är associerat med felet.	Ja
└─ hatar	AzureContentFilterSeverityResult	En innehållsfilterkategori som kan referera till allt innehåll som attackerar eller använder nedsättande eller diskriminerande språk med referens till en person eller identitetsgrupp baserat på vissa differentieringsattribut för dessa grupper inklusive men inte begränsat till ras, etnicitet, nationalitet, könsidentitet och könsuttryck, sexuell läggning, religion, invandringsstatus, förmågasstatus, personligt utseende och kroppsstorlek.	No
└– indirekt_attack	AzureContentFilterDetectionResult	Ett identifieringsresultat som beskriver attacker på system som drivs av generativa AI-modeller som kan inträffa varje gång ett program bearbetar information som inte har skapats direkt av programmets utvecklare eller användaren.	No
└– jailbreak	AzureContentFilterDetectionResult	Ett identifieringsresultat som beskriver användarinmatningsattacker, där skadliga användare avsiktligt utnyttjar systemsårbarheter för att framkalla obehörigt beteende från LLM. Detta kan leda till olämpligt innehåll generering eller brott mot systeminförda begränsningar.	Ja
└– personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Ett identifieringsresultat som beskriver matchningar mot personlig identifierbar information med konfigurerbara underkategorier.	No
└— svordomar	AzureContentFilterDetectionResult	Ett identifieringsresultat som identifierar huruvida grovt, vulgärt eller på annat sätt invändningsspråk finns i Innehåll.	No
└– protected_material_code	object	Ett identifieringsresultat som beskriver en matchning mot licensierad kod eller annat skyddat källmaterial.	No
└— citat	object	Om det är tillgängligt beskriver källhänvisningsinformationen den associerade licensen och dess plats.	No
└– URL	Sträng (uri)	URL:en som är associerad med licensen.	No
└─ licens	string	Namnet eller ID för den licens som är associerad med upptäckten.	No
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
└– protected_material_text	AzureContentFilterDetectionResult	Ett identifieringsresultat som beskriver en matchning mot text som skyddas med upphovsrätt eller annan status.	No
└─ självskada	AzureContentFilterSeverityResult	En kategori för innehållsfilter som beskriver språk relaterade till fysiska åtgärder som syftar till att avsiktligt skada, skada, skada ens kropp eller döda sig själv.	No
└— sexuellt	AzureContentFilterSeverityResult	En innehållsfilterkategori för språk som rör anatomiska organ och könsorgan, romantiska relationer, handlingar porträtteras i erotiska eller tillgivna termer, graviditet, fysiska sexuella handlingar, inklusive de som framställs som en våld mot ens vilja, prostitution, pornografi och övergrepp.	No
└– task_adherence	AzureContentFilterDetectionResult	Ett identifieringsresultat som anger om körningsflödet fortfarande håller planen.	Ja
└– ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└– våld	AzureContentFilterSeverityResult	En innehållsfilterkategori för språk som rör fysiska åtgärder som är avsedda att skada, skada, skada eller döda någon eller något; beskriver vapen, vapen och relaterade enheter, till exempel tillverkning, associationer, lagstiftning och så vidare.	No
source_type	string	Namnet på meddelandets källtyp.	Ja
tool_call_id	string	ID:t för verktygsanropet kopplat till detta innehållsfilterresultat, om tillämpligt.	No

AzureInnehållsfilterPersonligtIdentifierbarInformationResultat

Resultat av ett innehållsfilter för att identifiera personligt identifierbar information som inkluderar tillägg för potentiell skada.

Name	Type	Description	Obligatoriskt
Upptäckt	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
Filtrerade	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
redacted_text	string	Den redigerade texten med PII-information borttagen eller maskerad.	No
underkategorier	matris med AzurePiiSubCategoryResult	Detaljerade resultat för enskilda PIIHarmUnderkategori(er).	No

AzureContentFilterResultOffsets

Name	Type	Obligatoriskt
check_offset	heltal (int32)	Ja
end_offset	heltal (int32)	Ja
start_offset	heltal (int32)	Ja

AzureContentFilterResultsForResponsesAPI

Name	Type	Description	Obligatoriskt
custom_blocklists	AzureContentFilterBlocklistResult	En samling true/false-filtreringsresultat för konfigurerade anpassade blocklistor.	No
└— detaljer	matris med objekt	Paren med enskilda blocklist-ID:er och om de resulterade i en filtreringsåtgärd.	No
└– filtrerad	boolean	Ett värde som anger om blocklistan skapade en filtreringsåtgärd.	Ja
└– id	string	ID:t för den anpassade blocklistan utvärderas.	Ja
└– filtrerad	boolean	Ett värde som anger om någon av de detaljerade blocklisterna resulterade i en filtreringsåtgärd.	Ja
anpassade_ämnen	AzureContentFilterCustomTopicResult	En samling filtreringsresultat av typen ja/nej för konfigurerade skräddarsydda ämnen.	No
└— detaljer	matris med objekt	Par av enskilda ämnes-ID:er och huruvida de upptäcks.	No
└— har identifierats	boolean	Ett värde som anger om ämnet har identifierats.	Ja
└– id	string	ID:t för det anpassade ämnet utvärderas.	Ja
└– filtrerad	boolean	Ett värde som anger om något av de detaljerade ämnena resulterade i en filtreringsåtgärd.	Ja
fel	object	Om det finns information om ett fel som hindrade innehållsfiltrering från att slutföra utvärderingen.	No
└– kod	heltal (int32)	En distinkt, maskinläsbar kod som är associerad med felet.	Ja
└– meddelande	string	Ett läsbart meddelande som är associerat med felet.	Ja
Hatar	AzureContentFilterSeverityResult	Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är. Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.	No
└– filtrerad	boolean	Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd.	Ja
└– allvarlighetsgrad	enum	Innehållets etiketterade allvarlighetsgrad. Möjliga värden: `safe`, `low`, `medium`, `high`	Ja
indirect_attack	AzureContentFilterDetectionResult	Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats filtrerad.	No
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
Jailbreak	AzureContentFilterDetectionResult	Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats filtrerad.	Ja
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Resultat av ett innehållsfilter för att identifiera personligt identifierbar information som inkluderar tillägg för potentiell skada.	No
└– redacted_text	string	Den redigerade texten med PII-information borttagen eller maskerad.	No
└– underkategorier	matris med AzurePiiSubCategoryResult	Detaljerade resultat för enskilda PIIHarmUnderkategori(er).	No
Svordomar	AzureContentFilterDetectionResult	Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats filtrerad.	No
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
protected_material_code	object	Ett identifieringsresultat som beskriver en matchning mot licensierad kod eller annat skyddat källmaterial.	No
└— citat	object	Om det är tillgängligt beskriver källhänvisningsinformationen den associerade licensen och dess plats.	No
└– URL	Sträng (uri)	URL:en som är associerad med licensen.	No
└─ licens	string	Namnet eller ID för den licens som är associerad med upptäckten.	No
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
protected_material_text	AzureContentFilterDetectionResult	Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats filtrerad.	No
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
self_harm	AzureContentFilterSeverityResult	Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är. Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.	No
└– filtrerad	boolean	Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd.	Ja
└– allvarlighetsgrad	enum	Innehållets etiketterade allvarlighetsgrad. Möjliga värden: `safe`, `low`, `medium`, `high`	Ja
Sexuella	AzureContentFilterSeverityResult	Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är. Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.	No
└– filtrerad	boolean	Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd.	Ja
└– allvarlighetsgrad	enum	Innehållets etiketterade allvarlighetsgrad. Möjliga värden: `safe`, `low`, `medium`, `high`	Ja
task_adherence	AzureContentFilterDetectionResult	Ett etikettinnehållsfilterresultatobjekt som anger om innehållet har upptäckts och om innehållet har identifierats filtrerad.	Ja
└— har identifierats	boolean	Om den etiketterade innehållskategorin identifierades i innehållet.	Ja
└– filtrerad	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd.	Ja
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
Våld	AzureContentFilterSeverityResult	Ett etiketterat resultatobjekt för innehållsfilter som anger om innehållet har filtrerats och vad den kvalitativa bedömningen är. Innehållets allvarlighetsnivå jämfördes med innehållsfilterkonfigurationen för kategorin.	No
└– filtrerad	boolean	Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd.	Ja
└– allvarlighetsgrad	enum	Innehållets etiketterade allvarlighetsgrad. Möjliga värden: `safe`, `low`, `medium`, `high`	Ja

AzureContentFilterSeverityResult

Ett resultatobjekt med etiketterat innehållsfilter som anger om innehållet har filtrerats och vilken kvalitativ allvarlighetsgrad innehållet var, enligt utvärderingen mot innehållsfilterkonfigurationen för kategorin.

Name	Type	Description	Obligatoriskt	Standardinställning
Filtrerade	boolean	Om innehållets allvarlighetsgrad resulterade i en innehållsfiltreringsåtgärd.	Ja
severity	enum	Innehållets etiketterade allvarlighetsgrad. Möjliga värden: `safe`, `low`, `medium`, `high`	Ja

AzurePiiSubCategoryResult

Detaljerad information om resultat för enskilda PIIHarmSubCategory(s).

Name	Type	Description	Obligatoriskt
Upptäckt	boolean	Om underkategorin för märkt innehåll har identifierats i innehållet.	Ja
Filtrerade	boolean	Om innehållsidentifieringen resulterade i en innehållsfiltreringsåtgärd för den här underkategorin.	Ja
Redacted	boolean	Om innehållet redigerades för den här underkategorin.	Ja
delkategori	string	PIIHarmSubCategory som utvärderades.	Ja

AzureToolApprovalRequest

Azure Tool approval request

En godkännandebegäran för Azure-verktyget i svarsutdatan.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
call_id	string	Verktygets ID kräver godkännande.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
etikett	string	Verktygets etikett (t.ex. 'remote_functions').	Ja
name	string	Namnet på verktygsfunktionen (t.ex. 'output_binding').	Ja
type	enum	Typ av objekt. Alltid `tool_approval_request`. Möjliga värden: `tool_approval_request`	Ja

AzureToolApprovalResponse

Azure tool approval response

Ett godkännandesvar för Azure-verktyget i begäran om inmatning.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
type	enum	Typ av objekt. Alltid `tool_approval_response`. Möjliga värden: `tool_approval_response`	Ja

OpenAI.Annotation

En anteckning som gäller för ett intervall med utdatatext.

Diskriminator för OpenAI.Annotation

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.AnnotationType		Ja

OpenAI.AnnotationType

Property	Value
Type	string
Värden	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Type	string
Värden	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Tillämpa patchanropets utgångsstatus

Utfallsvärden som rapporterats för apply_patch verktygsanropsutdata.

Property	Value
Type	string
Värden	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Tillämpa patchanropsstatus

Statusvärden som rapporterats för apply_patch-verktygsanrop.

Property	Value
Type	string
Värden	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Applicera patch create file-operationen

Instruktioner som beskriver hur du skapar en fil via apply_patch-verktyget.

Name	Type	Description	Obligatoriskt	Standardinställning
Diff	string	Diff som ska tillämpas.	Ja
path	string	Sökväg till filen som ska skapas.	Ja
type	enum	Skapa en ny fil med det angivna diffet. Möjliga värden: `create_file`	Ja	create_file

OpenAI.ApplyPatchCreateFileOperationParam

Applicera patch create file-operationen

Instruktioner för att skapa en ny fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
Diff	string	Enhetligt diffinnehåll som ska tillämpas när filen skapas. Begränsningar: maxLength: 10485760	Ja
path	string	Sökväg till filen som ska skapas i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
type	enum	Åtgärdstypen. Alltid `create_file`. Möjliga värden: `create_file`	Ja	create_file

OpenAI.ApplyPatchDeleteFileOperation

Tillämpa patch delete-filoperationen

Instruktion som beskriver hur du tar bort en fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
path	string	Sökväg till filen som ska tas bort.	Ja
type	enum	Ta bort den angivna filen. Möjliga värden: `delete_file`	Ja	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Tillämpa patch delete-filoperationen

Instruktioner för att ta bort en befintlig fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
path	string	Sökväg till filen som ska tas bort i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
type	enum	Åtgärdstypen. Alltid `delete_file`. Möjliga värden: `delete_file`	Ja	delete_file

OpenAI.ApplyPatchFileOperation

Applicera patchoperationen

En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.

Diskriminerande för OpenAI.ApplyPatchFileOperation

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ApplyPatchFileOperationType		Ja

OpenAI.ApplyPatchFileOperationType

Property	Value
Type	string
Värden	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Applicera patchoperationen

En av de create_file, delete_file eller update_file åtgärder som tillhandahålls till apply_patch-verktyget.

Diskriminerande för OpenAI.ApplyPatchOperationParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ApplyPatchOperationParamType		Ja

OpenAI.ApplyPatchOperationParamType

Property	Value
Type	string
Värden	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Applicera patch-verktyget

Tillåter att assistenten skapar, tar bort eller uppdaterar filer med hjälp av enhetliga diffs.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Verktygets typ. Alltid `apply_patch`. Möjliga värden: `apply_patch`	Ja	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Applicera patchuppdateringsfil-operationen

Instruktioner som beskriver hur du uppdaterar en fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
Diff	string	Diff som ska tillämpas.	Ja
path	string	Sökväg till filen som ska uppdateras.	Ja
type	enum	Uppdatera en befintlig fil med det angivna diffet. Möjliga värden: `update_file`	Ja	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Applicera patchuppdateringsfil-operationen

Instruktioner för att uppdatera en befintlig fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
Diff	string	Enhetligt diffinnehåll som ska tillämpas på den befintliga filen. Begränsningar: maxLength: 10485760	Ja
path	string	Sökväg till filen som ska uppdateras i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
type	enum	Åtgärdstypen. Alltid `update_file`. Möjliga värden: `update_file`	Ja	update_file

OpenAI.UppskattadPlats

Name	Type	Description	Obligatoriskt	Standardinställning
Staden	sträng eller null		No
land	sträng eller null		No
region	sträng eller null		No
timezone	sträng eller null		No
type	enum	Typ av platsnärmning. Alltid `approximate`. Möjliga värden: `approximate`	Ja	Ungefärligt

OpenAI.AutoCodeInterpreterToolParam

Parametrar för automatiskt kodtolkverktyg

Konfiguration för en kodtolkarcontainer. Du kan också ange ID:t för de filer som koden ska köras på.

Name	Type	Description	Obligatoriskt	Standardinställning
fil_identiteter	strängmatris	En valfri lista över uppladdade filer som ska vara tillgängliga för din kod. Begränsningar: maxFöremål: 50	No
minnesgräns	OpenAI.ContainerMemoryLimit eller null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Nätverksåtkomstpolicy för containern.	No
type	enum	Alltid `auto`. Möjliga värden: `auto`	Ja	bil

OpenAI.ClickButtonType

Property	Value
Type	string
Värden	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

En klickåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
knapp	OpenAI.ClickButtonType		Ja
keys	matris med sträng eller null		No
type	enum	Anger händelsetypen. För en klickåtgärd är den här egenskapen alltid `click`. Möjliga värden: `click`	Ja	klicka
x	integer	X-koordinaten där klicket inträffade.	Ja
y	integer	y-koordinaten där klicket inträffade.	Ja

OpenAI.CodeInterpreterOutputImage

Kodtolkarens utdata bild

Bildutdata från kodtolkaren.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av utdata. Alltid `image`. Möjliga värden: `image`	Ja	bild
url	Sträng (uri)	URL:en för bildens utdata från kodtolkaren.	Ja

OpenAI.CodeInterpreterOutputLogs

Kodtolkarens utdata loggar

Loggutdata från kodtolkaren.

Name	Type	Description	Obligatoriskt	Standardinställning
logs	string	Loggutdata från kodtolkaren.	Ja
type	enum	Typ av utdata. Alltid `logs`. Möjliga värden: `logs`	Ja	logs

OpenAI.CodeInterpreterTool

Kodtolkare

Ett verktyg som kör Python-kod för att generera ett svar på en fråga.

Name	Type	Description	Obligatoriskt	Standardinställning
container	sträng eller OpenAI.AutoCodeInterpreterToolParam	Kodtolkarcontainern. Kan vara ett container-ID eller ett objekt som anger uppladdade fil-ID:er som ska vara tillgängliga för din kod, tillsammans med en valfri `memory_limit` inställning.	Ja
type	enum	Typ av kodtolkarverktyg. Alltid `code_interpreter`. Möjliga värden: `code_interpreter`	Ja

OpenAI.ComparisonFilter (jämförelsefilter)

Jämförelsefilter

Ett filter som används för att jämföra en angiven attributnyckel med ett angivet värde med hjälp av en definierad jämförelseåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
key	string	Nyckeln som ska jämföras med värdet.	Ja
type	enum	Anger jämförelseoperatorn: , , , , `eqne`, , `gt`, `gte`, . `ltlteinnin` - `eq`: Motsvarar - `ne`: inte lika med - `gt`: större än - `gte`: större än eller lika med - `lt`: mindre än - `lte`: mindre än eller lika med - `in`:I - `nin`: inte i Möjliga värden: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, , , `innin`	Ja	ekv
value	sträng eller nummer eller booleskt eller array av sträng eller tal	Det värde som ska jämföras med attributnyckeln. stöder sträng-, nummer- eller booleska typer.	Ja

OpenAI.CompoundFilter

Sammansatt filter

Kombinera flera filter med and eller or.

Name	Type	Description	Obligatoriskt	Standardinställning
filters	matris med OpenAI.ComparisonFilter eller objekt	Matris med filter som ska kombineras. Objekt kan vara `ComparisonFilter` eller `CompoundFilter`.	Ja
type	enum	Typ av åtgärd: `and` eller `or`. Möjliga värden: `and`, `or`	Ja

OpenAI.ComputerAction

Diskriminerande för OpenAI.ComputerAction

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ComputerActionType		Ja

OpenAI.ComputerActionList

Datorhandlingslista

Tillplattade batchade handlingar för computer_use. Varje handling innehåller en type diskriminator och handlingsspecifika fält.

Array av: OpenAI.ComputerAction

OpenAI.ComputerActionType

Property	Value
Type	string
Värden	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

En väntande säkerhetskontroll för datorsamtalet.

Name	Type	Description	Obligatoriskt
code	sträng eller null		No
id	string	ID för den väntande säkerhetskontrollen.	Ja
message	sträng eller null		No

OpenAI.ComputerEnvironment

Property	Value
Type	string
Värden	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Datorskärmdump

En skärmbild av en dator.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng eller null		Ja
image_url	sträng eller null		Ja
type	enum	Anger händelsetypen. För en datorskärm är den här egenskapen alltid inställd på `computer_screenshot`. Möjliga värden: `computer_screenshot`	Ja	computer_screenshot

OpenAI.ComputerScreenshotImage

En skärmbild av datorn som används med datoranvändningsverktyget.

Name	Type	Description	Obligatoriskt	Standardinställning
file_id	string	Identifieraren för en uppladdad fil som innehåller skärmbilden.	No
image_url	Sträng (uri)	URL:en för skärmbilden.	No
type	enum	Anger händelsetypen. För en datorskärm är den här egenskapen alltid inställd på `computer_screenshot`. Möjliga värden: `computer_screenshot`	Ja	computer_screenshot

OpenAI.ComputerTool

Dator

Ett verktyg som styr en virtuell dator.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typen av datorverktyg. Alltid `computer`. Möjliga värden: `computer`	Ja	Dator

OpenAI.Datoranvändningsförhandsgranskningsverktyg

Datoranvändningsförhandsgranskning

Ett verktyg som styr en virtuell dator.

Name	Type	Description	Obligatoriskt	Standardinställning
skärmhöjd	integer	Höjden på datorskärmen.	Ja
skärmbredd	integer	Datorns skärmbredd.	Ja
environment	OpenAI.ComputerEnvironment		Ja
type	enum	Typ av datoranvändningsverktyg. Alltid `computer_use_preview`. Möjliga värden: `computer_use_preview`	Ja	computer_use_preview

OpenAI.ContainerAutoParam

Name	Type	Description	Obligatoriskt	Standardinställning
fil_identiteter	strängmatris	En valfri lista över uppladdade filer som ska vara tillgängliga för din kod. Begränsningar: maxFöremål: 50	No
minnesgräns	OpenAI.ContainerMemoryLimit eller null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Nätverksåtkomstpolicy för containern.	No
Färdigheter	array av OpenAI.ContainerSkill	En valfri lista över färdigheter refererade med id eller inline-data. Begränsningar: maxFöremål: 200	No
type	enum	Skapar automatiskt en container för denna förfrågan Möjliga värden: `container_auto`	Ja	container_auto

OpenAI.ContainerFileCitationBody

Källhänvisning till containerfil

En källhänvisning för en containerfil som används för att generera ett modellsvar.

Name	Type	Description	Obligatoriskt	Standardinställning
container_id	string	ID:t för containerfilen.	Ja
end_index	integer	Indexet för det sista tecknet i containerfilens källhänvisning i meddelandet.	Ja
file_id	string	ID:t för filen.	Ja
filename	string	Filnamnet för containerfilen som citeras.	Ja
start_index	integer	Indexet för det första tecknet i containerfilens källhänvisning i meddelandet.	Ja
type	enum	Typ av källhänvisning för containerfilen. Alltid `container_file_citation`. Möjliga värden: `container_file_citation`	Ja	container_file_citation

OpenAI.ContainerMemoryLimit

Property	Value
Type	string
Värden	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Type	Description	Obligatoriskt	Standardinställning
allowed_domains	strängmatris	En lista över tillåtna domäner när typen är `allowlist`. Begränsningar: minItems: 1	Ja
type	enum	Tillåt utgående nätverksåtkomst endast till angivna domäner. Alltid `allowlist`. Möjliga värden: `allowlist`	Ja	Tillåtningslista

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Inaktivera utgående nätverksåtkomst. Alltid `disabled`. Möjliga värden: `disabled`	Ja	funktionshindrad

OpenAI.ContainerNetworkPolicyParam

Nätverksåtkomstpolicy för containern.

Discriminator för OpenAI.ContainerNetworkPolicyParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ContainerNetworkPolicyParamType		Ja

OpenAI.ContainerNetworkPolicyParamType

Property	Value
Type	string
Värden	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

Containerreferens

Representerar en container skapad med /v1/containers.

Name	Type	Description	Obligatoriskt	Standardinställning
container_id	string		Ja
type	enum	Typen av miljö. Alltid `container_reference`. Möjliga värden: `container_reference`	Ja	container_reference

OpenAI.ContainerSkill

Discriminator för OpenAI.ContainerSkill

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ContainerSkillType		Ja

OpenAI.ContainerSkillType

Property	Value
Type	string
Värden	`skill_reference` `inline`

OpenAI.ContextManagementParam

Name	Type	Description	Obligatoriskt	Standardinställning
compact_threshold	heltal eller null		No
type	string	Typen av kontexthanteringspost. För närvarande stöds endast 'kompaktering'.	Ja

OpenAI.ConversationParam

Konversationen som det här svaret tillhör. Objekt från den här konversationen förbereds för input_items den här svarsbegäran. Indataobjekt och utdataobjekt från det här svaret läggs automatiskt till i den här konversationen när det här svaret har slutförts.

Den här komponenten kan vara något av följande:

sträng
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Konversationsobjekt

Konversationen som det här svaret tillhör.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	Konversationens unika ID.	Ja

OpenAI.ConversationReference

Konversation

Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	Det unika ID:t för konversationen som det här svaret var associerat med.	Ja

OpenAI.CoordParam

Koordinat

Ett x/y-koordinatpar, t.ex. { x: 100, y: 200 }.

Name	Type	Description	Obligatoriskt	Standardinställning
x	integer	X-koordinaten.	Ja
y	integer	Y-koordinaten.	Ja

OpenAI.CreateResponse

Name	Type	Description	Obligatoriskt
bakgrund	booleskt värde eller null		No
context_management	array av OpenAI.ContextManagementParam eller null	Konfiguration av kontexthantering för denna förfrågan.	No
konversation	OpenAI.ConversationParam eller null		No
include	matris med OpenAI.IncludeEnum eller null		No
Input	OpenAI.InputParam	Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer: – Textindata och utdata - Bildingångar - Filindata - Konversationstillstånd - Funktionsanrop	No
instructions	sträng eller null		No
max_output_tokens	heltal eller null		No
max_verktygs_anrop	heltal eller null		No
metadata	OpenAI.Metadata eller null		No
model	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
parallella verktygsanrop	booleskt värde eller null		No
previous_response_id	sträng eller null		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
prompt_cache_retention	sträng eller null		No
reasoning	OpenAI.Reasoning eller null		No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
Lagra	booleskt värde eller null		No
stream	booleskt värde eller null		No
stream_options	OpenAI.ResponseStreamOptions eller null		No
Temperatur	tal eller null		No
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . De två kategorier av verktyg som du kan tillhandahålla modellen är: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel filsökning. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, så att modellen kan anropa din egen kod.	No
top_logprobs	heltal eller null		No
top_p	tal eller null		No
truncation	sträng eller null		No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No

OpenAI.CustomGrammarFormatParam

Grammatikformat

En grammatik som definieras av användaren.

Name	Type	Description	Obligatoriskt	Standardinställning
definitionen	string	Grammatikdefinitionen.	Ja
Syntax	OpenAI.GrammarSyntax1		Ja
type	enum	Grammatikformat. Alltid `grammar`. Möjliga värden: `grammar`	Ja	Grammatik

OpenAI.CustomTextFormatParam

Textformat

Obehindrat friformatstext.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Obehindrat textformat. Alltid `text`. Möjliga värden: `text`	Ja	text

OpenAI.CustomToolParam

Specialverktyg

Ett anpassat verktyg som bearbetar indata med ett angivet format. Lär dig mer om anpassade verktyg

Name	Type	Description	Obligatoriskt	Standardinställning
defer_loading	boolean	Om detta verktyg bör skjutas upp och upptäckas via verktygssökning.	No
beskrivning	string	Valfri beskrivning av det anpassade verktyget som används för att ge mer kontext.	No
format	OpenAI.CustomToolParamFormat	Indataformatet för det anpassade verktyget. Standardvärdet är obehindrat text.	No
└– typ	OpenAI.CustomToolParamFormatType		Ja
name	string	Namnet på det anpassade verktyget som används för att identifiera det i verktygsanrop.	Ja
type	enum	Typ av anpassat verktyg. Alltid `custom`. Möjliga värden: `custom`	Ja	custom

OpenAI.CustomToolParamFormat

Indataformatet för det anpassade verktyget. Standardvärdet är obehindrat text.

Diskriminerande för OpenAI.CustomToolParamFormat

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.CustomToolParamFormatType		Ja

OpenAI.CustomToolParamFormatType

Property	Value
Type	string
Värden	`text` `grammar`

OpenAI.DetailEnum

Property	Value
Type	string
Värden	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

En dubbelklicksåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
keys	matris med sträng eller null		Ja
type	enum	Anger händelsetypen. För en dubbelklicksåtgärd är den här egenskapen alltid inställd på `double_click`. Möjliga värden: `double_click`	Ja	double_click
x	integer	X-koordinaten där dubbelklicket inträffade.	Ja
y	integer	Den y-koordinaten där dubbelklicket inträffade.	Ja

OpenAI.DragParam

Drag

En dragåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
keys	matris med sträng eller null		No
path	array av OpenAI.CoordParam	En matris med koordinater som representerar sökvägen för dragåtgärden. Koordinater visas som en matris med objekt, t.ex. `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Ja
type	enum	Anger händelsetypen. För en dragåtgärd är den här egenskapen alltid inställd på `drag`. Möjliga värden: `drag`	Ja	Drag

OpenAI.EasyInputMessage

Inmatningsmeddelande

Ett meddelande som matas in till modellen med en roll som anger instruktionen efter hierarkin. Instruktioner som ges med developer rollen eller system har företräde framför instruktioner som ges med user rollen. Meddelanden med assistant rollen antas ha genererats av modellen i tidigare interaktioner.

Name	Type	Description	Obligatoriskt
innehåll	string eller OpenAI.InputMessageContentList	Text, bild eller ljudinmatning till modellen, som används för att generera ett svar. Kan också innehålla tidigare assistentsvar.	Ja
phase	OpenAI.MessagePhase eller null		No
role	enum	Rollen för meddelandets inmatning. En av `user`, `assistant`, `system`eller `developer`. Möjliga värden: `user`, `assistant`, `system`, `developer`	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av meddelandeindata. Alltid `message`. Möjliga värden: `message`	Ja

OpenAI.EmptyModelParam

Typ: objekt

OpenAI.FileCitationBody

Arkivreferens

En källhänvisning till en fil.

Name	Type	Description	Obligatoriskt	Standardinställning
file_id	string	ID:t för filen.	Ja
filename	string	Filnamnet för den citerade filen.	Ja
index	integer	Indexet för filen i listan över filer.	Ja
type	enum	Filreferenstyp. Alltid `file_citation`. Möjliga värden: `file_citation`	Ja	file_citation

OpenAI.FileInputDetail

Property	Value
Type	string
Värden	`low` `high`

OpenAI.FilePath

Filsökväg

En sökväg till en fil.

Name	Type	Description	Obligatoriskt
file_id	string	ID:t för filen.	Ja
index	integer	Indexet för filen i listan över filer.	Ja
type	enum	Typ av filsökväg. Alltid `file_path`. Möjliga värden: `file_path`	Ja

OpenAI.FileSearchTool

Filsökning

Ett verktyg som söker efter relevant innehåll från uppladdade filer.

Name	Type	Description	Obligatoriskt	Standardinställning
filters	OpenAI.Filters eller null		No
maximalt antal resultat	integer	Det maximala antalet resultat som ska returneras. Det här talet ska vara mellan 1 och 50 inklusive.	No
rankingalternativ	OpenAI.RankingOptions		No
└– hybrid_search	OpenAI.HybridSearchOptions	Vikter som styr hur reciprocal rank fusion balanserar semantiska inbäddningsmatchningar jämfört med glesa nyckelordsmatchningar när hybridsökning är aktiverat.	No
└— ranker	OpenAI.RankerVersionType	Rangordningen som ska användas för filsökningen.	No
└– poängtröskel	number	Tröskelvärdet för poäng för filsökningen, ett tal mellan 0 och 1. Tal närmare 1 försöker returnera endast de mest relevanta resultaten, men kan returnera färre resultat.	No
type	enum	Typ av filsökningsverktyg. Alltid `file_search`. Möjliga värden: `file_search`	Ja	file_search
vector_store_ids	strängmatris	ID:t för vektorarkiven som ska sökas.	Ja

OpenAI.FileSearchToolCallResults

Name	Type	Obligatoriskt
attributes	OpenAI.VectorStoreFileAttributes eller null	No
file_id	string	No
filename	string	No
Poäng	nummer (float)	No
text	string	No

OpenAI.Filters

Typ: OpenAI.ComparisonFilter eller OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Diskriminerande för OpenAI.FunctionAndCustomToolCallOutput

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionAndCustomToolCallOutputType		Ja

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Inmatningsfil

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.FileInputDetail		No
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng eller null		No
file_url	Sträng (uri)	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Inmatningsbild

En bildinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng eller null		No
image_url	sträng eller null		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Indatatext

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Property	Value
Type	string
Värden	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Shell-ledningens åtgärder

Kör ett gränssnittskommando.

Name	Type	Obligatoriskt
commands	strängmatris	Ja
max_output_length	heltal eller null	Ja
timeout_ms (timeout i millisekunder)	heltal eller null	Ja

OpenAI.FunctionShellActionParam

Granatverkan

Kommandon och begränsningar som beskriver hur du kör gränssnittets verktygsanrop.

Name	Type	Description	Obligatoriskt
commands	strängmatris	Beställda gränssnittskommandon för körningsmiljön som ska köras.	Ja
max_output_length	heltal eller null		No
timeout_ms (timeout i millisekunder)	heltal eller null		No

OpenAI.FunctionShellCallEnvironment

Discriminator för OpenAI.FunctionShellCallEnvironment

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellCallEnvironmentType		Ja

OpenAI.FunctionShellCallEnvironmentType

Property	Value
Type	string
Värden	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

Miljön där skalkommandona kan utföras.

Discriminator för OpenAI.FunctionShellCallItemParamEnvironment

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellCallItemParamEnvironmentType		Ja

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Type	Description	Obligatoriskt	Standardinställning
container_id	string	ID:t för den refererade containern.	Ja
type	enum	Refererar till en container skapad med /v1/containers-endpointen Möjliga värden: `container_reference`	Ja	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Name	Type	Description	Obligatoriskt	Standardinställning
Färdigheter	array av OpenAI.LocalSkillParam	En valfri lista över färdigheter. Begränsningar: maxFöremål: 200	No
type	enum	Använd en lokal datormiljö. Möjliga värden: `local`	Ja	lokal

OpenAI.FunctionShellCallItemParamEnvironmentType

Property	Value
Type	string
Värden	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Status för skalanrop

Statusvärden som rapporterats för gränssnittsverktygsanrop.

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Skalanropsutdata

Innehållet i ett gränssnittsverktyg anropar utdata som har genererats.

Name	Type	Description	Obligatoriskt
skapad av	string	Identifieraren för aktören som skapade objektet.	No
utfall	OpenAI.FunctionShellCallOutputOutcome	Representerar antingen ett slutresultat (med en slutkod) eller ett timeout-utfall för ett utdatasegment för shell-anrop.	Ja
└– typ	OpenAI.FunctionShellCallOutputOutcomeType		Ja
Stderr	string	Standardfelutdata som hämtades.	Ja
stdout	string	Standardutdata som hämtades.	Ja

OpenAI.FunctionShellCallOutputContentParam

Shell-utdata innehåll

Insamlad stdout och stderr för en del av ett gränssnittsverktyg anropar utdata.

Name	Type	Description	Obligatoriskt
utfall	OpenAI.FunctionShellCallOutputOutcomeParam	Utfallet för avslut eller timeout som är associerat med det här gränssnittsanropet.	Ja
└– typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja
Stderr	string	Insamlade stderr-utdata för shell-anropet. Begränsningar: maxLength: 10485760	Ja
stdout	string	Insamlade stdout-utdata för shell-anropet. Begränsningar: maxLength: 10485760	Ja

OpenAI.FunctionShellCallOutputExitOutcome

Utgångsresultat för skalanrop

Anger att gränssnittskommandona har slutförts och returnerat en slutkod.

Name	Type	Description	Obligatoriskt	Standardinställning
exit_code	integer	Avsluta kod från shell-processen.	Ja
type	enum	Utfallstypen. Alltid `exit`. Möjliga värden: `exit`	Ja	exit

OpenAI.FunctionShellCallOutputExitOutcomeParam

Utgångsresultat för skalanrop

Anger att gränssnittskommandona har slutförts och returnerat en slutkod.

Name	Type	Description	Obligatoriskt	Standardinställning
exit_code	integer	Utgångskoden som returneras av shell-processen.	Ja
type	enum	Utfallstypen. Alltid `exit`. Möjliga värden: `exit`	Ja	exit

OpenAI.FunctionShellCallOutputOutcome

Skalkallsresultat

Representerar antingen ett slutresultat (med en slutkod) eller ett timeout-utfall för ett utdatasegment för shell-anrop.

Diskriminerande för OpenAI.FunctionShellCallOutputOutcome

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellCallOutputOutcomeType		Ja

OpenAI.FunctionShellCallOutputOutcomeParam

Skalkallsresultat

Utfallet för avslut eller timeout som är associerat med det här gränssnittsanropet.

Diskriminerande för OpenAI.FunctionShellCallOutputOutcomeParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Value
Type	string
Värden	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Type	string
Värden	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Utgång av timeout för skalanrop

Anger att gränssnittsanropet överskred den konfigurerade tidsgränsen.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Utfallstypen. Alltid `timeout`. Möjliga värden: `timeout`	Ja	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Utgång av timeout för skalanrop

Anger att gränssnittsanropet överskred den konfigurerade tidsgränsen.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Utfallstypen. Alltid `timeout`. Möjliga värden: `timeout`	Ja	timeout

OpenAI.FunctionShellCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Skalverktyg

Ett verktyg som gör att modellen kan köra gränssnittskommandon.

Name	Type	Description	Obligatoriskt	Standardinställning
environment	OpenAI.FunctionShellToolParamEnvironment eller null		No
type	enum	Typ av gränssnittsverktyg. Alltid `shell`. Möjliga värden: `shell`	Ja	Skal

OpenAI.FunctionShellToolParamEnvironment

Discriminator för OpenAI.FunctionShellToolParamEnvironment

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellToolParamEnvironmentType		Ja

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Type	Description	Obligatoriskt	Standardinställning
container_id	string	ID:t för den refererade containern.	Ja
type	enum	Refererar till en container skapad med /v1/containers-endpointen Möjliga värden: `container_reference`	Ja	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Type	Description	Obligatoriskt	Standardinställning
Färdigheter	array av OpenAI.LocalSkillParam	En valfri lista över färdigheter. Begränsningar: maxFöremål: 200	No
type	enum	Använd en lokal datormiljö. Möjliga värden: `local`	Ja	lokal

OpenAI.FunctionShellToolParamEnvironmentType

Property	Value
Type	string
Värden	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Funktion

Definierar en funktion i din egen kod som modellen kan välja att anropa.

Name	Type	Description	Obligatoriskt	Standardinställning
defer_loading	boolean	Om denna funktion skjuts upp och laddas via verktygssökning.	No
beskrivning	sträng eller null		No
name	string	Namnet på funktionen som ska anropas.	Ja
parameters	objekt eller null		Ja
Strikt	booleskt värde eller null		Ja
type	enum	Typ av funktionsverktyg. Alltid `function`. Möjliga värden: `function`	Ja	function

OpenAI.FunctionToolParam

Name	Type	Description	Obligatoriskt	Standardinställning
defer_loading	boolean	Om denna funktion bör skjutas upp och upptäckas via verktygssökning.	No
beskrivning	sträng eller null		No
name	string	Begränsningar: minLängd: 1, maxLängd: 128, mönster: `^[a-zA-Z0-9_-]+$`	Ja
parameters	OpenAI.EmptyModelParam eller null		No
Strikt	booleskt värde eller null		No
type	enum	Möjliga värden: `function`	Ja	function

OpenAI.GrammarSyntax1

Property	Value
Type	string
Värden	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Type	Description	Obligatoriskt	Standardinställning
embedding_weight	number	Vikten av inbäddningen i den ömsesidiga rankningsfusionen.	Ja
text_weight	number	Textens vikt i den ömsesidiga rangordningsfusionen.	Ja

OpenAI.ImageDetail

Property	Value
Type	string
Värden	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Property	Value
Type	string
Värden	`generate` `edit` `auto`

OpenAI.ImageGenTool

Bildgenereringsverktyg

Ett verktyg som genererar bilder med hjälp av GPT-bildmodellerna.

Giltiga modeller:

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

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.ImageGenActionEnum		No
bakgrund	enum	Bakgrundstyp för den genererade bilden. En av `transparent`, `opaque`, eller `auto`. Förvald: `auto`. Möjliga värden: `transparent`, `opaque`, `auto`	No	bil
input_fidelity	OpenAI.InputFidelity eller null		No
inmatningsbildmask	OpenAI.ImageGenToolInputImageMask		No
└– file_id	string		No
└ image_url	Sträng (uri)		No
model	sträng (se giltiga modeller nedan)		No
Måtta	enum	Modereringsnivå för den genererade avbildningen. Förvald: `auto`. Möjliga värden: `auto`, `low`	No	bil
Utdata kompression	integer	Komprimeringsnivå för utdatabilden. Standard: 100. Begränsningar: min: 0, max: 100	No	100
output_format	enum	Utdataformatet för den genererade avbildningen. En av `png`, `webp` eller `jpeg`. Förvald: `png`. Möjliga värden: `png`, `webp`, `jpeg`	No	png
delbilder	integer	Antal partiella bilder som ska genereras i strömningsläge, från 0 (standardvärde) till 3. Begränsningar: min: 0, max: 3	No
kvalitet	enum	Kvaliteten på den genererade avbildningen. En av `low`, `medium`, `high` eller `auto`. Förvald: `auto`. Möjliga värden: `low`, `medium`, `high`, `auto`	No	bil
storlek	sträng (se giltiga modeller nedan)	Storleken på de genererade bilderna. För `gpt-image-2` och `gpt-image-2-2026-04-21`stöds godtyckliga resolutioner som `WIDTHxHEIGHT` strängar, till exempel `1536x864`. Bredd och höjd måste båda vara delbara med 16 och det begärda bildförhållandet måste vara mellan 1:3 och 3:1. Upplösningarna ovan är `2560x1440` experimentella, och den maximalt stödda upplösningen är `3840x2160`. Den begärda storleken måste också uppfylla modellens nuvarande pixel- och kantgränser. Standardstorlekarna `1024x1024`, `1536x1024`, och `1024x1536` stöds av GPT-bildmodellerna; `auto` stöds för modeller som tillåter automatisk storlek. För `dall-e-2`, använd en av `256x256`, `512x512`, eller `1024x1024`. För `dall-e-3`, använd en av `1024x1024`, `1792x1024`, eller `1024x1792`.	No
type	enum	Typ av bildgenereringsverktyg. Alltid `image_generation`. Möjliga värden: `image_generation`	Ja	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Type	Description	Obligatoriskt	Standardinställning
file_id	string		No
image_url	Sträng (uri)		No

OpenAI.IncludeEnum

Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande stöds värden:

web_search_call.results: Inkludera sökresultaten från webbsökverktygets anrop.
web_search_call.action.sources: Inkludera källorna för webbsökningsverktygets anrop.
code_interpreter_call.outputs: Innehåller utdata från python-kodkörning i kodtolkverktygets anropsobjekt.
computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsutdata.
file_search_call.results: Inkludera sökresultaten för filsökningsverktygets anrop.
message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
message.output_text.logprobs: Inkludera logprobs tillsammans med assistentmeddelanden.
reasoning.encrypted_content: Innehåller en krypterad version av resonemangstoken i utdata för resonemangsobjekt. Detta gör att resonemangsobjekt kan användas i konversationer med flera turer när du använder svars-API:et tillståndslöst (till exempel när parametern store är inställd på falseeller när en organisation har registrerats i programmet för datakvarhållning utan data).

Property	Value
Beskrivning	Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande stöds värden: - `web_search_call.results`: Inkludera sökresultaten från webbsökverktygets anrop. - `web_search_call.action.sources`: Inkludera källorna till webbsökningsverktygets anrop. - `code_interpreter_call.outputs`: Innehåller utdata från python-kodkörning i kodtolkverktygets anropsobjekt. - `computer_call_output.output.image_url`: Inkludera bild-URL:er från datorns anropsresultat. - `file_search_call.results`: Inkludera sökresultaten för filsökningsverktygets anrop. - `message.input_image.image_url`: Inkludera bild-URL:er från indatameddelandet. - `message.output_text.logprobs`: Inkludera logprobs med assistentmeddelanden. - `reasoning.encrypted_content`: Innehåller en krypterad version av resonemangstoken i utdata för resonemangsobjekt. Detta gör att resonemangsobjekt kan användas i konversationer med flera turer när du använder svars-API:et tillståndslöst (till exempel när parametern `store` är inställd på `false`eller när en organisation har registrerats i programmet för datakvarhållning utan data).
Type	string
Värden	`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	Type	Description	Obligatoriskt	Standardinställning
beskrivning	string	Beskrivningen av färdigheten.	Ja
name	string	Namnet på färdigheten.	Ja
source	OpenAI.InlineSkillSourceParam	Inline-färdighetslast	Ja
└– data	string	Base64-kodad färdighets-zip-bundle. Begränsningar: minLängd: 1, maxLängd: 70254592	Ja
└─ media_type	enum	Mediatypen för den inline-färdighetspayloaden. Måste vara `application/zip`. Möjliga värden: `application/zip`	Ja	applikation/zip
└– typ	enum	Typen av inline-kompetenskällan. Måste vara `base64`. Möjliga värden: `base64`	Ja	base64
type	enum	Definierar en inline-färdighet för denna förfrågan. Möjliga värden: `inline`	Ja	inline

OpenAI.InlineSkillSourceParam

Inline-färdighetslast

Name	Type	Description	Obligatoriskt	Standardinställning
data	string	Base64-kodad färdighets-zip-bundle. Begränsningar: minLängd: 1, maxLängd: 70254592	Ja
media_type	enum	Mediatypen för den inline-färdighetspayloaden. Måste vara `application/zip`. Möjliga värden: `application/zip`	Ja	applikation/zip
type	enum	Typen av inline-kompetenskällan. Måste vara `base64`. Möjliga värden: `base64`	Ja	base64

OpenAI.InputContent

Diskriminerande för OpenAI.InputContent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.InputContentType		Ja

OpenAI.InputContentInputFileContent

Inmatningsfil

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.FileInputDetail		No
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng eller null		No
file_url	Sträng (uri)	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja	input_file

OpenAI.InputContentInputImageContent

Inmatningsbild

En bildinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng eller null		No
image_url	sträng eller null		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja	input_image

OpenAI.InputContentInputTextContent

Indatatext

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja	input_text

OpenAI.InputContentType

Property	Value
Type	string
Värden	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Kontrollera hur mycket arbete modellen kommer att utöva för att matcha stilen och funktionerna, särskilt ansiktsdrag, för indatabilder. Denna parameter stöds endast för gpt-image-1 och gpt-image-1.5 senare modeller, ej stödd för gpt-image-1-mini. Stöder high och low. Standardinställningen är low.

Property	Value
Type	string
Värden	`high` `low`

OpenAI.InputFileContent

Inmatningsfil

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.FileInputDetail		No
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng eller null		No
file_url	Sträng (uri)	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja	input_file

OpenAI.InputFileContentParam

Inmatningsfil

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.FileInputDetail		No
file_data	sträng eller null		No
file_id	sträng eller null		No
file_url	sträng eller null		No
filename	sträng eller null		No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja	input_file

OpenAI.InputImageContent

Inmatningsbild

En bildinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng eller null		No
image_url	sträng eller null		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja	input_image

OpenAI.InputImageContentParamAutoParam

Inmatningsbild

En bildinmatning till modellen. Lär dig om bildinmatningar

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.DetailEnum eller null		No
file_id	sträng eller null		No
image_url	sträng eller null		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja	input_image

OpenAI.InputItem

Ett objekt som representerar en del av kontexten för svaret som ska genereras av modellen. Kan innehålla text, bilder och ljudindata, samt tidigare assistentsvar och verktygsanropsutdata.

Diskriminerande för OpenAI.InputItem

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.InputItemType		Ja

OpenAI.InputItemApplyPatchToolCallItemParam

Apply patch tool-anrop

Ett verktygsanrop som representerar en begäran om att skapa, ta bort eller uppdatera filer med hjälp av diff-korrigeringar.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng eller null		No
Operation	OpenAI.ApplyPatchOperationParam	En av de create_file, delete_file eller update_file åtgärder som tillhandahålls till apply_patch-verktyget.	Ja
└– typ	OpenAI.ApplyPatchOperationParamType		Ja
status	OpenAI.ApplyPatchCallStatusParam	Statusvärden som rapporterats för apply_patch-verktygsanrop.	Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Applicera patchverktygets anropsutdata

De strömmade utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng eller null		No
output	sträng eller null		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Utfallsvärden som rapporterats för apply_patch verktygsanropsutdata.	Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Kodtolkar-verktygsanrop

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt	Standardinställning
code	sträng eller null		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage eller null		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Kompaktionsobjekt

Ett kompaktionsobjekt genererat av API:et v1/responses/compact .

Name	Type	Description	Obligatoriskt	Standardinställning
encrypted_content	string	Det krypterade innehållet i komprimeringssammanfattningen. Begränsningar: maxLength: 10485760	Ja
id	sträng eller null		No
type	enum	Typ av objekt. Alltid `compaction`. Möjliga värden: `compaction`	Ja	Kompaktering

OpenAI.InputItemComputerCallOutputItemParam

Datorverktygsanropsutgång

Utdata från ett datorverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
acknowledged_safety_checks	array av OpenAI.ComputerCallSafetyCheckParam eller null		No
call_id	string	ID:t för datorverktygets anrop som genererade utdata. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng eller null		No
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	OpenAI.FunctionCallItemStatus eller null		No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja	computer_call_output

OpenAI.InputItemComputerToolCall

Datorverktygsrop

Ett verktygsanrop till ett datoranvändningsverktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Tillplattade batchade handlingar för `computer_use`. Varje handling inkluderar en `type` diskriminerande och handlingsspecifika fält.	No
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja	computer_call

OpenAI.InputItemCustomToolCall

Anpassad verktygsanrop

Ett anrop till ett anpassat verktyg som skapats av modellen.

Name	Type	Description	Obligatoriskt
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
namespace	string	Namnrymden för det anpassade verktyget som anropas.	No
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.InputItemCustomToolCallOutput

Utdata av anpassat verktygsanrop

Utdata från ett anpassat verktygsanrop från koden som skickas tillbaka till modellen.

Name	Type	Description	Obligatoriskt
call_id	string	Anrops-ID:t som används för att mappa det här anpassade verktyget anropar utdata till ett anpassat verktygsanrop.	Ja
id	string	Det unika ID:t för det anpassade verktyget anropar utdata i OpenAI-plattformen.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från det anpassade verktygsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
type	enum	Typen av anpassade verktyg anropar utdata. Alltid `custom_tool_call_output`. Möjliga värden: `custom_tool_call_output`	Ja

OpenAI.InputItemFileSearchToolCall

Filsökverktygsanrop

Resultatet av ett filsökningsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults eller null		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.InputItemFunctionCallOutputItemParam

Funktionsverktygsanropsutgång

Utdata från ett funktionsverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng eller null		No
output	sträng eller matris med OpenAI.InputTextContentParam eller OpenAI.InputImageContentParamAutoParam eller OpenAI.InputFileContentParam	Text, bild eller filutdata för funktionsverktygets anrop.	Ja
status	OpenAI.FunctionCallItemStatus eller null		No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Skalverktygsrop

Ett verktyg som representerar en begäran om att köra ett eller flera gränssnittskommandon.

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.FunctionShellActionParam	Kommandon och begränsningar som beskriver hur du kör gränssnittets verktygsanrop.	Ja
└– kommandon	strängmatris	Beställda gränssnittskommandon för körningsmiljön som ska köras.	Ja
└– max_output_length	heltal eller null		No
└– timeout_ms	heltal eller null		No
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
environment	OpenAI.FunctionShellCallItemParamEnvironment eller null		No
id	sträng eller null		No
status	OpenAI.FunctionShellCallItemStatus eller null		No
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Skalverktygsanropsutgång

De strömmade utdataobjekten som genereras av ett gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng eller null		No
max_output_length	heltal eller null		No
output	matris med OpenAI.FunctionShellCallOutputContentParam	Insamlade segment av stdout- och stderr-utdata, tillsammans med deras associerade resultat.	Ja
status	OpenAI.FunctionShellCallItemStatus eller null		No
type	enum	Typ av objekt. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja	shell_call_output

OpenAI.InputItemFunctionToolCall

Funktionsverktygsanrop

Ett verktygsanrop för att köra en funktion.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	sträng (skrivskyddad)	Det unika ID:t för funktionsverktygets anrop.	Ja
name	string	Namnet på den funktion som ska köras.	Ja
namespace	string	Namnrymden för funktionen som ska köras.	No
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.InputItemImageGenToolCall

Bildgenereringsanrop

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng eller null		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.InputItemLocalShellToolCall

Lokalt skalrop

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.InputItemLocalShellToolCallOutput

Lokal skalanropsutgång

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	sträng eller null		No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.InputItemMcpApprovalRequest

MCP-godkännandebegäran

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.InputItemMcpApprovalResponse

MCP-godkännandesvar

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	sträng eller null		No
reason	sträng eller null		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.InputItemMcpListTools

MCP-listverktyg

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	OpenAI.RealtimeMCPError		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.InputItemMcpToolCall

MCP-verktygsanrop

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng eller null		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	OpenAI.RealtimeMCPError		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng eller null		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.InputItemOutputMessage

Utdatameddelande

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
phase	OpenAI.MessagePhase eller null		No
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.InputItemReasoningItem

Reasoning

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att dessa objekt inkluderas i svarens API input för efterföljande turer i en konversation om du hanterar kontexten manuellt.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng eller null		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	array av OpenAI.SammanfattningInnehållInnehåll	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.InputItemToolSearchCallItemParam

Name	Type	Description	Obligatoriskt	Standardinställning
arguments	OpenAI.EmptyModelParam		Ja
call_id	sträng eller null		No
avrättning	OpenAI.ToolSearchExecutionType		No
id	sträng eller null		No
status	OpenAI.FunctionCallItemStatus eller null		No
type	enum	Objekttypen. Alltid `tool_search_call`. Möjliga värden: `tool_search_call`	Ja	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	sträng eller null		No
avrättning	OpenAI.ToolSearchExecutionType		No
id	sträng eller null		No
status	OpenAI.FunctionCallItemStatus eller null		No
tools	matris med OpenAI.Tool	De laddade verktygsdefinitionerna returnerades av verktygssökningens resultat.	Ja
type	enum	Objekttypen. Alltid `tool_search_output`. Möjliga värden: `tool_search_output`	Ja	tool_search_output

OpenAI.InputItemType

Property Value

Type string

Värden 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

Webbsökverktyg anrop

Resultatet av ett webbsökningsverktygsanrop.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller detaljer om hur modellen använde webben (sök, open_page, find_in_page).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.InputMessageContentList

Innehållslista för inmatningsobjekt

En lista över ett eller flera indataobjekt till modellen som innehåller olika innehållstyper.

Matris för: OpenAI.InputContent

OpenAI.InputParam

Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer:

Textinmatningar och utdata
Bildingångar
Filindata
Konversationstillstånd
Funktionsanrop

Den här komponenten kan vara något av följande:

sträng
array

OpenAI.InputTextContent

Indatatext

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja	input_text

OpenAI.InputTextContentParam

Indatatext

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen. Begränsningar: maxLength: 10485760	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja	input_text

OpenAI.ItemReferenceParam

Objektreferens

En intern identifierare för ett objekt att referera till.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	ID:t för det objekt som ska refereras till.	Ja
type	enum	Typ av objekt som ska refereras till. Alltid `item_reference`. Möjliga värden: `item_reference`	Ja	item_reference

OpenAI.ItemResource

Innehållsobjekt som används för att generera ett svar.

Diskriminerande för OpenAI.ItemResource

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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.ItemResourceResonerandeItem
`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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ItemResourceType		Ja

OpenAI.ItemResourceApplyPatchToolCall

Apply patch tool-anrop

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för anropet använd korrigeringsverktyg. Fylls i när det här objektet returneras via API.	Ja
Operation	OpenAI.ApplyPatchFileOperation	En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.	Ja
└– typ	OpenAI.ApplyPatchFileOperationType		Ja
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Applicera patchverktygets anropsutdata

Utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktyget anropar utdata.	No
id	string	Det unika ID:t för anropsutdata för det tillämpade korrigeringsverktyget. Fylls i när det här objektet returneras via API.	Ja
output	sträng eller null		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Kodtolkar-verktygsanrop

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt	Standardinställning
code	sträng eller null		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage eller null		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja	code_interpreter_call

OpenAI.ItemResourceCompactBody

Kompaktionsobjekt

Ett kompaktionsobjekt genererat av API:et v1/responses/compact .

Name	Type	Description	Obligatoriskt	Standardinställning
skapad av	string	Identifieraren för aktören som skapade objektet.	No
encrypted_content	string	Det krypterade innehåll som producerades av komprimering.	Ja
id	string	Det unika ID:t för komprimeringsobjektet.	Ja
type	enum	Typ av objekt. Alltid `compaction`. Möjliga värden: `compaction`	Ja	Kompaktering

OpenAI.ItemResourceComputerToolCall

Datorverktygsrop

Ett verktygsanrop till ett datoranvändningsverktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Tillplattade batchade handlingar för `computer_use`. Varje handling inkluderar en `type` diskriminerande och handlingsspecifika fält.	No
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Datorverktygsanropsutgång

Utdata från ett datorverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De säkerhetskontroller som rapporterats av API:et och som har bekräftats av utvecklare.	No
call_id	string	ID:t för datorverktygets anrop som genererade utdata.	Ja
id	sträng (skrivskyddad)	ID:t för datorverktyget anropar utdata.	Ja
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Type	Description	Obligatoriskt
call_id	string	Anrops-ID:t som används för att mappa det här anpassade verktyget anropar utdata till ett anpassat verktygsanrop.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för det anpassade verktyget anropar utdata i OpenAI-plattformen.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från det anpassade verktygsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
type	enum	Typen av anpassade verktyg anropar utdata. Alltid `custom_tool_call_output`. Möjliga värden: `custom_tool_call_output`	Ja

OpenAI.ItemResourceCustomToolCallResource

ResponseCustomToolCallItem

Name	Type	Description	Obligatoriskt
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
namespace	string	Namnrymden för det anpassade verktyget som anropas.	No
status	OpenAI.FunctionCallStatus		Ja
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.ItemResourceFileSearchToolCall

Filsökverktygsanrop

Resultatet av ett filsökningsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults eller null		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.ItemResourceFunctionShellCall

Skalverktygsrop

Ett verktygsanrop som kör ett eller flera gränssnittskommandon i en hanterad miljö.

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.FunctionShellAction	Kör ett gränssnittskommando.	Ja
└– kommandon	strängmatris		Ja
└– max_output_length	heltal eller null		Ja
└– timeout_ms	heltal eller null		Ja
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
environment	OpenAI.FunctionShellCallEnvironment eller null		Ja
id	string	Det unika ID:t för gränssnittets verktygsanrop. Fylls i när det här objektet returneras via API.	Ja
status	OpenAI.FunctionShellCallStatus		Ja
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Skalanropsutgång

Utdata från ett gränssnittsverktygsanrop som har genererats.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för shell-anropets utdata. Fylls i när det här objektet returneras via API.	Ja
max_output_length	heltal eller null		Ja
output	matris med OpenAI.FunctionShellCallOutputContent	En matris med gränssnittsanropets utdatainnehåll	Ja
status	OpenAI.FunctionShellCallOutputStatusEnum		Ja
type	enum	Typ av gränssnittsanropets utdata. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja	shell_call_output

OpenAI.ItemResourceFunctionToolCall

Funktionsverktygsanrop

Ett verktygsanrop för att köra en funktion.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	sträng (skrivskyddad)	Det unika ID:t för funktionsverktygets anrop.	Ja
name	string	Namnet på den funktion som ska köras.	Ja
namespace	string	Namnrymden för funktionen som ska köras.	No
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.ItemResourceFunctionToolCallOutput

Funktionsverktygsanropsutgång

Utdata från ett funktionsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	sträng (skrivskyddad)	Det unika ID:t för funktionsverktygets anropsresultat. Fylls i när det här objektet returneras via API.	Ja
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från funktionsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja

OpenAI.ItemResourceImageGenToolCall

Bildgenereringsanrop

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng eller null		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.ItemResourceInputMessage

Inmatningsmeddelande

Name	Type	Description	Obligatoriskt	Standardinställning
innehåll	OpenAI.InputMessageContentList	En lista över ett eller flera indataobjekt till modellen som innehåller olika innehåll types.	Ja
id	sträng (skrivskyddad)	Det unika ID:t för meddelandeindata.	Ja
role	enum	Rollen för meddelandets inmatning. En av `user`, `system`eller `developer`. Möjliga värden: `user`, `system`, `developer`	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av meddelandeindata. Ställ alltid in på `message`. Möjliga värden: `message`	Ja	message

OpenAI.ItemResourceLocalShellToolCall

Lokalt skalrop

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.ItemResourceLocalShellToolCallOutput

Lokal skalanropsutgång

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	sträng eller null		No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.ItemResourceMcpApprovalRequest

MCP-godkännandebegäran

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.ItemResourceMcpApprovalResponseResource

MCP-godkännandesvar

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	string	Det unika ID:t för godkännandesvaret	Ja
reason	sträng eller null		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.ItemResourceMcpListTools

MCP-listverktyg

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	OpenAI.RealtimeMCPError		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.ItemResourceMcpToolCall

MCP-verktygsanrop

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng eller null		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	OpenAI.RealtimeMCPError		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng eller null		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.ItemResourceOutputMessage

Utdatameddelande

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
phase	OpenAI.MessagePhase eller null		No
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.ItemResourceResonerandeItem

Reasoning

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng eller null		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	array av OpenAI.SammanfattningInnehållInnehåll	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.ItemResourceToolSearchCall

Name	Type	Description	Obligatoriskt	Standardinställning
arguments		Argument som används för verktygssöket.	Ja
call_id	sträng eller null		Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
avrättning	OpenAI.ToolSearchExecutionType		Ja
id	string	Det unika ID:t för verktygets sökanrop.	Ja
status	OpenAI.FunctionCallStatus		Ja
type	enum	Typ av objekt. Alltid `tool_search_call`. Möjliga värden: `tool_search_call`	Ja	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	sträng eller null		Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
avrättning	OpenAI.ToolSearchExecutionType		Ja
id	string	Det unika ID:t för verktygets sökutdata.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
tools	matris med OpenAI.Tool	De laddade verktygsdefinitionerna returnerades av verktygssökning.	Ja
type	enum	Typ av objekt. Alltid `tool_search_output`. Möjliga värden: `tool_search_output`	Ja	tool_search_output

OpenAI.ItemResourceType

Property Value

Type string

OpenAI.ItemResourceWebSearchToolCall

Webbsökverktyg anrop

Resultatet av ett webbsökningsverktygsanrop.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller detaljer om hur modellen använde webben (sök, open_page, find_in_page).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.KeyPressAction

KeyPress

En samling tangenttryckningar som modellen vill utföra.

Name	Type	Description	Obligatoriskt	Standardinställning
keys	strängmatris	Kombinationen av knappar som modellen vill att man trycker på. Det här är en matris med strängar som var och en representerar en nyckel.	Ja
type	enum	Anger händelsetypen. För en keypress-åtgärd är den här egenskapen alltid inställd på `keypress`. Möjliga värden: `keypress`	Ja	Tangenttryck

OpenAI.LocalEnvironmentResource

Lokal miljö

Representerar användningen av en lokal miljö för att utföra skalåtgärder.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typen av miljö. Alltid `local`. Möjliga värden: `local`	Ja	lokal

OpenAI.LocalShellExecAction

Lokal insats från granatchefen

Kör ett gränssnittskommando på servern.

Name	Type	Description	Obligatoriskt	Standardinställning
command	strängmatris	Kommandot som ska köras.	Ja
env	object	Miljövariabler som ska anges för kommandot.	Ja
timeout_ms (timeout i millisekunder)	heltal eller null		No
type	enum	Typen av lokal shell-åtgärd. Alltid `exec`. Möjliga värden: `exec`	Ja	exec
user	sträng eller null		No
arbetskatalog	sträng eller null		No

OpenAI.LocalShellToolParam

Lokalt skalverktyg

Ett verktyg som gör att modellen kan köra gränssnittskommandon i en lokal miljö.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av lokalt gränssnittsverktyg. Alltid `local_shell`. Möjliga värden: `local_shell`	Ja	local_shell

OpenAI.LocalSkillParam

Name	Type	Description	Obligatoriskt
beskrivning	string	Beskrivningen av färdigheten.	Ja
name	string	Namnet på färdigheten.	Ja
path	string	Vägen till katalogen som innehåller färdigheten.	Ja

OpenAI.LogProb

Logaritmisk sannolikhet

Log sannolikhet för en token.

Name	Type	Obligatoriskt
bytes	matris med heltal	Ja
logprob	number	Ja
token	string	Ja
top_logprobs	matris med OpenAI.TopLogProb	Ja

OpenAI.MCPListToolsTool

MCP-listverktyg

Ett verktyg som är tillgängligt på en MCP-server.

Name	Type	Description	Obligatoriskt
annotations	OpenAI.MCPListToolsToolAnnotations eller null		No
beskrivning	sträng eller null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Ja
name	string	Namnet på verktyget.	Ja

OpenAI.MCPListToolsToolAnnotations

Typ: objekt

OpenAI.MCPListToolsToolInputSchema

Typ: objekt

OpenAI.MCPTool

MCP-verktyg

Ge modellen åtkomst till ytterligare verktyg via MCP-servrar (Remote Model Context Protocol).

Name	Type	Description	Obligatoriskt
tillåtna_verktyg	matris med sträng eller OpenAI.MCPToolFilter eller null		No
authorization	string	En OAuth-åtkomsttoken som kan användas med en fjärr-MCP-server, antingen med en anpassad MCP-server-URL eller en tjänstanslutning. Din ansökan måste hantera OAuth-auktoriseringsflödet och ange token här.	No
connector_id	enum	Identifierare för tjänstanslutningsprogram, som de som är tillgängliga i ChatGPT. En av `server_url` eller `connector_id` måste tillhandahållas. Läs mer om tjänsten Kontakter här. För närvarande stöds `connector_id` värden: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` – Google Calendar: `connector_googlecalendar` – Google Drive: `connector_googledrive` – Microsoft Teams: `connector_microsoftteams` – Outlook-kalender: `connector_outlookcalendar` – E-post i Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Möjliga värden: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , , `connector_outlookemailconnector_sharepoint`	No
defer_loading	boolean	Om detta MCP-verktyg skjuts upp och upptäcks via verktygssökning.	No
headers	objekt eller null		No
kräv_godkännande	OpenAI.MCPToolRequireApproval eller sträng eller null		No
server_description	string	Valfri beskrivning av MCP-servern, som används för att ge mer kontext.	No
serveretikett	string	En etikett för den här MCP-servern som används för att identifiera den i verktygsanrop.	Ja
server_url	Sträng (uri)	URL:en för MCP-servern. En av `server_url` eller `connector_id` måste vara tillhandahålls.	No
type	enum	Typ av MCP-verktyg. Alltid `mcp`. Möjliga värden: `mcp`	Ja

OpenAI.MCPToolCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

MCP-verktygsfilter

Ett filterobjekt som anger vilka verktyg som tillåts.

Name	Type	Description	Obligatoriskt	Standardinställning
read_only	boolean	Anger om ett verktyg ändrar data eller är skrivskyddat. Om en MCP-servern kommenteras med `readOnlyHint`, det matchar det här filtret.	No
tool_names	strängmatris	Lista över tillåtna verktygsnamn.	No

OpenAI.MCPToolRequireApproval

Name	Type	Description	Obligatoriskt	Standardinställning
always	OpenAI.MCPToolFilter	Ett filterobjekt som anger vilka verktyg som tillåts.	No
aldrig	OpenAI.MCPToolFilter	Ett filterobjekt som anger vilka verktyg som tillåts.	No

OpenAI.MessageContent

En innehållsdel som utgör ett indata- eller utdataobjekt.

Diskriminerande för OpenAI.MessageContent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.MessageContentType		Ja

OpenAI.MessageContentInputFileContent

Inmatningsfil

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.FileInputDetail		No
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng eller null		No
file_url	Sträng (uri)	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja	input_file

OpenAI.MessageContentInputImageContent

Inmatningsbild

En bildinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng eller null		No
image_url	sträng eller null		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja	input_image

OpenAI.MessageContentInputTextContent

Indatatext

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja	input_text

OpenAI.MessageContentOutputTextContent

Utdata text

En textutgång från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
annotations	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		Ja
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja	output_text

OpenAI.MessageContentReasoningTextContent

Resonemangstext

Resonemangstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Resonemangstexten från modellen.	Ja
type	enum	Typen av resonemangstext. Alltid `reasoning_text`. Möjliga värden: `reasoning_text`	Ja	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

En vägran från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
vägran	string	Avslagsförklaringen från modellen.	Ja
type	enum	Typ av vägran. Alltid `refusal`. Möjliga värden: `refusal`	Ja	vägran

OpenAI.MessageContentType

Property	Value
Type	string
Värden	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

Märker ett assistant meddelande som en mellanliggande kommentar (commentary) eller det slutgiltiga svaret (final_answer). För modeller som och gpt-5.3-codex framåt, när man skickar uppföljningsförfrågningar, bevara och skicka om fasen på alla assistentmeddelanden – att tappa den kan försämra prestandan. Används inte för användarmeddelanden.

Property	Value
Type	string
Värden	`commentary` `final_answer`

OpenAI.Metadata

Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.

Typ: objekt

OpenAI.MoveParam

Move

En musflyttningsåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
keys	matris med sträng eller null		No
type	enum	Anger händelsetypen. För en flyttåtgärd är den här egenskapen alltid inställd på `move`. Möjliga värden: `move`	Ja	move
x	integer	X-koordinaten som ska flyttas till.	Ja
y	integer	Y-koordinaten att flytta till.	Ja

OpenAI.NamespaceToolParam

Namespace

Grupperar funktioner/anpassade verktyg under ett delat namnrymd.

Name	Type	Description	Obligatoriskt	Standardinställning
beskrivning	string	En beskrivning av namnrymden som visas modellen. Begränsningar: minLength: 1	Ja
name	string	Namnrymdsnamnet som används i verktygsanrop (till exempel `crm`). Begränsningar: minLength: 1	Ja
tools	array av OpenAI.FunctionToolParam eller OpenAI.CustomToolParam	Funktionen/anpassade verktyg som finns tillgängliga i detta namnrymd. Begränsningar: minItems: 1	Ja
type	enum	Verktygets typ. Alltid `namespace`. Möjliga värden: `namespace`	Ja	namespace

OpenAI.OutputContent

Diskriminerande för OpenAI.OutputContent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.OutputContentType		Ja

OpenAI.OutputContentOutputTextContent

Utdata text

En textutgång från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
annotations	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		Ja
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja	output_text

OpenAI.OutputContentReasoningTextContent

Resonemangstext

Resonemangstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Resonemangstexten från modellen.	Ja
type	enum	Typen av resonemangstext. Alltid `reasoning_text`. Möjliga värden: `reasoning_text`	Ja	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

En vägran från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
vägran	string	Avslagsförklaringen från modellen.	Ja
type	enum	Typ av vägran. Alltid `refusal`. Möjliga värden: `refusal`	Ja	vägran

OpenAI.OutputContentType

Property	Value
Type	string
Värden	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Diskriminerande för OpenAI.OutputItem

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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.OutputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.OutputItemType		Ja

OpenAI.OutputItemApplyPatchToolCall

Apply patch tool-anrop

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för anropet använd korrigeringsverktyg. Fylls i när det här objektet returneras via API.	Ja
Operation	OpenAI.ApplyPatchFileOperation	En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.	Ja
└– typ	OpenAI.ApplyPatchFileOperationType		Ja
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Applicera patchverktygets anropsutdata

Utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktyget anropar utdata.	No
id	string	Det unika ID:t för anropsutdata för det tillämpade korrigeringsverktyget. Fylls i när det här objektet returneras via API.	Ja
output	sträng eller null		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Kodtolkar-verktygsanrop

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt	Standardinställning
code	sträng eller null		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage eller null		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja	code_interpreter_call

OpenAI.OutputItemCompactionBody

Kompaktionsobjekt

Ett kompaktionsobjekt genererat av API:et v1/responses/compact .

Name	Type	Description	Obligatoriskt	Standardinställning
skapad av	string	Identifieraren för aktören som skapade objektet.	No
encrypted_content	string	Det krypterade innehåll som producerades av komprimering.	Ja
id	string	Det unika ID:t för komprimeringsobjektet.	Ja
type	enum	Typ av objekt. Alltid `compaction`. Möjliga värden: `compaction`	Ja	Kompaktering

OpenAI.OutputItemComputerToolCall

Datorverktygsrop

Ett verktygsanrop till ett datoranvändningsverktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Tillplattade batchade handlingar för `computer_use`. Varje handling inkluderar en `type` diskriminerande och handlingsspecifika fält.	No
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja	computer_call

OpenAI.OutputItemComputerToolCallOutput

Datorverktygsanropsutgång

Utdata från ett datorverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De säkerhetskontroller som rapporterats av API:et och som har bekräftats av utvecklare.	No
call_id	string	ID:t för datorverktygets anrop som genererade utdata.	Ja
id	sträng (skrivskyddad)	ID:t för datorverktyget anropar utdata.	Ja
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ResponseCustomToolCallOutputItem

Name	Type	Description	Obligatoriskt
call_id	string	Anrops-ID:t som används för att mappa det här anpassade verktyget anropar utdata till ett anpassat verktygsanrop.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för det anpassade verktyget anropar utdata i OpenAI-plattformen.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från det anpassade verktygsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
type	enum	Typen av anpassade verktyg anropar utdata. Alltid `custom_tool_call_output`. Möjliga värden: `custom_tool_call_output`	Ja

OpenAI.OutputItemCustomToolCallResource

ResponseCustomToolCallItem

Name	Type	Description	Obligatoriskt
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
namespace	string	Namnrymden för det anpassade verktyget som anropas.	No
status	OpenAI.FunctionCallStatus		Ja
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.OutputItemFileSearchToolCall

Filsökverktygsanrop

Resultatet av ett filsökningsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults eller null		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.OutputItemFunctionShellCall

Skalverktygsrop

Ett verktygsanrop som kör ett eller flera gränssnittskommandon i en hanterad miljö.

Name	Type	Description	Obligatoriskt	Standardinställning
åtgärd	OpenAI.FunctionShellAction	Kör ett gränssnittskommando.	Ja
└– kommandon	strängmatris		Ja
└– max_output_length	heltal eller null		Ja
└– timeout_ms	heltal eller null		Ja
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
environment	OpenAI.FunctionShellCallEnvironment eller null		Ja
id	string	Det unika ID:t för gränssnittets verktygsanrop. Fylls i när det här objektet returneras via API.	Ja
status	OpenAI.FunctionShellCallStatus		Ja
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Skalanropsutgång

Utdata från ett gränssnittsverktygsanrop som har genererats.

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för shell-anropets utdata. Fylls i när det här objektet returneras via API.	Ja
max_output_length	heltal eller null		Ja
output	matris med OpenAI.FunctionShellCallOutputContent	En matris med gränssnittsanropets utdatainnehåll	Ja
status	OpenAI.FunctionShellCallOutputStatusEnum		Ja
type	enum	Typ av gränssnittsanropets utdata. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja	shell_call_output

OpenAI.OutputItemFunctionToolCall

Funktionsverktygsanrop

Ett verktygsanrop för att köra en funktion.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	sträng (skrivskyddad)	Det unika ID:t för funktionsverktygets anrop.	Ja
name	string	Namnet på den funktion som ska köras.	Ja
namespace	string	Namnrymden för funktionen som ska köras.	No
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.OutputItemFunctionToolCallOutput

Funktionsverktygsanropsutgång

Utdata från ett funktionsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	sträng (skrivskyddad)	Det unika ID:t för funktionsverktygets anropsresultat. Fylls i när det här objektet returneras via API.	Ja
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från funktionsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja

OpenAI.OutputItemImageGenToolCall

Bildgenereringsanrop

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng eller null		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.OutputItemLocalShellToolCall

Lokalt skalrop

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.OutputItemLocalShellToolCallOutput

Lokal skalanropsutgång

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	sträng eller null		No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.OutputItemMcpApprovalRequest

MCP-godkännandebegäran

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.OutputItemMcpApprovalResponseResource

MCP-godkännandesvar

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	string	Det unika ID:t för godkännandesvaret	Ja
reason	sträng eller null		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.OutputItemMcpListTools

MCP-listverktyg

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	OpenAI.RealtimeMCPError		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.OutputItemMcpToolCall

MCP-verktygsanrop

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng eller null		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	OpenAI.RealtimeMCPError		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng eller null		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.OutputItemOutputMessage

Utdatameddelande

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
phase	OpenAI.MessagePhase eller null		No
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.OutputItemReasoningItem

Reasoning

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng eller null		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	array av OpenAI.SammanfattningInnehållInnehåll	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.OutputItemToolSearchCall

Name	Type	Description	Obligatoriskt	Standardinställning
arguments		Argument som används för verktygssöket.	Ja
call_id	sträng eller null		Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
avrättning	OpenAI.ToolSearchExecutionType		Ja
id	string	Det unika ID:t för verktygets sökanrop.	Ja
status	OpenAI.FunctionCallStatus		Ja
type	enum	Typ av objekt. Alltid `tool_search_call`. Möjliga värden: `tool_search_call`	Ja	tool_search_call

OpenAI.OutputItemToolSearchOutput

Name	Type	Description	Obligatoriskt	Standardinställning
call_id	sträng eller null		Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
avrättning	OpenAI.ToolSearchExecutionType		Ja
id	string	Det unika ID:t för verktygets sökutdata.	Ja
status	OpenAI.FunctionCallOutputStatusEnum		Ja
tools	matris med OpenAI.Tool	De laddade verktygsdefinitionerna returnerades av verktygssökning.	Ja
type	enum	Typ av objekt. Alltid `tool_search_output`. Möjliga värden: `tool_search_output`	Ja	tool_search_output

OpenAI.OutputItemType

Property Value

Type string

Värden 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

Webbsökverktyg anrop

Resultatet av ett webbsökningsverktygsanrop.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller detaljer om hur modellen använde webben (sök, open_page, find_in_page).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.OutputMessageContent

Diskriminerande för OpenAI.OutputMessageContent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.OutputMessageContentType		Ja

OpenAI.OutputMessageContentOutputTextContent

Utdata text

En textutgång från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
annotations	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		Ja
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

En vägran från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
vägran	string	Avslagsförklaringen från modellen.	Ja
type	enum	Typ av vägran. Alltid `refusal`. Möjliga värden: `refusal`	Ja	vägran

OpenAI.OutputMessageContentType

Property	Value
Type	string
Värden	`output_text` `refusal`

OpenAI.Prompt

Referens till en promptmall och dess variabler.

Name	Type	Description	Obligatoriskt
id	string	Den unika identifieraren för den promptmall som ska användas.	Ja
variables	OpenAI.ResponsePromptVariables eller null		No
version	sträng eller null		No

OpenAI.RankerVersionType

Property	Value
Type	string
Värden	`auto` `default-2024-11-15`

OpenAI.Rankningsalternativ

Name	Type	Description	Obligatoriskt
hybrid_search	OpenAI.HybridSearchOptions		No
└– embedding_weight	number	Vikten av inbäddningen i den ömsesidiga rankningsfusionen.	Ja
└– text_weight	number	Textens vikt i den ömsesidiga rangordningsfusionen.	Ja
rankare	OpenAI.RankerVersionType		No
poängtröskel	number	Tröskelvärdet för poäng för filsökningen, ett tal mellan 0 och 1. Tal närmare 1 försöker returnera endast de mest relevanta resultaten, men kan returnera färre resultat.	No

OpenAI.RealtimeMCPError

Discriminator för OpenAI.RealtimeMCPError

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.RealtimeMcpErrorType		Ja

OpenAI.RealtimeMCPHTTPError

Realtime MCP HTTP-fel

Name	Type	Description	Obligatoriskt
code	integer		Ja
message	string		Ja
type	enum	Möjliga värden: `http_error`	Ja

OpenAI.RealtimeMCPProtocolError

Realtidsfel i MCP-protokollet

Name	Type	Description	Obligatoriskt
code	integer		Ja
message	string		Ja
type	enum	Möjliga värden: `protocol_error`	Ja

OpenAI.RealtimeMCPToolExecutionError

Felet i exekveringsverktyget i realtid för MCP-verktyget

Name	Type	Description	Obligatoriskt	Standardinställning
message	string		Ja
type	enum	Möjliga värden: `tool_execution_error`	Ja

OpenAI.RealtimeMcpErrorType

Property	Value
Type	string
Värden	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.

Name	Type	Description	Obligatoriskt
effort	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
generate_summary	sträng eller null		No
summary	sträng eller null		No

OpenAI.ReasoningEffort

Begränsar arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är none, minimal, low, medium, highoch xhigh. Att minska resonemangsinsatsen kan resultera i snabbare svar och färre token som används vid resonemang i ett svar.

gpt-5.1 standardvärdet är none, som inte utför resonemang. De resonemangsvärden som stöds för gpt-5.1 är none, low, mediumoch high. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1.
Alla modeller före gpt-5.1 standardinställningen för resonemang och har inte stöd mediumför none .
Modellen gpt-5-pro har som standard (och stöder endast) high resonemang.
xhigh stöds för alla modeller efter gpt-5.1-codex-max.

Property	Value
Beskrivning	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.
Type	string
Värden	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Resonemangstext

Resonemangstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Resonemangstexten från modellen.	Ja
type	enum	Typen av resonemangstext. Alltid `reasoning_text`. Möjliga värden: `reasoning_text`	Ja	reasoning_text

OpenAI.Response

Svarobjektet

Name	Type	Description	Obligatoriskt	Standardinställning
bakgrund	booleskt värde eller null		No
klarad_vid	sträng eller null		No
content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
konversation	OpenAI.ConversationReference eller null		No
skapad_tid	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
fel	OpenAI.ResponseError eller null		Ja
id	string	Unik identifierare för det här svaret.	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails eller null		Ja
instructions	sträng eller matris med OpenAI.InputItem eller null		Ja
max_output_tokens	heltal eller null		No
max_verktygs_anrop	heltal eller null		No
metadata	OpenAI.Metadata eller null		No
model	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
object	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
output	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
output_text	sträng eller null		No
parallella verktygsanrop	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
previous_response_id	sträng eller null		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
prompt_cache_retention	sträng eller null		No
reasoning	OpenAI.Reasoning eller null		No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatur	tal eller null		No
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
top_logprobs	heltal eller null		No
top_p	tal eller null		No
truncation	sträng eller null		No
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No

OpenAI.ResponseAudioDeltaEvent

Genereras när det finns ett partiellt ljudsvar.

Name	Type	Description	Obligatoriskt
delta	string	Ett segment med Base64-kodade svarsljudbyte. Begränsningar: kodning: base64	Ja
sequence_number	integer	Ett sekvensnummer för det här segmentet av dataströmsvaret.	Ja
type	enum	Typen av händelse. Alltid `response.audio.delta`. Möjliga värden: `response.audio.delta`	Ja

OpenAI.ResponseAudioDoneEvent

Genereras när ljudsvaret är klart.

Name	Type	Description	Obligatoriskt	Standardinställning
sequence_number	integer	Sekvensnumret för deltat.	Ja
type	enum	Typen av händelse. Alltid `response.audio.done`. Möjliga värden: `response.audio.done`	Ja

OpenAI.ResponseAudioTranscriptDeltaEvent

Genereras när det finns en partiell avskrift av ljud.

Name	Type	Description	Obligatoriskt
delta	string	Den partiella avskriften av ljudsvaret.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.audio.transcript.delta`. Möjliga värden: `response.audio.transcript.delta`	Ja

OpenAI.ResponseAudioTranscriptDoneEvent

Genereras när den fullständiga ljudavskriften har slutförts.

Name	Type	Description	Obligatoriskt	Standardinställning
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.audio.transcript.done`. Möjliga värden: `response.audio.transcript.done`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Genereras när ett partiellt kodfragment strömmas av kodtolkaren.

Name	Type	Description	Obligatoriskt
delta	string	Det partiella kodfragmentet som strömmas av kodtolkaren.	Ja
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	integer	Indexet för utdataobjektet i svaret som koden strömmas för.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen, som används för att beställa strömmande händelser.	Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call_code.delta`. Möjliga värden: `response.code_interpreter_call_code.delta`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Genereras när kodfragmentet slutförs av kodtolkaren.

Name	Type	Description	Obligatoriskt
code	string	Det slutliga utdatat från kodtolken för kodfragmentet.	Ja
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	integer	Indexet för utdataobjektet i svaret som koden har slutförts för.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen, som används för att beställa strömmande händelser.	Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call_code.done`. Möjliga värden: `response.code_interpreter_call_code.done`	Ja

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Genereras när kodtolkaranropet har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	integer	Indexet för utdataobjektet i svaret för vilket anropet till kodtolken har slutförts.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen, som används för att beställa strömmande händelser.	Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call.completed`. Möjliga värden: `response.code_interpreter_call.completed`	Ja

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Genereras när ett kodtolkaranrop pågår.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	integer	Indexet för utdataobjektet i svaret, för vilket kodtolkanropet pågår.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen, som används för att beställa strömmande händelser.	Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call.in_progress`. Möjliga värden: `response.code_interpreter_call.in_progress`	Ja

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Genereras när kodtolkaren aktivt tolkar kodfragmentet.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	integer	Indexet för utdataobjektet i svaret som kodtolkaren tolkar kod för.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen, som används för att beställa strömmande händelser.	Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call.interpreting`. Möjliga värden: `response.code_interpreter_call.interpreting`	Ja

OpenAI.ResponseCompletedEvent

Genereras när modellsvaret är klart.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– bakgrund	booleskt värde eller null		No
└– completed_at	sträng eller null (unixTimestamp)		No
└– content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
└– konversation	OpenAI.ConversationReference eller null		No
└– created_at	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError eller null		Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails eller null		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem eller null		Ja
└– max_output_tokens	heltal eller null		No
└– max_tool_calls	heltal eller null		No
└– metadata	OpenAI.Metadata eller null		No
└– modell	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng eller null		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng eller null		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
└– prompt_cache_retention	sträng eller null		No
└– resonemang	OpenAI.Reasoning eller null		No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	tal eller null		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	heltal eller null		No
└– top_p	tal eller null		No	1
└– trunkering	sträng eller null		No	funktionshindrad
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.completed`. Möjliga värden: `response.completed`	Ja

OpenAI.ResponseContentPartAddedEvent

Genereras när en ny innehållsdel läggs till.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för innehållsdelen som lades till.	Ja
item_id	string	ID:t för utdataobjektet som innehållsdelen lades till i.	Ja
output_index	integer	Indexet för utdataobjektet som innehållsdelen lades till i.	Ja
del	OpenAI.OutputContent		Ja
└– typ	OpenAI.OutputContentType		Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.content_part.added`. Möjliga värden: `response.content_part.added`	Ja

OpenAI.ResponseContentPartDoneEvent

Genereras när en innehållsdel är klar.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för innehållsdelen som är klar.	Ja
item_id	string	ID:t för utdataobjektet som innehållsdelen lades till i.	Ja
output_index	integer	Indexet för utdataobjektet som innehållsdelen lades till i.	Ja
del	OpenAI.OutputContent		Ja
└– typ	OpenAI.OutputContentType		Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.content_part.done`. Möjliga värden: `response.content_part.done`	Ja

OpenAI.ResponseCreatedEvent

En händelse som genereras när ett svar skapas.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– bakgrund	booleskt värde eller null		No
└– completed_at	sträng eller null (unixTimestamp)		No
└– content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
└– konversation	OpenAI.ConversationReference eller null		No
└– created_at	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError eller null		Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails eller null		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem eller null		Ja
└– max_output_tokens	heltal eller null		No
└– max_tool_calls	heltal eller null		No
└– metadata	OpenAI.Metadata eller null		No
└– modell	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng eller null		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng eller null		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
└– prompt_cache_retention	sträng eller null		No
└– resonemang	OpenAI.Reasoning eller null		No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	tal eller null		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	heltal eller null		No
└– top_p	tal eller null		No	1
└– trunkering	sträng eller null		No	funktionshindrad
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.created`. Möjliga värden: `response.created`	Ja

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Händelse som representerar ett delta (partiell uppdatering) till indata för ett anpassat verktygsanrop.

Name	Type	Description	Obligatoriskt
delta	string	Inkrementella indata (delta) för det anpassade verktygsanropet.	Ja
item_id	string	Unik identifierare för DET API-objekt som är associerat med den här händelsen.	Ja
output_index	integer	Indexet för utdata som deltat gäller för.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Händelsetypidentifieraren. Möjliga värden: `response.custom_tool_call_input.delta`	Ja

OpenAI.ResponseCustomToolCallInputDoneEvent

ResponseCustomToolCallInputDone

Händelse som anger att indata för ett anpassat verktygsanrop är slutfört.

Name	Type	Description	Obligatoriskt
Input	string	Fullständiga indata för det anpassade verktygsanropet.	Ja
item_id	string	Unik identifierare för DET API-objekt som är associerat med den här händelsen.	Ja
output_index	integer	Indexet för det resultat som denna händelse gäller för.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Händelsetypidentifieraren. Möjliga värden: `response.custom_tool_call_input.done`	Ja

OpenAI.ResponseError

Ett felobjekt som returneras när modellen inte genererar ett svar.

Name	Type	Description	Obligatoriskt	Standardinställning
code	OpenAI.ResponseErrorCode	Felkoden för svaret.	Ja
message	string	En läsbar beskrivning av felet.	Ja

OpenAI.ResponseErrorCode

Felkoden för svaret.

Property	Value
Type	string
Värden	`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

Genereras när ett fel inträffar.

Name	Type	Description	Obligatoriskt
code	sträng eller null		Ja
message	string	Felmeddelandet.	Ja
Param	sträng eller null		Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `error`. Möjliga värden: `error`	Ja

OpenAI.ResponseFailedEvent

En händelse som genereras när ett svar misslyckas.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– bakgrund	booleskt värde eller null		No
└– completed_at	sträng eller null (unixTimestamp)		No
└– content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
└– konversation	OpenAI.ConversationReference eller null		No
└– created_at	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError eller null		Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails eller null		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem eller null		Ja
└– max_output_tokens	heltal eller null		No
└– max_tool_calls	heltal eller null		No
└– metadata	OpenAI.Metadata eller null		No
└– modell	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng eller null		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng eller null		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
└– prompt_cache_retention	sträng eller null		No
└– resonemang	OpenAI.Reasoning eller null		No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	tal eller null		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	heltal eller null		No
└– top_p	tal eller null		No	1
└– trunkering	sträng eller null		No	funktionshindrad
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.failed`. Möjliga värden: `response.failed`	Ja

OpenAI.ResponseFileSearchCallCompletedEvent

Genereras när ett filsökningsanrop har slutförts (resultat hittades).

Name	Type	Description	Obligatoriskt
item_id	string	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	integer	Indexet för det utdataobjekt som initieras av filsökningsanropet.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.file_search_call.completed`. Möjliga värden: `response.file_search_call.completed`	Ja

OpenAI.ResponseFileSearchCallInProgressEvent

Genereras när ett filsökningsanrop initieras.

Name	Type	Description	Obligatoriskt
item_id	string	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	integer	Indexet för det utdataobjekt som initieras av filsökningsanropet.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.file_search_call.in_progress`. Möjliga värden: `response.file_search_call.in_progress`	Ja

OpenAI.ResponseFileSearchCallSearchingEvent

Genereras när en filsökning för närvarande söker.

Name	Type	Description	Obligatoriskt
item_id	string	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	integer	Indexet för utdataobjektet som filsökningsanropet söker efter.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.file_search_call.searching`. Möjliga värden: `response.file_search_call.searching`	Ja

OpenAI.ResponseFormatJsonSchemaSchema

JSON-schema

Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.

Typ: objekt

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Genereras när det finns ett partiellt funktionsanropsargument delta.

Name	Type	Description	Obligatoriskt
delta	string	Funktionsanropsargumentens delta som läggs till.	Ja
item_id	string	ID:t för utdataobjektet som deltat för funktionsanropsargument läggs till i.	Ja
output_index	integer	Indexet för det utdataobjekt som funktionsanropsargumenten delta läggs till i.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.function_call_arguments.delta`. Möjliga värden: `response.function_call_arguments.delta`	Ja

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Genereras när argumenten för funktionsanrop slutförs.

Name	Type	Description	Obligatoriskt
arguments	string	Argumenten för funktionsanrop.	Ja
item_id	string	Objektets ID.	Ja
name	string	Namnet på evenemanget som kallades.	Ja
output_index	integer	Indexet för utdataobjektet.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Möjliga värden: `response.function_call_arguments.done`	Ja

OpenAI.ResponseImageGenCallCompletedEvent

ResponseImageGenCallCompletedEvent

Genereras när ett bildgenereringsverktygsanrop har slutförts och den slutliga avbildningen är tillgänglig.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.image_generation_call.completed". Möjliga värden: `response.image_generation_call.completed`	Ja

OpenAI.ResponseImageGenCallGeneratingEvent

ResponsBildGenerRingGenereringHändelse

Genereras när ett verktygsanrop för bildgenerering aktivt genererar en avbildning (mellanliggande tillstånd).

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för det bildgenereringsobjekt som bearbetas.	Ja
type	enum	Typen av händelse. Alltid “response.image_generation_call.generating”. Möjliga värden: `response.image_generation_call.generating`	Ja

OpenAI.ResponseImageGenCallInProgressEvent

ResponseImageGenCallInProgressEvent

Genereras när ett avbildningsgenereringsverktygsanrop pågår.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för det bildgenereringsobjekt som bearbetas.	Ja
type	enum	Typen av händelse. Alltid "response.image_generation_call.in_progress". Möjliga värden: `response.image_generation_call.in_progress`	Ja

OpenAI.ResponseImageGenCallPartialImageEvent

ResponseImageGenCallPartialImageEvent

Genereras när en partiell avbildning är tillgänglig under direktuppspelning av bildgenerering.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
partial_image_b64	string	Base64-kodade partiella bilddata, lämpliga för återgivning som en bild.	Ja
partial_image_index	integer	0-baserat index för den partiella avbildningen (serverdelen är 1-baserad, men detta är 0-baserat för användaren).	Ja
sequence_number	integer	Sekvensnumret för det bildgenereringsobjekt som bearbetas.	Ja
type	enum	Typen av händelse. Alltid "response.image_generation_call.partial_image". Möjliga värden: `response.image_generation_call.partial_image`	Ja

OpenAI.ResponseInProgressEvent

Genereras när svaret pågår.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– bakgrund	booleskt värde eller null		No
└– completed_at	sträng eller null (unixTimestamp)		No
└– content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
└– konversation	OpenAI.ConversationReference eller null		No
└– created_at	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError eller null		Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails eller null		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem eller null		Ja
└– max_output_tokens	heltal eller null		No
└– max_tool_calls	heltal eller null		No
└– metadata	OpenAI.Metadata eller null		No
└– modell	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng eller null		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng eller null		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
└– prompt_cache_retention	sträng eller null		No
└– resonemang	OpenAI.Reasoning eller null		No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	tal eller null		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	heltal eller null		No
└– top_p	tal eller null		No	1
└– trunkering	sträng eller null		No	funktionshindrad
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.in_progress`. Möjliga värden: `response.in_progress`	Ja

OpenAI.ResponseIncompleteDetails

Name	Type	Description	Obligatoriskt	Standardinställning
reason	enum	Möjliga värden: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

En händelse som genereras när ett svar avslutas som ofullständigt.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– bakgrund	booleskt värde eller null		No
└– completed_at	sträng eller null (unixTimestamp)		No
└– content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
└– konversation	OpenAI.ConversationReference eller null		No
└– created_at	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError eller null		Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails eller null		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem eller null		Ja
└– max_output_tokens	heltal eller null		No
└– max_tool_calls	heltal eller null		No
└– metadata	OpenAI.Metadata eller null		No
└– modell	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng eller null		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng eller null		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
└– prompt_cache_retention	sträng eller null		No
└– resonemang	OpenAI.Reasoning eller null		No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	tal eller null		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	heltal eller null		No
└– top_p	tal eller null		No	1
└– trunkering	sträng eller null		No	funktionshindrad
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.incomplete`. Möjliga värden: `response.incomplete`	Ja

OpenAI.ResponseItemList

En lista över svarsobjekt.

Name	Type	Description	Obligatoriskt
data	matris med OpenAI.ItemResource	En lista över objekt som används för att generera det här svaret.	Ja
first_id	string	ID för det första objektet i listan.	Ja
har_mer	boolean	Om det finns fler tillgängliga objekt.	Ja
last_id	string	ID för det sista objektet i listan.	Ja
object	enum	Den typ av objekt som returneras måste vara `list`. Möjliga värden: `list`	Ja

OpenAI.ResponseLogProb

En logprob är den logaritmiska sannolikhet som modellen tilldelar för att producera en viss token vid en viss position i sekvensen. Mindre negativa (högre) logprob-värden indikerar större modellförtroende för det tokenvalet.

Name	Type	Description	Obligatoriskt
logprob	number	Loggens sannolikhet för denna token.	Ja
token	string	En möjlig texttoken.	Ja
top_logprobs	matris med OpenAI.ResponseLogProbTopLogprobs	Logsannolikheterna för upp till 20 av de mest sannolika tokens.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Obligatoriskt	Standardinställning
logprob	number		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

SvarMCPCallArgumentDeltaEvent

Genereras när det finns ett delta (partiell uppdatering) till argumenten för ett MCP-verktygsanrop.

Name	Type	Description	Obligatoriskt
delta	string	En JSON-sträng som innehåller den partiella uppdateringen av argumenten för MCP-verktygsanropet.	Ja
item_id	string	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.mcp_call_arguments.delta". Möjliga värden: `response.mcp_call_arguments.delta`	Ja

OpenAI.ResponseMCPCallArgumentsDoneEvent

SvarMCPCallArgumentsDoneEvent

Genereras när argumenten för ett MCP-verktygsanrop slutförs.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng som innehåller de slutgiltiga argumenten för MCP-verktygsanropet.	Ja
item_id	string	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.mcp_call_arguments.done". Möjliga värden: `response.mcp_call_arguments.done`	Ja

OpenAI.ResponseMCPCallCompletedEvent

ResponsMCPCallCompletedEvent

Genereras när ett MCP-verktygsanrop har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktyget anropar objektet som har slutförts.	Ja
output_index	integer	Indexet för den utdata som slutfördes.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid «response.mcp_call.completed». Möjliga värden: `response.mcp_call.completed`	Ja

OpenAI.ResponseMCPCallFailedEvent

ResponsMCPCallFailedEvent

Genereras när ett MCP-verktygsanrop har misslyckats.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktygets anropsobjekt som misslyckades.	Ja
output_index	integer	Indexet för utdataobjektet som misslyckades.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.mcp_call.failed". Möjliga värden: `response.mcp_call.failed`	Ja

OpenAI.ResponseMCPCallInProgressEvent

ResponsMCPCallInProgressEvent

Genereras när ett MCP-verktygsanrop pågår.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid ‘response.mcp_call.in_progress’. Möjliga värden: `response.mcp_call.in_progress`	Ja

OpenAI.ResponseMCPListToolsCompletedEvent

ResponseMCPListToolsCompletedEvent

Genereras när listan över tillgängliga MCP-verktyg har hämtats.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktyget anropar objektet som genererade dessa utdata.	Ja
output_index	integer	Indexet för den utgående post som behandlades.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid ”response.mcp_list_tools.completed”. Möjliga värden: `response.mcp_list_tools.completed`	Ja

OpenAI.ResponseMCPListToolsFailedEvent

ResponsMCPListToolsFailedEvent

Genereras när försöket att visa tillgängliga MCP-verktyg misslyckades.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktygets anropsobjekt som misslyckades.	Ja
output_index	integer	Indexet för utdataobjektet som misslyckades.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.mcp_list_tools.failed". Möjliga värden: `response.mcp_list_tools.failed`	Ja

OpenAI.ResponseMCPListToolsInProgressEvent

ResponseMCPListToolsInProgressEvent

Genereras när systemet håller på att hämta listan över tillgängliga MCP-verktyg.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	integer	Indexet för utdataobjektet som bearbetas.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.mcp_list_tools.in_progress". Möjliga värden: `response.mcp_list_tools.in_progress`	Ja

OpenAI.ResponseOutputItemAddedEvent

Genereras när ett nytt utdataobjekt läggs till.

Name	Type	Description	Obligatoriskt
item	OpenAI.OutputItem		Ja
└– typ	OpenAI.OutputItemType		Ja
output_index	integer	Indexet för utdataobjektet som lades till.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.output_item.added`. Möjliga värden: `response.output_item.added`	Ja

OpenAI.ResponseOutputItemDoneEvent

Genereras när ett utdataobjekt markeras som klart.

Name	Type	Description	Obligatoriskt
item	OpenAI.OutputItem		Ja
└– typ	OpenAI.OutputItemType		Ja
output_index	integer	Indexet för utdataobjektet som har markerats som gjort.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.output_item.done`. Möjliga värden: `response.output_item.done`	Ja

OpenAI.ResponseOutputTextAnnotationAddedEvent

ResponseOutputTextAnnotationAddedEvent

Genereras när en anteckning läggs till i utdatatextinnehållet.

Name	Type	Description	Obligatoriskt
Anteckning	OpenAI.Annotation	En anteckning som gäller för ett intervall med utdatatext.	Ja
└– typ	OpenAI.AnnotationType		Ja
annotation_index	integer	Indexet för anteckningen i innehållsdelen.	Ja
content_index	integer	Indexet för innehållsdelen i utdataobjektet.	Ja
item_id	string	Den unika identifieraren för det objekt som anteckningen läggs till i.	Ja
output_index	integer	Indexet för utdataobjektet i svarets utdatamatris.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.output_text.annotation.added". Möjliga värden: `response.output_text.annotation.added`	Ja

OpenAI.ResponsePromptVariables

Promptvariabler

Valfri karta av värden för att ersätta variabler i din uppmaning. Ersättningsvärdena kan antingen vara strängar eller andra typer av svarsindata som bilder eller filer.

Typ: objekt

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Genereras när ett svar placeras i kö och väntar på att bearbetas.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– bakgrund	booleskt värde eller null		No
└– completed_at	sträng eller null (unixTimestamp)		No
└– content_filters	matris med AzureContentFilterForResponsesAPI	Innehållsfiltret är resultatet från RAI.	No
└– konversation	OpenAI.ConversationReference eller null		No
└– created_at	heltal (Unixtime)	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError eller null		Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails eller null		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem eller null		Ja
└– max_output_tokens	heltal eller null		No
└– max_tool_calls	heltal eller null		No
└– metadata	OpenAI.Metadata eller null		No
└– modell	string	Modell-ID som används för att generera svaret, till exempel `gpt-4o` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestanda egenskaper och prispunkter. Se modellguiden för att bläddra och jämföra tillgängliga modeller.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng eller null		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng eller null		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` .	No
└– prompt_cache_retention	sträng eller null		No
└– resonemang	OpenAI.Reasoning eller null		No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:n ska vara en sträng som unikt identifierar varje användare, med en maximal längd på 64 tecken. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Begränsningar: maxLängd: 64	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	tal eller null		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: – Textindata och utdata – Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, som webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	heltal eller null		No
└– top_p	tal eller null		No	1
└– trunkering	sträng eller null		No	funktionshindrad
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk.	No
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid "response.queued". Möjliga värden: `response.queued`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEvent

Genereras när en ny sammanfattningsdel för resonemang läggs till.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för objektet som den här sammanfattningsdelen är associerad med.	Ja
output_index	integer	Indexet för utdataobjektet som den här sammanfattningsdelen är associerad med.	Ja
del	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Ja
└– text	string		Ja
└– typ	enum	Möjliga värden: `summary_text`	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
summary_index	integer	Indexet för sammanfattningsdelen i motiveringssammanfattningen.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_part.added`. Möjliga värden: `response.reasoning_summary_part.added`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Type	Description	Obligatoriskt	Standardinställning
text	string		Ja
type	enum	Möjliga värden: `summary_text`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEvent

Genereras när en sammanfattningsdel av resonemanget har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för objektet som den här sammanfattningsdelen är associerad med.	Ja
output_index	integer	Indexet för utdataobjektet som den här sammanfattningsdelen är associerad med.	Ja
del	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Ja
└– text	string		Ja
└– typ	enum	Möjliga värden: `summary_text`	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
summary_index	integer	Indexet för sammanfattningsdelen i motiveringssammanfattningen.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_part.done`. Möjliga värden: `response.reasoning_summary_part.done`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Type	Description	Obligatoriskt	Standardinställning
text	string		Ja
type	enum	Möjliga värden: `summary_text`	Ja

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Genereras när ett delta läggs till i en sammanfattningstext för resonemang.

Name	Type	Description	Obligatoriskt
delta	string	Textdeltat som har lagts till i sammanfattningen.	Ja
item_id	string	ID:t för objektet som den här sammanfattningstextdelten är associerad med.	Ja
output_index	integer	Indexet för utdataobjektet som det här sammanfattningstextdeltat är associerat med.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
summary_index	integer	Indexet för sammanfattningsdelen i motiveringssammanfattningen.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_text.delta`. Möjliga värden: `response.reasoning_summary_text.delta`	Ja

OpenAI.ResponseReasoningSummaryTextDoneEvent

Genereras när en sammanfattningstext för resonemanget har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för objektet som den här sammanfattningstexten är associerad med.	Ja
output_index	integer	Indexet för utdataobjektet som den här sammanfattningstexten är associerad med.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
summary_index	integer	Indexet för sammanfattningsdelen i motiveringssammanfattningen.	Ja
text	string	Den fullständiga texten i den slutförda motiveringssammanfattningen.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_text.done`. Möjliga värden: `response.reasoning_summary_text.done`	Ja

OpenAI.ResponseReasoningTextDeltaEvent

Genereras när ett delta läggs till i en resonemangstext.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för den resonemangsinnehållsdel som deltat är associerat med.	Ja
delta	string	Textdeltat som lades till i resonemangsinnehållet.	Ja
item_id	string	ID:t för objektet som det här textdeltat är associerat med.	Ja
output_index	integer	Indexet för utdataobjektet som det här textdeltat är associerat med.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_text.delta`. Möjliga värden: `response.reasoning_text.delta`	Ja

OpenAI.ResponseReasoningTextDoneEvent

Genereras när en resonemangstext har slutförts.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för resonemanginnehållet.	Ja
item_id	string	ID:t för objektet som den här resonemangstexten är associerad med.	Ja
output_index	integer	Indexet för det utdata som denna resonemangstext är kopplad till.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
text	string	Den fullständiga texten i det slutförda resonemangsinnehållet.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_text.done`. Möjliga värden: `response.reasoning_text.done`	Ja

OpenAI.ResponseRefusalDeltaEvent

Genereras när det finns en partiell avslagstext.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för innehållsdelen som avslagstexten läggs till i.	Ja
delta	string	Avslagstexten som läggs till.	Ja
item_id	string	ID för det utdataobjekt som avslagstexten läggs till i.	Ja
output_index	integer	Indexet för det utdataobjekt som avslagstexten läggs till i.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.refusal.delta`. Möjliga värden: `response.refusal.delta`	Ja

OpenAI.ResponseRefusalDoneEvent

Genereras när avslagstexten har slutförts.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för den innehållsdelen där texten som visar avslag har färdigställts.	Ja
item_id	string	ID för det utdataobjekt där avslagstexten slutförs.	Ja
output_index	integer	Indexet för det utdataobjekt som avslagstexten är slutförd.	Ja
vägran	string	Avslagstexten som har slutförts.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.refusal.done`. Möjliga värden: `response.refusal.done`	Ja

OpenAI.ResponseStreamEvent

Diskriminator för OpenAI.ResponseStreamEvent

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ResponseStreamEventType		Ja

OpenAI.ResponseStreamEventType

Property Value

Type string

Värden 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

Alternativ för direktuppspelningssvar. Ange endast detta när du anger stream: true.

Name	Type	Description	Obligatoriskt	Standardinställning
include_obfuscation	boolean	När det är sant aktiveras fördunkling av dataströmmar. Dataströmfördunkling lägger till slumpmässiga tecken till ett `obfuscation` fält vid strömmande deltahändelser till normalisera nyttolaststorlekar som en åtgärd för vissa sidokanalattacker. Dessa fördunklingsfält ingår som standard, men lägger till en liten mängd omkostnader för dataströmmen. Du kan ställa in `include_obfuscation` på false för att optimera bandbredden om du litar på nätverkslänkarna mellan ditt program och OpenAI-API:et.	No

OpenAI.ResponseTextDeltaEvent

Genereras när det finns ytterligare ett textdelta.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för innehållsdelen som textdeltat lades till i.	Ja
delta	string	Textdeltat som lades till.	Ja
item_id	string	ID:t för utdataobjektet som textdeltat lades till i.	Ja
logprobs	matris med OpenAI.ResponseLogProb	Loggannolikheterna för token i deltat.	Ja
output_index	integer	Indexet för utdataobjektet som textdeltat lades till i.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
type	enum	Typen av händelse. Alltid `response.output_text.delta`. Möjliga värden: `response.output_text.delta`	Ja

OpenAI.ResponseTextDoneEvent

Genereras när textinnehållet har slutförts.

Name	Type	Description	Obligatoriskt
content_index	integer	Indexet för innehållsdelen där textinnehållet har slutgiltiggjorts.	Ja
item_id	string	ID för utdataobjektet där textinnehållet har slutförts.	Ja
logprobs	matris med OpenAI.ResponseLogProb	Loggannolikheterna för token i deltat.	Ja
output_index	integer	Indexet för utdataobjektet där textinnehållet är slutfört.	Ja
sequence_number	integer	Sekvensnumret för den här händelsen.	Ja
text	string	Textinnehållet som har slutförts.	Ja
type	enum	Typen av händelse. Alltid `response.output_text.done`. Möjliga värden: `response.output_text.done`	Ja

OpenAI.ResponseTextParam

Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer:

Textinmatningar och utdata
Strukturerade utdata

Name	Type	Description	Obligatoriskt	Standardinställning
format	OpenAI.TextResponseFormatConfiguration	Ett objekt som anger det format som modellen måste mata ut. Konfigurera `{ "type": "json_schema" }` möjliggör strukturerade utdata, som säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i Standardformatet är `{ "type": "text" }` utan ytterligare alternativ. Rekommenderas inte för gpt-4o- och nyare modeller: Inställning som gör att `{ "type": "json_object" }` aktiverar det äldre JSON-läget, vilket ser till att meddelandet som modellen genererar är giltigt JSON. Att använda `json_schema` är att föredra för modeller som stöder det.	No
Informationsnivån	OpenAI.Verbosity	Begränsar utförligheten i modellens svar. Lägre värden resulterar i mer koncisa svar, medan högre värden resulterar i mer utförliga svar. Värden som stöds för närvarande är `low`, `medium`och `high`.	No

OpenAI.ResponseUsage

Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.

Name	Type	Description	Obligatoriskt
input_tokens	integer	Antalet indatatoken.	Ja
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Ja
└– cached_tokens	integer		Ja
output_tokens	integer	Antalet utdatatoken.	Ja
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Ja
└– reasoning_tokens	integer		Ja
total_tokens	integer	Det totala antalet token som används.	Ja

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Obligatoriskt	Standardinställning
cached_tokens	integer		Ja

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Obligatoriskt	Standardinställning
reasoning_tokens	integer		Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name	Type	Description	Obligatoriskt
item_id	string	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	integer	Indexet för det utdataobjekt som webbsökningsanropet är associerat med.	Ja
sequence_number	integer	Sekvensnumret för webbsökningsanropet som bearbetas.	Ja
type	enum	Typen av händelse. Alltid `response.web_search_call.completed`. Möjliga värden: `response.web_search_call.completed`	Ja

OpenAI.ResponseWebSearchCallInProgressEvent

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name	Type	Description	Obligatoriskt
item_id	string	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	integer	Indexet för det utdataobjekt som webbsökningsanropet är associerat med.	Ja
sequence_number	integer	Sekvensnumret för webbsökningsanropet som bearbetas.	Ja
type	enum	Typen av händelse. Alltid `response.web_search_call.in_progress`. Möjliga värden: `response.web_search_call.in_progress`	Ja

OpenAI.ResponseWebSearchCallSearchingEvent

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name	Type	Description	Obligatoriskt
item_id	string	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	integer	Indexet för det utdataobjekt som webbsökningsanropet är associerat med.	Ja
sequence_number	integer	Sekvensnumret för webbsökningsanropet som bearbetas.	Ja
type	enum	Typen av händelse. Alltid `response.web_search_call.searching`. Möjliga värden: `response.web_search_call.searching`	Ja

OpenAI.ScreenshotParam

Screenshot

En skärmbildsåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Anger händelsetypen. För en skärmbildsåtgärd är den här egenskapen alltid inställd på `screenshot`. Möjliga värden: `screenshot`	Ja	skärmbild

OpenAI.ScrollParam

Scroll

En scrollningsåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
keys	matris med sträng eller null		No
scroll_x	integer	Det vågräta rullningsavståndet.	Ja
scroll_y	integer	Det lodräta rullningsavståndet.	Ja
type	enum	Anger händelsetypen. För en rullningsåtgärd är den här egenskapen alltid inställd på `scroll`. Möjliga värden: `scroll`	Ja	Bläddra
x	integer	X-koordinaten där rullningen inträffade.	Ja
y	integer	y-koordinaten där scrollningen inträffade.	Ja

OpenAI.SearchContentType

Property	Value
Type	string
Värden	`text` `image`

OpenAI.SearchContextSize

Property	Value
Type	string
Värden	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Type	Description	Obligatoriskt	Standardinställning
skill_id	string	ID:t för den refererade färdigheten. Begränsningar: minLength: 1, maxLength: 64	Ja
type	enum	Refererar till en färdighet skapad med /v1/skills-ändpunkten. Möjliga värden: `skill_reference`	Ja	skill_reference
version	string	Valfri färdighetsversion. Använd ett positivt heltal eller 'senast'. Utelämna för standard.	No

OpenAI.SpecificApplyPatchParam

Specifikt val av applikationspatchverktyg

Tvingar modellen att anropa verktyget apply_patch när ett verktygsanrop körs.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Verktyget som ska anropas. Alltid `apply_patch`. Möjliga värden: `apply_patch`	Ja	apply_patch

OpenAI.SpecificFunctionShellParam

Specifikt val av skalverktyg

Tvingar modellen att anropa shell-verktyget när ett verktygsanrop krävs.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Verktyget som ska anropas. Alltid `shell`. Möjliga värden: `shell`	Ja	Skal

OpenAI.SummaryTextContent

Sammanfattningstext

En sammanfattningstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	En sammanfattning av resonemangets utdata från modellen hittills.	Ja
type	enum	Typ av objekt. Alltid `summary_text`. Möjliga värden: `summary_text`	Ja	summary_text

OpenAI.TextContent

Textinnehåll

Ett textinnehåll.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string		Ja
type	enum	Möjliga värden: `text`	Ja	text

OpenAI.TextResponseFormatConfiguration

Ett objekt som anger det format som modellen måste mata ut. Konfiguration { "type": "json_schema" } möjliggör strukturerade utdata, vilket säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i

Standardformatet är { "type": "text" } utan ytterligare alternativ. Rekommenderas inte för GPT-4o och nyare modeller: Att sätta på { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet modellen genererar är giltigt JSON. Att använda json_schema är att föredra för modeller som stöder det.

Diskriminerande för OpenAI.TextResponseFormatConfiguration

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.TextResponseFormatConfigurationType		Ja

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON-objekt

JSON-objektsvarsformat. En äldre metod för att generera JSON-svar. Användning json_schema rekommenderas för modeller som stöder det. Observera att modellen inte genererar JSON utan att ett system- eller användarmeddelande instruerar den att göra så.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_object`. Möjliga värden: `json_object`	Ja

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

Standardformat för svar. Används för att generera textsvar.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `text`. Möjliga värden: `text`	Ja

OpenAI.TextResponseFormatConfigurationType

Property	Value
Type	string
Värden	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

JSON-schema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar.

Name	Type	Description	Obligatoriskt
beskrivning	string	En beskrivning av vad svarsformatet är till för, som används av modellen för att bestämma hur man ska svara enligt formatet.	No
name	string	Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9 eller innehålla understreck och bindestreck, med en maximal längd på 64.	Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.	Ja
Strikt	booleskt värde eller null		No
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_schema`. Möjliga värden: `json_schema`	Ja

OpenAI.Tool

Ett verktyg som kan användas för att generera ett svar.

Discriminator för OpenAI.Tool

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ToolType		Ja

OpenAI.ToolChoiceAllowed

Tillåtna verktyg

Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning.

Name	Type	Description	Obligatoriskt
mode	enum	Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning. `auto` låter modellen välja bland de tillåtna verktygen och generera en meddelande. `required` kräver att modellen anropar ett eller flera av de tillåtna verktygen. Möjliga värden: `auto`, `required`	Ja
tools	matris med objekt	En lista över verktygsdefinitioner som modellen ska tillåtas anropa. För API:et Svar kan listan med verktygsdefinitioner se ut så här: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Ja
type	enum	Tillåten verktygskonfigurationstyp. Alltid `allowed_tools`. Möjliga värden: `allowed_tools`	Ja

OpenAI.ToolChoiceCodeInterpreter

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `code_interpreter`	Ja

OpenAI.ToolChoiceComputer

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `computer`	Ja

OpenAI.ToolChoiceComputerUse

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `computer_use`	Ja

OpenAI.ToolChoiceComputerUsePreview

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `computer_use_preview`	Ja

OpenAI.ToolChoiceCustom

Specialverktyg

Använd det här alternativet för att tvinga modellen att anropa ett specifikt anpassat verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
name	string	Namnet på det anpassade verktyg som ska anropas.	Ja
type	enum	För anpassade verktygsanrop är typen alltid `custom`. Möjliga värden: `custom`	Ja

OpenAI.ToolChoiceFileSearch

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `file_search`	Ja

OpenAI.ToolChoiceFunction

Funktionsverktyg

Använd det här alternativet för att tvinga modellen att anropa en specifik funktion.

Name	Type	Description	Obligatoriskt	Standardinställning
name	string	Namnet på funktionen som ska anropas.	Ja
type	enum	För funktionsanrop är typen alltid `function`. Möjliga värden: `function`	Ja

OpenAI.ToolChoiceImageGeneration

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `image_generation`	Ja

OpenAI.ToolChoiceMCP

MCP-verktyg

Använd det här alternativet för att tvinga modellen att anropa ett specifikt verktyg på en fjärr-MCP-server.

Name	Type	Description	Obligatoriskt
name	sträng eller null		No
serveretikett	string	Etiketten på DEN MCP-server som ska användas.	Ja
type	enum	För MCP-verktyg är typen alltid `mcp`. Möjliga värden: `mcp`	Ja

OpenAI.ToolChoiceOptions

Verktygsvalsläge

Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande. auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg. required innebär att modellen måste anropa ett eller flera verktyg.

Property	Value
Type	string
Värden	`none` `auto` `required`

OpenAI.ToolChoiceParam

Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas när ett svar genereras. Se parametern tools för att se hur du anger vilka verktyg som modellen kan anropa.

Diskriminerande för OpenAI.ToolChoiceParam

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	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	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ToolChoiceParamType		Ja

OpenAI.ToolChoiceParamType

Property	Value
Type	string
Värden	`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

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `web_search_preview`	Ja

OpenAI.ToolChoiceWebSearchPreview20250311

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `web_search_preview_2025_03_11`	Ja

OpenAI.ToolSearchExecutionType

Property	Value
Type	string
Värden	`server` `client`

OpenAI.ToolSearchToolParam

Verktygssökverktyg

Hostad eller BYOT-verktygssökningskonfiguration för uppskjutna verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
beskrivning	sträng eller null		No
avrättning	OpenAI.ToolSearchExecutionType		No
parameters	OpenAI.EmptyModelParam eller null		No
type	enum	Verktygets typ. Alltid `tool_search`. Möjliga värden: `tool_search`	Ja	tool_search

OpenAI.ToolType

Property	Value
Type	string
Värden	`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

En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern tool_choice . Vi stöder följande kategorier av verktyg:

Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI och som utökar modellens kapacitet, såsom webbsökning eller filsökning. Lär dig mer om inbyggda verktyg.
MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg.
Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, vilket gör att modellen kan anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.

Matris för: OpenAI.Tool

OpenAI.TopLogProb

Topplog-sannolikhet

Den högsta logaritmiska sannolikheten för en token.

Name	Type	Obligatoriskt
bytes	matris med heltal	Ja
logprob	number	Ja
token	string	Ja

OpenAI.TypeParam

Type

En åtgärd för att skriva in text.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Texten som ska skrivas.	Ja
type	enum	Anger händelsetypen. För en typåtgärd är den här egenskapen alltid inställd på `type`. Möjliga värden: `type`	Ja	type

OpenAI.UrlCitationBody

URL-citering

En källhänvisning för en webbresurs som används för att generera ett modellsvar.

Name	Type	Description	Obligatoriskt	Standardinställning
end_index	integer	Indexet för det sista tecknet i URL-källhänvisning i meddelandet.	Ja
start_index	integer	Indexet för det första tecknet i URL-källhänvisning i meddelandet.	Ja
title	string	Webbresursens rubrik.	Ja
type	enum	Typ av URL-källhänvisning. Alltid `url_citation`. Möjliga värden: `url_citation`	Ja	url_citation
url	Sträng (uri)	Url:en för webbresursen.	Ja

OpenAI.VectorStoreFileAttributes

Typ: objekt

OpenAI.Verbosity

Begränsar utförligheten i modellens svar. Lägre värden resulterar i mer koncisa svar, medan högre värden resulterar i mer utförliga svar. Värden som stöds för närvarande är low, mediumoch high.

Property	Value
Beskrivning	Begränsar utförligheten i modellens svar. Lägre värden resulterar i mer koncisa svar, medan högre värden resulterar i mer utförliga svar. Värden som stöds för närvarande är `low`, `medium`och `high`.
Type	string
Värden	`low` `medium` `high`

OpenAI.WaitParam

Wait

En väntåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Anger händelsetypen. För en vänta-åtgärd är den här egenskapen alltid inställd på `wait`. Möjliga värden: `wait`	Ja	wait

OpenAI.WebSearchActionFind

Hitta action

Åtgärdstyp "find_in_page": Söker efter ett mönster inom en laddad sida.

Name	Type	Description	Obligatoriskt
pattern	string	Det mönster eller den text som ska sökas efter på sidan.	Ja
type	enum	Åtgärdstypen. Möjliga värden: `find_in_page`	Ja
url	Sträng (uri)	Url:en för sidan sökte efter mönstret.	Ja

OpenAI.WebSearchActionOpenPage

Öppen sida-åtgärd

Åtgärdstyp "open_page" – Öppnar en specifik URL från sökresultat.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Åtgärdstypen. Möjliga värden: `open_page`	Ja
url	sträng eller null	URL som öppnades av modellen.	No

OpenAI.WebSearchActionSearch

Sökåtgärd

Åtgärdstyp "sök" – Utför en webbsökningsfråga.

Name	Type	Description	Obligatoriskt
queries	strängmatris	Sökfrågorna.	No
query	sträng (inaktuell)	[INAKTUELL] Sökfrågan.	Ja
Källor	matris med OpenAI.WebSearchActionSearchSources	Källorna som används i sökningen.	No
type	enum	Åtgärdstypen. Möjliga värden: `search`	Ja

OpenAI.WebSearchActionSearchSources

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `url`	Ja
url	Sträng (uri)		Ja

OpenAI.WebSearchApproximateLocation

Webbsökning ungefärlig plats

Användarens ungefärliga plats.

Name	Type	Description	Obligatoriskt	Standardinställning
Staden	sträng eller null		No
land	sträng eller null		No
region	sträng eller null		No
timezone	sträng eller null		No
type	enum	Typ av platsnärmning. Alltid `approximate`. Möjliga värden: `approximate`	Ja	Ungefärligt

OpenAI.WebSearchPreviewTool

Förhandsvisning av webbsökning

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name	Type	Description	Obligatoriskt	Standardinställning
search_content_types	array av OpenAI.SearchContentType		No
sök_kontextstorlek	OpenAI.SearchContextSize		No
type	enum	Typen av webbsökningsverktyg. En av `web_search_preview` eller `web_search_preview_2025_03_11`. Möjliga värden: `web_search_preview`	Ja	web_search_preview
användarplats	OpenAI.ApproximateLocation eller null		No

OpenAI.WebSearchTool

Webbsökning

Obs! web_search är ännu inte tillgängligt via Azure OpenAI.

Name	Type	Description	Obligatoriskt	Standardinställning
filters	OpenAI.WebSearchToolFilters eller null		No
sök_kontextstorlek	enum	Vägledning på hög nivå för hur mycket utrymme i kontextfönstret som ska användas för sökningen. En av `low`, `medium`eller `high`. `medium` används som standard. Möjliga värden: `low`, `medium`, `high`	No	medel
type	enum	Typen av webbsökningsverktyg. En av `web_search` eller `web_search_2025_08_26`. Möjliga värden: `web_search`	Ja	webbsökning
användarplats	OpenAI.WebSearchApproximateLocation eller null		No

OpenAI.WebSearchToolFilters

Name	Type	Description	Obligatoriskt	Standardinställning
allowed_domains	matris med sträng eller null		No

Last updated on 2026-07-10