Azure OpenAI risposte

Versione API: v1

Server:{endpoint}/openai/v1 — API Azure AI Foundry modelli

Variabili del server:

Variabile	Predefinito	Description
endpoint		Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Autenticazione

ApiKeyAuth (API Key)

Passa la chiave API nell'intestare api-key .

ApiKeyAuth_ (Chiave API)

Passa la chiave API nell'intestare authorization .

OAuth2Auth (OAuth 2.0)

Flusso: implicito

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

Ambiti:

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

Requisiti di sicurezza

Gli endpoint accettano uno qualsiasi dei seguenti metodi di autenticazione:

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

Creare una risposta

POST {endpoint}/openai/v1/responses

Crea una risposta del modello.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	server	Sì	string	Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-version	query	No	string Valori possibili: `v1`, `preview`	Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta. `v1` se non specificato diversamente.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio
sfondo	booleano o null		No
context_management	array di OpenAI.ContextManagementParam o null	Configurazione della gestione contestuale per questa richiesta.	No
conversazione	OpenAI.ConversationParam o null		No
Includono	matrice di OpenAI.IncludeEnum o null		No
input	OpenAI.InputParam	Input di testo, immagine o file nel modello, usato per generare una risposta. Ulteriori informazioni: - Input e output testuali - Input immagine - Input file - Stato della conversazione - Chiamata di funzione	No
instructions	stringa o null		No
max_output_tokens	integer o null		No
max_tool_calls	integer o null		No
metadata	OpenAI.Metadata o Null		No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
chiamate_parallele_agli_strumenti	booleano o null		No
previous_response_id	stringa o null		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
prompt_cache_retention	stringa o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
store	booleano o null		No
stream	booleano o null		No
stream_options	OpenAI.ResponseStreamOptions o null		No
Temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Le due categorie di strumenti che è possibile fornire al modello sono: - Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca di file. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice.	No
top_logprobs	integer o null		No
top_p	number o null		No
truncation	stringa o null		No
user	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object
text/event-stream	object

Name	Type	Description	Obbligatorio	Predefinito
sfondo	booleano o null		No
completed_at	stringa o null		No
content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
conversazione	OpenAI.ConversationReference o Null		No
creato_il	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
error	OpenAI.ResponseError o null		Sì
id	string	Identificatore univoco per questa risposta.	Sì
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sì
instructions	stringa o matrice di OpenAI.InputItem o null		Sì
max_output_tokens	integer o null		No
max_tool_calls	integer o null		No
metadata	OpenAI.Metadata o Null		No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
object	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
output	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
output_text	stringa o null		No
chiamate_parallele_agli_strumenti	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
previous_response_id	stringa o null		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
prompt_cache_retention	stringa o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
Stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
top_logprobs	integer o null		No
top_p	number o null		No
truncation	stringa o null		No
uso	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
user	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Obbligatorio
codice	stringa o null	Sì
inner_error		No
message	string	Sì
param	stringa o null	No
type	string	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Examples

Example

Creare una risposta al modello

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

Ottenere la risposta

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

Recupera una risposta del modello con l'ID specificato.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	server	Sì	string	Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-version	query	No	string Valori possibili: `v1`, `preview`	Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta. `v1` se non specificato diversamente.
response_id	path	Sì	string
include[]	query	No	matrice	Campi aggiuntivi da includere nella risposta. Per altre informazioni, vedere il parametro di inclusione per la creazione della risposta precedente.
stream	query	No	boolean	Se impostato su true, i dati di risposta del modello verranno trasmessi al client durante la generazione tramite eventi inviati dal server. Serializzazione: esplode: falso
starting_after	query	No	intero (int32)	Numero di sequenza dell'evento dopo il quale avviare lo streaming. Serializzazione: esplode: falso
include_obfuscation	query	No	boolean	Se true, l'offuscamento del flusso verrà abilitato. L'offuscamento del flusso aggiunge caratteri casuali a un `obfuscation` campo sugli eventi delta di streaming per normalizzare le dimensioni del payload come mitigazione di determinati attacchi sul canale laterale. Questi campi offuscamento sono inclusi per impostazione predefinita, ma aggiungono una piccola quantità di overhead al flusso di dati. È possibile impostare su `include_obfuscation` false per ottimizzare la larghezza di banda se si considera attendibile i collegamenti di rete tra l'applicazione e l'API OpenAI. Serializzazione: esplode: falso

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Description	Obbligatorio	Predefinito
sfondo	booleano o null		No
completed_at	stringa o null		No
content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
conversazione	OpenAI.ConversationReference o Null		No
creato_il	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
error	OpenAI.ResponseError o null		Sì
id	string	Identificatore univoco per questa risposta.	Sì
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sì
instructions	stringa o matrice di OpenAI.InputItem o null		Sì
max_output_tokens	integer o null		No
max_tool_calls	integer o null		No
metadata	OpenAI.Metadata o Null		No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
object	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
output	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
output_text	stringa o null		No
chiamate_parallele_agli_strumenti	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
previous_response_id	stringa o null		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
prompt_cache_retention	stringa o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
Stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
top_logprobs	integer o null		No
top_p	number o null		No
truncation	stringa o null		No
uso	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
user	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Obbligatorio
codice	stringa o null	Sì
inner_error		No
message	string	Sì
param	stringa o null	No
type	string	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Eliminare la risposta

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

Elimina una risposta in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	server	Sì	string	Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-version	query	No	string Valori possibili: `v1`, `preview`	Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta. `v1` se non specificato diversamente.
response_id	path	Sì	string

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Description	Obbligatorio
cancellato	enum	Valori possibili: `True`	Sì
id	string		Sì
object	enum	Valori possibili: `response.deleted`	Sì

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Obbligatorio
codice	stringa o null	Sì
inner_error		No
message	string	Sì
param	stringa o null	No
type	string	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Annulla risposta

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

Annulla una risposta del modello con l'ID specificato. È possibile annullare solo le risposte create con il parametro in background impostato su true.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	server	Sì	string	Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-version	query	No	string Valori possibili: `v1`, `preview`	Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta. `v1` se non specificato diversamente.
response_id	path	Sì	string

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Description	Obbligatorio	Predefinito
sfondo	booleano o null		No
completed_at	stringa o null		No
content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
conversazione	OpenAI.ConversationReference o Null		No
creato_il	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
error	OpenAI.ResponseError o null		Sì
id	string	Identificatore univoco per questa risposta.	Sì
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sì
instructions	stringa o matrice di OpenAI.InputItem o null		Sì
max_output_tokens	integer o null		No
max_tool_calls	integer o null		No
metadata	OpenAI.Metadata o Null		No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
object	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
output	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
output_text	stringa o null		No
chiamate_parallele_agli_strumenti	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
previous_response_id	stringa o null		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
prompt_cache_retention	stringa o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
Stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
top_logprobs	integer o null		No
top_p	number o null		No
truncation	stringa o null		No
uso	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
user	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Obbligatorio
codice	stringa o null	Sì
inner_error		No
message	string	Sì
param	stringa o null	No
type	string	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Elencare gli elementi di input

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

Restituisce un elenco di elementi di input per una determinata risposta.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	server	Sì	string	Un endpoint supportato per le API di Azure AI Foundry Models, inclusi protocollo e nome host. Per esempio: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
api-version	query	No	string Valori possibili: `v1`, `preview`	Versione esplicita dell'API Azure AI Foundry Models da usare per questa richiesta. `v1` se non specificato diversamente.
response_id	path	Sì	string
limit	query	No	intero (int32)	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. Serializzazione: esplode: falso
order	query	No	string Valori possibili: `asc`, `desc`	Ordinare l'ordinamento in base al `created_at` timestamp degli oggetti. `asc` per l'ordine crescente e`desc` per ordine decrescente. Serializzazione: esplode: falso
dopo	query	No	string	Cursore da usare nella paginazione. `after` è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, allora il La chiamata successiva può contenere after=obj_foo per ottenere la pagina successiva dell'elenco. Serializzazione: esplode: falso
before	query	No	string	Cursore da usare nella paginazione. `before` è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, allora il la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco. Serializzazione: esplode: falso

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ResponseItemList

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	object

Name	Type	Obbligatorio
codice	stringa o null	Sì
inner_error		No
message	string	Sì
param	stringa o null	No
type	string	No

Intestazioni di risposta:

Intestazione	Type	Description
apim-request-id	string	ID richiesta usato per la risoluzione dei problemi.

Components

AzureAIFoundryModelsApiVersion

Proprietà	Value
Type	string
Valori	`v1` `preview`

AzureContentFilterBlocklistResult

Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati.

Name	Type	Description	Obbligatorio	Predefinito
details	matrice di oggetti	Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro.	No
filtered	boolean	Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro.	Sì

AzureContentFilterCompletionTextSpan

Rappresentazione di uno spezzone di testo completato utilizzata nei risultati del filtro dei contenuti di Azure OpenAI.

Name	Type	Description	Obbligatorio	Predefinito
completion_end_offset	intero (int32)	Offset del primo punto di codice UTF32 escluso dall'intervallo. Questo campo è sempre uguale a completion_start_offset per le campate vuote. Questo campo è sempre più grande di completion_start_offset per intervalli non vuoti.	Sì
completion_start_offset	intero (int32)	Offset rispetto al punto di codice UTF32 che inizia la campata.	Sì

AzureContentFilterCompletionTextSpanDetectionResult

Name	Type	Description	Obbligatorio
details	matrice di AzureContentFilterCompletionTextSpan	Informazioni dettagliate sugli intervalli di testo di completamento rilevati.	Sì
detected	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì

AzureContentFilterCustomTopicResult

Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati.

Name	Type	Description	Obbligatorio	Predefinito
details	matrice di oggetti	Coppie di ID singoli argomenti e se vengono rilevate.	No
filtered	boolean	Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro.	Sì

AzureContentFilterDetectionResult

Elemento del risultato del filtro contenuto con etichetta che indica se il contenuto è stato rilevato e se il contenuto è stato filtrato.

Name	Type	Description	Obbligatorio	Predefinito
detected	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì

AzureContentFilterForResponsesAPI

Name	Type	Description	Obbligatorio
Bloccato	boolean	Indicare se la risposta è bloccata.	Sì
content_filter_offsets	AzureContentFilterResultOffsets		Sì
content_filter_results	AzureContentFilterResultsForResponsesAPI		Sì
└─ liste_blocchi_personalizzate	AzureContentFilterBlocklistResult	Raccolta di risultati di filtro binario per gli elenchi di blocchi personalizzati configurati.	No
└custom_topics	AzureContentFilterCustomTopicResult	Raccolta di risultati di filtro binario per gli argomenti personalizzati configurati.	No
└─ Errore	object	Se presente, vengono fornite informazioni dettagliate su un errore che impediva il completamento della valutazione del filtro del contenuto.	No
└─ codice	intero (int32)	Codice distinto e leggibile dal computer associato all'errore.	Sì
└* messaggio	string	Messaggio leggibile associato all'errore.	Sì
└> odio	AzureContentFilterSeverityResult	Categoria di filtro contenuto che può fare riferimento a qualsiasi contenuto che attacca o usa pejorative o discriminatorio lingua con riferimento a una persona o a un gruppo di identità in base a determinati attributi di differenziazione di questi gruppi incluso, ma non limitato alla razza, etnia, nazionalità, identità di genere ed espressione, orientamento sessuale, religione, stato di immigrazione, stato abilità, aspetto personale, e dimensioni del corpo.	No
└attacco indiretto	AzureContentFilterDetectionResult	Risultato del rilevamento che descrive gli attacchi ai sistemi basati su modelli di intelligenza artificiale generativi che possono verificarsi ogni volta un'applicazione elabora le informazioni che non sono stati creati direttamente dallo sviluppatore dell'applicazione o l'utente.	No
└* jailbreak	AzureContentFilterDetectionResult	Risultato del rilevamento che descrive gli attacchi di tipo prompt degli utenti, in cui gli utenti malintenzionati sfruttano deliberatamente vulnerabilità di sistema per l'annullamento di comportamenti non autorizzati da LLM. Ciò potrebbe causare contenuti inappropriati generazione o violazioni delle restrizioni imposte dal sistema.	Sì
└personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Risultato del rilevamento che descrive le corrispondenze con informazioni personali con sottocategorie configurabili.	No
└* volgarità	AzureContentFilterDetectionResult	Risultato di rilevamento che identifica se il linguaggio grezzo, volgare o in altro modo obiezione è presente nel Contenuto.	No
└protected_material_code	object	Risultato del rilevamento che descrive una corrispondenza rispetto al codice concesso in licenza o ad altri materiali di origine protetti.	No
└─ Citazione	object	Se disponibile, i dettagli della citazione che descrivono la licenza associata e la relativa posizione.	No
└─ URL	stringa (uri)	URL associato alla licenza.	No
└─ licenza	string	Nome o identificatore della licenza associata al rilevamento.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
└protected_material_text	AzureContentFilterDetectionResult	Risultato del rilevamento che descrive una corrispondenza con il testo protetto da copyright o altro stato.	No
└─ autolesionismo	AzureContentFilterSeverityResult	Categoria di filtro del contenuto che descrive il linguaggio correlato alle azioni fisiche destinate a ferire intenzionalmente, ferire, danneggiare il corpo o uccidersi.	No
└─ sessuale	AzureContentFilterSeverityResult	Una categoria di filtro del contenuto per il linguaggio correlato a organi anatomici e genitali, relazioni romantiche, atti ritratto in termini erotici o affettuosi, gravidanza, atti sessuali fisici, compresi quelli rappresentati come un aggressione o atto violento sessuale forzato contro la volontà, la prostituzione, la pornografia e l'abuso.	No
└task_adherence	AzureContentFilterDetectionResult	Risultato del rilevamento che indica se il flusso di esecuzione continua a mantenere il piano.	Sì
└ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
└* violenza	AzureContentFilterSeverityResult	Categoria di filtro del contenuto per la lingua correlata alle azioni fisiche destinate a ferire, ferire, danneggiare o uccidere qualcuno o qualcosa; descrive armi, armi e entità correlate, ad esempio fabbricazioni, associazioni, legislazione, e così via.	No
tipo_sorgente	string	Nome del tipo di origine del messaggio.	Sì
tool_call_id	string	L'ID della chiamata allo strumento associata a questo filtro di contenuto risulta, se applicabile.	No

AzureContentFilterPersonallyIdentifiableInformationResult

Risultato del rilevamento del filtro del contenuto per informazioni personali che includono estensioni dannose.

Name	Type	Description	Obbligatorio
detected	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
redacted_text	string	Testo scritto con informazioni personali rimosse o mascherate.	No
sub_categories	matrice di AzurePiiSubCategoryResult	Risultati dettagliati per singoli PIIHarmSubCategory.	No

AzureContentFilterResultOffsets

Name	Type	Obbligatorio
check_offset	intero (int32)	Sì
end_offset	intero (int32)	Sì
start_offset	intero (int32)	Sì

AzureContentFilterResultsForResponsesAPI

Name	Type	Description	Obbligatorio
custom_blocklists	AzureContentFilterBlocklistResult	Raccolta di risultati di filtro true/false per gli elenchi di blocchi personalizzati configurati.	No
└* dettagli	matrice di oggetti	Coppie di ID elenco di blocchi singoli e se hanno generato un'azione di filtro.	No
└* filtrato	boolean	Valore che indica se l'elenco di blocchi ha generato un'azione di filtro.	Sì
└* id	string	ID dell'elenco di blocchi personalizzato valutato.	Sì
└* filtrato	boolean	Valore che indica se uno degli elenchi di blocchi dettagliati ha generato un'azione di filtro.	Sì
custom_topics	AzureContentFilterCustomTopicResult	Raccolta di risultati di filtro true/false per gli argomenti personalizzati configurati.	No
└* dettagli	matrice di oggetti	Coppie di ID singoli argomenti e se vengono rilevate.	No
└> rilevato	boolean	Valore che indica se l'argomento viene rilevato.	Sì
└* id	string	ID dell'argomento personalizzato valutato.	Sì
└* filtrato	boolean	Valore che indica se uno degli argomenti dettagliati ha generato un'azione di filtro.	Sì
error	object	Se presente, vengono fornite informazioni dettagliate su un errore che impediva il completamento della valutazione del filtro del contenuto.	No
└─ codice	intero (int32)	Codice distinto e leggibile dal computer associato all'errore.	Sì
└* messaggio	string	Messaggio leggibile associato all'errore.	Sì
hate	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
indirect_attack	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
jailbreak	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	Sì
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Risultato del rilevamento del filtro del contenuto per informazioni personali che includono estensioni dannose.	No
└ redacted_text	string	Testo scritto con informazioni personali rimosse o mascherate.	No
└ sotto_categorie	matrice di AzurePiiSubCategoryResult	Risultati dettagliati per singoli PIIHarmSubCategory.	No
profanity	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
protected_material_code	object	Risultato del rilevamento che descrive una corrispondenza rispetto al codice concesso in licenza o ad altri materiali di origine protetti.	No
└─ Citazione	object	Se disponibile, i dettagli della citazione che descrivono la licenza associata e la relativa posizione.	No
└─ URL	stringa (uri)	URL associato alla licenza.	No
└─ licenza	string	Nome o identificatore della licenza associata al rilevamento.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
protected_material_text	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	No
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
self_harm	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
sexual	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì
task_adherence	AzureContentFilterDetectionResult	Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato rilevato e se è presente. Filtrata.	Sì
└> rilevato	boolean	Indica se la categoria di contenuto etichettata è stata rilevata nel contenuto.	Sì
└* filtrato	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto.	Sì
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violence	AzureContentFilterSeverityResult	Elemento risultato filtro contenuto etichettato che indica se il contenuto è stato filtrato e quali sono i valori qualitativi il livello di gravità del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.	No
└* filtrato	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
└> gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì

AzureContentFilterSeverityResult

Elemento del risultato del filtro contenuto etichettato che indica se il contenuto è stato filtrato e quale livello di gravità qualitativo del contenuto è stato valutato in base alla configurazione del filtro contenuto per la categoria.

Name	Type	Description	Obbligatorio	Predefinito
filtered	boolean	Indica se la gravità del contenuto ha generato un'azione di filtro del contenuto.	Sì
Gravità	enum	La gravità etichettata del contenuto. Valori possibili: `safe`, `low`, `medium`, `high`	Sì

AzurePiiSubCategoryResult

Dettagli dei risultati per singoli PIIHarmSubCategory.Result details for individual PIIHarmSubCategory(s).

Name	Type	Description	Obbligatorio
detected	boolean	Indica se la sottocategoria contenuto etichettata è stata rilevata nel contenuto.	Sì
filtered	boolean	Indica se il rilevamento del contenuto ha generato un'azione di filtro del contenuto per questa sottocategoria.	Sì
Redatto	boolean	Indica se il contenuto è stato redatto per questa sottocategoria.	Sì
sub_category	string	PIIHarmSubCategory valutato.	Sì

AzureToolApprovalRequest

Richiesta di approvazione dello strumento Azure

Una richiesta di approvazione dello strumento Azure nell'output della risposta.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON di argomenti per lo strumento.	Sì
call_id	string	L'ID della chiamata dello strumento che richiede approvazione.	Sì
id	string	ID univoco della richiesta di approvazione.	Sì
label	string	L'etichetta dello strumento (ad esempio, 'remote_functions').	Sì
nome	string	Il nome della funzione dello strumento (ad esempio, 'output_binding').	Sì
type	enum	Tipo dell'elemento. Sempre `tool_approval_request`. Valori possibili: `tool_approval_request`	Sì

AzureToolApprovalResponse

Risposta all'approvazione dello strumento Azure

Una risposta all'approvazione dello strumento Azure nell'input della richiesta.

Name	Type	Description	Obbligatorio
approval_request_id	string	ID della richiesta di approvazione a cui si sta rispondendo.	Sì
approve	boolean	Indica se la richiesta è stata approvata.	Sì
type	enum	Tipo dell'elemento. Sempre `tool_approval_response`. Valori possibili: `tool_approval_response`	Sì

OpenAI.Annotation

Annotazione applicabile a un intervallo di testo di output.

Discriminare per OpenAI.Annotation

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.AnnotationType		Sì

OpenAI.AnnotationType

Proprietà	Value
Type	string
Valori	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Proprietà	Value
Type	string
Valori	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Applica lo stato di uscita della chiamata patch

Valori dei risultati segnalati per gli output delle chiamate dello strumento apply_patch.

Proprietà	Value
Type	string
Valori	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Proprietà	Value
Type	string
Valori	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Applica lo stato della chiamata di patch

Valori di stato segnalati per le chiamate degli strumenti apply_patch.

Proprietà	Value
Type	string
Valori	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Applicare l'operazione di creazione di file patch

Istruzioni che descrivono come creare un file tramite lo strumento apply_patch.

Name	Type	Description	Obbligatorio	Predefinito
Diff	string	Diff da applicare.	Sì
path	string	Percorso del file da creare.	Sì
type	enum	Creare un nuovo file con la diff fornita. Valori possibili: `create_file`	Sì	create_file

OpenAI.ApplyPatchCreateFileOperationParam

Applicare l'operazione di creazione di file patch

Istruzioni per la creazione di un nuovo file tramite lo strumento apply_patch.

Name	Type	Description	Obbligatorio	Predefinito
Diff	string	Contenuto diff unificato da applicare durante la creazione del file. Vincoli: maxLength: 10485760	Sì
path	string	Percorso del file da creare in relazione alla radice dell'area di lavoro. Vincoli: minLength: 1	Sì
type	enum	Tipo di operazione. Sempre `create_file`. Valori possibili: `create_file`	Sì	create_file

OpenAI.ApplyPatchDeleteFileOperation

Applicare l'operazione di cancellazione file tramite patch

Istruzioni che descrivono come eliminare un file tramite lo strumento apply_patch.

Name	Type	Description	Obbligatorio	Predefinito
path	string	Percorso del file da eliminare.	Sì
type	enum	Eliminare il file specificato. Valori possibili: `delete_file`	Sì	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Applicare l'operazione di cancellazione file tramite patch

Istruzioni per eliminare un file esistente tramite lo strumento apply_patch.

Name	Type	Description	Obbligatorio	Predefinito
path	string	Percorso del file da eliminare rispetto alla radice dell'area di lavoro. Vincoli: minLength: 1	Sì
type	enum	Tipo di operazione. Sempre `delete_file`. Valori possibili: `delete_file`	Sì	delete_file

OpenAI.ApplyPatchFileOperation

Applicare l'operazione con la patch

Una delle operazioni di create_file, delete_file o update_file applicate tramite apply_patch.

Discriminare per OpenAI.ApplyPatchFileOperation

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ApplyPatchFileOperationType		Sì

OpenAI.ApplyPatchFileOperationType

Proprietà	Value
Type	string
Valori	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Applicare l'operazione con la patch

Una delle operazioni di create_file, delete_file o update_file fornite allo strumento di apply_patch.

Discriminatorio per OpenAI.ApplyPatchOperationParam

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ApplyPatchOperationParamType		Sì

OpenAI.ApplyPatchOperationParamType

Proprietà	Value
Type	string
Valori	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Applica lo strumento di patch

Consente all'assistente di creare, eliminare o aggiornare i file usando differenze unificate.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo dello strumento. Sempre `apply_patch`. Valori possibili: `apply_patch`	Sì	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Applica l'operazione di aggiornamento del file patch

Istruzioni che descrivono come aggiornare un file tramite lo strumento apply_patch.

Name	Type	Description	Obbligatorio	Predefinito
Diff	string	Diff da applicare.	Sì
path	string	Percorso del file da aggiornare.	Sì
type	enum	Aggiornare un file esistente con la diff fornita. Valori possibili: `update_file`	Sì	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Applica l'operazione di aggiornamento del file patch

Istruzioni per l'aggiornamento di un file esistente tramite lo strumento apply_patch.

Name	Type	Description	Obbligatorio	Predefinito
Diff	string	Contenuto diff unificato da applicare al file esistente. Vincoli: maxLength: 10485760	Sì
path	string	Percorso del file da aggiornare rispetto alla radice dell'area di lavoro. Vincoli: minLength: 1	Sì
type	enum	Tipo di operazione. Sempre `update_file`. Valori possibili: `update_file`	Sì	update_file

OpenAI.PosizioneApprossimativa

Name	Type	Description	Obbligatorio	Predefinito
Città	stringa o null		No
paese	stringa o null		No
region	stringa o null		No
timezone	stringa o null		No
type	enum	Tipo di approssimazione della posizione. Sempre `approximate`. Valori possibili: `approximate`	Sì	approssimativa

OpenAI.AutoCodeInterpreterToolParam

Parametri dello strumento Automatic Code Interpreter

Configurazione per un contenitore dell'interprete di codice. Facoltativamente, specificare gli ID dei file in cui eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
identificatori_di_file	matrice di valori string	Elenco facoltativo di file caricati da rendere disponibili al tuo codice. Vincoli: maxOggetti: 50	No
limite_di_memoria	OpenAI.ContainerMemoryLimit o null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Politica di accesso alla rete per il container.	No
type	enum	Sempre `auto`. Valori possibili: `auto`	Sì	auto

OpenAI.ClickButtonType

Proprietà	Value
Type	string
Valori	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Azione di fare clic.

Name	Type	Description	Obbligatorio	Predefinito
pulsante	OpenAI.ClickButtonType		Sì
keys	matrice di stringhe o null		No
type	enum	Specifica il tipo di evento. Per un'azione di clic, questa proprietà è sempre `click`. Valori possibili: `click`	Sì	click
x	integer	Coordinata x in cui si è verificato il clic.	Sì
y	integer	Coordinata y in cui si è verificato il clic.	Sì

OpenAI.CodeInterpreterOutputImage

Immagine di uscita dell'interprete di codice

Output dell'immagine dell'interprete di codice.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo dell'output. Sempre `image`. Valori possibili: `image`	Sì	image
url	stringa (uri)	URL dell'output dell'immagine dall'interprete di codice.	Sì

OpenAI.CodeInterpreterOutputLogs

Log di uscita dell'interprete di codice

Output dei log dall'interprete di codice.

Name	Type	Description	Obbligatorio	Predefinito
logs	string	Output dei log dall'interprete di codice.	Sì
type	enum	Tipo dell'output. Sempre `logs`. Valori possibili: `logs`	Sì	logs

OpenAI.CodeInterpreterTool

Interprete di codice

Strumento che esegue codice Python per generare una risposta a un prompt.

Name	Type	Description	Obbligatorio	Predefinito
container	o OpenAI.AutoCodeInterpreterToolParam	Contenitore dell'interprete di codice. Può essere un ID contenitore o un oggetto che specifica gli ID file caricati per rendere disponibile il codice, insieme a un impostazione facoltativa `memory_limit` .	Sì
type	enum	Tipo dello strumento dell'interprete di codice. Sempre `code_interpreter`. Valori possibili: `code_interpreter`	Sì

OpenAI.ComparisonFilter

Filtro di confronto

Filtro utilizzato per confrontare una chiave di attributo specificata con un determinato valore usando un'operazione di confronto definita.

Name	Type	Description	Obbligatorio	Predefinito
key	string	La chiave da confrontare rispetto al valore.	Sì
type	enum	Specifica l'operatore di confronto: `eq`, `negt`, `gte`, , `ltlte`, `innin`. - `eq`: uguale - `ne`: non uguale - `gt`:maggiore - `gte`: maggiore o uguale a - `lt`:meno di - `lte`: minore o uguale a - `in`:Pollici - `nin`: non in Valori possibili: `eq`, `ne`, `gtgte`, `lt`, `lte`, , `innin`	Sì	eq
value	stringa o numero o booleano o array di stringhe o numeri	Valore da confrontare con la chiave dell'attributo; supporta tipi stringa, numero o boolean.	Sì

OpenAI.CompoundFilter

Filtro composto

Combinare più filtri usando and o or.

Name	Type	Description	Obbligatorio	Predefinito
Filtri	matrice di oggetto o OpenAI.ComparisonFilter	Matrice di filtri da combinare. Gli elementi possono essere `ComparisonFilter` o `CompoundFilter`.	Sì
type	enum	Tipo di operazione: `and` o `or`. Valori possibili: `and`, `or`	Sì

OpenAI.ComputerAction

Discriminare per OpenAI.ComputerAction

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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	Obbligatorio	Predefinito
type	OpenAI.ComputerActionType		Sì

OpenAI.ComputerActionList

Lista delle Azioni Computerizzate

Azioni in lotta appiattite per computer_use. Ogni azione include un type discriminatore e campi specifici per ogni azione.

Array di: OpenAI.ComputerAction

OpenAI.ComputerActionType

Proprietà	Value
Type	string
Valori	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Controllo di sicurezza in sospeso per la chiamata computer.

Name	Type	Description	Obbligatorio
codice	stringa o null		No
id	string	ID del controllo di sicurezza in sospeso.	Sì
message	stringa o null		No

OpenAI.ComputerEnvironment

Proprietà	Value
Type	string
Valori	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

Screenshot del computer

Screenshot di un computer.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.ImageDetail		Sì
ID del file	stringa o null		Sì
image_url	stringa o null		Sì
type	enum	Specifica il tipo di evento. Per uno screenshot del computer, questa proprietà è sempre impostata su `computer_screenshot`. Valori possibili: `computer_screenshot`	Sì	computer_screenshot

OpenAI.ComputerScreenshotImage

Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer.

Name	Type	Description	Obbligatorio	Predefinito
ID del file	string	Identificatore di un file caricato che contiene lo screenshot.	No
image_url	stringa (uri)	URL dell'immagine di screenshot.	No
type	enum	Specifica il tipo di evento. Per uno screenshot del computer, questa proprietà è sempre impostato su `computer_screenshot`. Valori possibili: `computer_screenshot`	Sì	computer_screenshot

OpenAI.ComputerTool

Computer

Strumento che controlla un computer virtuale.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Il tipo di strumento informatico. Sempre `computer`. Valori possibili: `computer`	Sì	Computer

OpenAI.ComputerUsePreviewTool

Anteprima dell'uso del computer

Strumento che controlla un computer virtuale.

Name	Type	Description	Obbligatorio	Predefinito
altezza_schermo	integer	Altezza dello schermo del computer.	Sì
larghezza_display	integer	Larghezza della visualizzazione del computer.	Sì
environment	OpenAI.ComputerEnvironment		Sì
type	enum	Tipo dello strumento di utilizzo del computer. Sempre `computer_use_preview`. Valori possibili: `computer_use_preview`	Sì	computer_use_preview

OpenAI.ContainerAutoParam

Name	Type	Description	Obbligatorio	Predefinito
identificatori_di_file	matrice di valori string	Elenco facoltativo di file caricati da rendere disponibili al tuo codice. Vincoli: maxOggetti: 50	No
limite_di_memoria	OpenAI.ContainerMemoryLimit o null		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Politica di accesso alla rete per il container.	No
competenze	array di OpenAI.ContainerSkill	Un elenco opzionale delle abilità citate tramite id o dati inline. Vincoli: maxOggetti: 200	No
type	enum	Crea automaticamente un contenitore per questa richiesta Valori possibili: `container_auto`	Sì	container_auto

OpenAI.ContainerFileCitationBody

Citazione del file contenitore

Citazione per un file di contenitore usato per generare una risposta del modello.

Name	Type	Description	Obbligatorio	Predefinito
container_id	string	ID del file contenitore.	Sì
end_index	integer	Indice dell'ultimo carattere della citazione del file contenitore nel messaggio.	Sì
ID del file	string	L'ID del fascicolo.	Sì
filename	string	Nome file del file contenitore citato.	Sì
start_index	integer	Indice del primo carattere della citazione del file contenitore nel messaggio.	Sì
type	enum	Tipo di citazione del file contenitore. Sempre `container_file_citation`. Valori possibili: `container_file_citation`	Sì	container_file_citation

OpenAI.ContainerMemoryLimit

Proprietà	Value
Type	string
Valori	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Type	Description	Obbligatorio	Predefinito
allowed_domains	matrice di valori string	Un elenco di domini consentiti quando il tipo è `allowlist`. Vincoli: minOggetti: 1	Sì
type	enum	Consentire l'accesso alla rete in uscita solo a domini specifici. Sempre `allowlist`. Valori possibili: `allowlist`	Sì	allowlist

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Disabilita l'accesso alla rete in uscita. Sempre `disabled`. Valori possibili: `disabled`	Sì	disabled

OpenAI.ContainerNetworkPolicyParam

Politica di accesso alla rete per il container.

Discriminatore per OpenAI.ContainerNetworkPolicyParam

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ContainerNetworkPolicyParamType		Sì

OpenAI.ContainerNetworkPolicyParamType

Proprietà	Value
Type	string
Valori	`disabled` `allowlist`

OpenAI.ContainerReferenceResource

Riferimento del contenitore

Rappresenta un contenitore creato con i contenitori /v1/.

Name	Type	Description	Obbligatorio	Predefinito
container_id	string		Sì
type	enum	Tipo di ambiente. Sempre `container_reference`. Valori possibili: `container_reference`	Sì	container_reference

OpenAI.ContainerSkill

Discriminatore per OpenAI.ContainerSkill

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ContainerSkillType		Sì

OpenAI.ContainerSkillType

Proprietà	Value
Type	string
Valori	`skill_reference` `inline`

OpenAI.ContextManagementParam

Name	Type	Description	Obbligatorio	Predefinito
compact_threshold	integer o null		No
type	string	Il tipo di voce per la gestione del contesto. Attualmente è supportata solo la 'compattazione'.	Sì

OpenAI.ConversationParam

Conversazione a cui appartiene questa risposta. Gli elementi di questa conversazione vengono anteporti a input_items per questa richiesta di risposta. Gli elementi di input e gli elementi di output di questa risposta vengono aggiunti automaticamente a questa conversazione al termine della risposta.

Questo componente può essere uno dei seguenti:

string
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Oggetto della conversazione

Conversazione a cui appartiene questa risposta.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID univoco della conversazione.	Sì

OpenAI.ConversationReference

Conversazione

Conversazione a cui appartiene questa risposta. Gli elementi di input e gli elementi di output di questa risposta sono stati aggiunti automaticamente a questa conversazione.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID univoco della conversazione a cui è stata associata la risposta.	Sì

OpenAI.CoordParam

Coordinate

Coppia di coordinate x/y, ad esempio { x: 100, y: 200 }.

Name	Type	Description	Obbligatorio	Predefinito
x	integer	Coordinata x.	Sì
y	integer	Coordinata y.	Sì

OpenAI.CreateResponse

Name	Type	Description	Obbligatorio
sfondo	booleano o null		No
context_management	array di OpenAI.ContextManagementParam o null	Configurazione della gestione contestuale per questa richiesta.	No
conversazione	OpenAI.ConversationParam o null		No
Includono	matrice di OpenAI.IncludeEnum o null		No
input	OpenAI.InputParam	Input di testo, immagine o file nel modello, usato per generare una risposta. Ulteriori informazioni: - Input e output testuali - Input immagine - Input file - Stato della conversazione - Chiamata di funzione	No
instructions	stringa o null		No
max_output_tokens	integer o null		No
max_tool_calls	integer o null		No
metadata	OpenAI.Metadata o Null		No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
chiamate_parallele_agli_strumenti	booleano o null		No
previous_response_id	stringa o null		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
prompt_cache_retention	stringa o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
store	booleano o null		No
stream	booleano o null		No
stream_options	OpenAI.ResponseStreamOptions o null		No
Temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Le due categorie di strumenti che è possibile fornire al modello sono: - Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca di file. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice.	No
top_logprobs	integer o null		No
top_p	number o null		No
truncation	stringa o null		No
user	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No

OpenAI.CustomGrammarFormatParam

Formato grammaticale

Grammatica definita dall'utente.

Name	Type	Description	Obbligatorio	Predefinito
Definizione	string	Definizione della grammatica.	Sì
Sintassi	OpenAI.GrammarSyntax1		Sì
type	enum	Formato grammaticale. Sempre `grammar`. Valori possibili: `grammar`	Sì	Grammatica

OpenAI.CustomTextFormatParam

Formato testo

Testo in formato libero senza vincoli.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Formato di testo non vincolato. Sempre `text`. Valori possibili: `text`	Sì	text

OpenAI.CustomToolParam

Strumento personalizzato

Strumento personalizzato che elabora l'input usando un formato specificato. Scopri di più sugli strumenti personalizzati

Name	Type	Description	Obbligatorio	Predefinito
defer_loading	boolean	Se questo strumento debba essere rimandato e scoperto tramite la ricerca degli strumenti.	No
descrizione	string	Descrizione facoltativa dello strumento personalizzato, usata per fornire più contesto.	No
format	OpenAI.CustomToolParamFormat	Formato di input per lo strumento personalizzato. Il valore predefinito è testo non vincolato.	No
└─ Tipo	OpenAI.CustomToolParamFormatType		Sì
nome	string	Nome dello strumento personalizzato, usato per identificarlo nelle chiamate degli strumenti.	Sì
type	enum	Tipo dello strumento personalizzato. Sempre `custom`. Valori possibili: `custom`	Sì	custom

OpenAI.CustomToolParamFormat

Formato di input per lo strumento personalizzato. Il valore predefinito è testo non vincolato.

Discriminare per OpenAI.CustomToolParamFormat

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.CustomToolParamFormatType		Sì

OpenAI.CustomToolParamFormatType

Proprietà	Value
Type	string
Valori	`text` `grammar`

OpenAI.DetailEnum

Proprietà	Value
Type	string
Valori	`low` `high` `auto` `original`

OpenAI.DoubleClickAction

DoubleClick

Azione con doppio clic.

Name	Type	Description	Obbligatorio	Predefinito
keys	matrice di stringhe o null		Sì
type	enum	Specifica il tipo di evento. Per un'azione di doppio clic, questa proprietà è sempre impostata su `double_click`. Valori possibili: `double_click`	Sì	double_click
x	integer	Coordinata x in cui si è verificato il doppio clic.	Sì
y	integer	Coordinata y in cui si è verificato il doppio clic.	Sì

OpenAI.DragParam

Drag

Azione di trascinamento.

Name	Type	Description	Obbligatorio	Predefinito
keys	matrice di stringhe o null		No
path	array di OpenAI.CoordParam	Matrice di coordinate che rappresentano il percorso dell'azione di trascinamento. Le coordinate verranno visualizzate come matrice di oggetti, ad esempio `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Sì
type	enum	Specifica il tipo di evento. Per un'azione di trascinamento, questa proprietà è sempre impostata su `drag`. Valori possibili: `drag`	Sì	Resistenza

OpenAI.EasyInputMessage

Messaggio di input

Messaggio di input al modello con un ruolo che indica la gerarchia di esecuzione delle istruzioni. Le istruzioni fornite con il ruolo developer o system hanno la precedenza sulle istruzioni fornite con il ruolo user. Si presuppone che i messaggi con il assistant ruolo siano stati generati dal modello nelle interazioni precedenti.

Name	Type	Description	Obbligatorio
contenuto	string o OpenAI.InputMessageContentList	Input di testo, immagine o audio per il modello, usato per generare una risposta. Può anche contenere risposte di assistente precedenti.	Sì
Fase	OpenAI.MessagePhase o null		No
Ruolo	enum	Ruolo dell'inserimento del messaggio. Uno di `user`, `assistant`, `system`, o `developer`. Valori possibili: `user`, `assistant`, `system`, `developer`	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di input del messaggio. Sempre `message`. Valori possibili: `message`	Sì

OpenAI.EmptyModelParam

Tipo: oggetto

OpenAI.FileCitationBody

Citazione del fascicolo

Citazione in un file.

Name	Type	Description	Obbligatorio	Predefinito
ID del file	string	L'ID del fascicolo.	Sì
filename	string	Nome file del file citato.	Sì
index	integer	Indice del file nell'elenco di file.	Sì
type	enum	Tipo di citazione del file. Sempre `file_citation`. Valori possibili: `file_citation`	Sì	file_citation

OpenAI.FileInputDetail

Proprietà	Value
Type	string
Valori	`low` `high`

OpenAI.FilePath

Percorso file

Percorso di un file.

Name	Type	Description	Obbligatorio
ID del file	string	L'ID del fascicolo.	Sì
index	integer	Indice del file nell'elenco di file.	Sì
type	enum	Tipo del percorso del file. Sempre `file_path`. Valori possibili: `file_path`	Sì

OpenAI.FileSearchTool

Ricerca di file

Strumento che cerca il contenuto pertinente dai file caricati.

Name	Type	Description	Obbligatorio	Predefinito
Filtri	OpenAI.Filters o null		No
max_num_risultati	integer	Numero massimo di risultati da restituire. Questo numero deve essere compreso tra 1 e 50 inclusi.	No
opzioni_di_classifica	OpenAI.RankingOptions		No
└hybrid_search	OpenAI.HybridSearchOptions	Pesi che controllano il modo in cui la fusione tra rango reciproco bilancia le corrispondenze di incorporamento semantico e le corrispondenze di parole chiave sparse quando la ricerca ibrida è abilitata.	No
└* ranker	OpenAI.RankerVersionType	Ranker da usare per la ricerca di file.	No
└─ soglia_punteggio	Numero	Soglia del punteggio per la ricerca di file, un numero compreso tra 0 e 1. I numeri più vicini a 1 tenteranno di restituire solo i risultati più rilevanti, ma potrebbero restituire meno risultati.	No
type	enum	Tipo dello strumento di ricerca file. Sempre `file_search`. Valori possibili: `file_search`	Sì	file_search
vector_store_ids	matrice di valori string	ID degli archivi vettoriali da cercare.	Sì

OpenAI.FileSearchToolCallResults

Name	Type	Obbligatorio
attributes	OpenAI.VectorStoreFileAttributes o null	No
ID del file	string	No
filename	string	No
Punteggio	Numero (galleggiante)	No
text	string	No

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter o OpenAI.CompoundFilter

OpenAI.FunctionAndCustomToolCallOutput

Discriminare per OpenAI.FunctionAndCustomToolCallOutput

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.FunctionAndCustomToolCallOutputType		Sì

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

File di input

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.FileInputDetail		No
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa o null		No
file_url	stringa (uri)	URL del file da inviare al modello.	No
filename	string	Nome del file da inviare al modello.	No
type	enum	Tipo dell'elemento di input. Sempre `input_file`. Valori possibili: `input_file`	Sì	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Immagine di input

Un'immagine come input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.ImageDetail		Sì
ID del file	stringa o null		No
image_url	stringa o null		No
type	enum	Tipo dell'elemento di input. Sempre `input_image`. Valori possibili: `input_image`	Sì	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Testo di input

Input di testo per il modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Input di testo per il modello.	Sì
type	enum	Tipo dell'elemento di input. Sempre `input_text`. Valori possibili: `input_text`	Sì	input_text

OpenAI.FunctionAndCustomToolCallOutputType

Proprietà	Value
Type	string
Valori	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallOutputStatusEnum

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Azione dei dirigenti Shell

Eseguire un comando shell.

Name	Type	Obbligatorio
commands	matrice di valori string	Sì
max_output_length	integer o null	Sì
timeout_ms	integer o null	Sì

OpenAI.FunctionShellActionParam

Meccanismo a proiettili

Comandi e limiti che descrivono come eseguire la chiamata allo strumento shell.

Name	Type	Description	Obbligatorio
commands	matrice di valori string	Comandi della shell ordinati per l'esecuzione dell'ambiente di esecuzione.	Sì
max_output_length	integer o null		No
timeout_ms	integer o null		No

OpenAI.FunctionShellCallEnvironment

Discriminatore per OpenAI.FunctionShellCallEnvironment

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.FunctionShellCallEnvironmentType		Sì

OpenAI.FunctionShellCallEnvironmentType

Proprietà	Value
Type	string
Valori	`local` `container_reference`

OpenAI.FunctionShellCallItemParamEnvironment

L'ambiente in cui eseguire i comandi shell.

Discriminatore per OpenAI.FunctionShellCallItemParamEnvironment

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.FunctionShellCallItemParamEnvironmentType		Sì

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Name	Type	Description	Obbligatorio	Predefinito
container_id	string	L'ID del contenitore menzionato.	Sì
type	enum	Fa riferimento a un container creato con l'endpoint /v1/containers Valori possibili: `container_reference`	Sì	container_reference

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Name	Type	Description	Obbligatorio	Predefinito
competenze	array di OpenAI.LocalSkillParam	Una lista opzionale di abilità. Vincoli: maxOggetti: 200	No
type	enum	Usa un ambiente di computer locale. Valori possibili: `local`	Sì	local

OpenAI.FunctionShellCallItemParamEnvironmentType

Proprietà	Value
Type	string
Valori	`local` `container_reference`

OpenAI.FunctionShellCallItemStatus

Stato della chiamata shell

Valori di stato segnalati per le chiamate degli strumenti della shell.

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Contenuto di output delle chiamate shell

Contenuto di un output di chiamata dello strumento shell generato.

Name	Type	Description	Obbligatorio
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
risultato	OpenAI.FunctionShellCallOutputOutcome	Rappresenta un risultato di uscita (con un codice di uscita) o un risultato di timeout per un blocco di output della chiamata della shell.	Sì
└─ Tipo	OpenAI.FunctionShellCallOutputOutcomeType		Sì
Stderr	string	Output degli errori standard acquisito.	Sì
stdout	string	Output standard acquisito.	Sì

OpenAI.FunctionShellCallOutputContentParam

Contenuto di output della shell

Acquisizione di stdout e stderr per una parte di un output di chiamata dello strumento shell.

Name	Type	Description	Obbligatorio
risultato	OpenAI.FunctionShellCallOutputOutcomeParam	Risultato di uscita o timeout associato a questa chiamata alla shell.	Sì
└─ Tipo	OpenAI.FunctionShellCallOutputOutcomeParamType		Sì
Stderr	string	Output stderr acquisito per la chiamata della shell. Vincoli: maxLength: 10485760	Sì
stdout	string	Output stdout acquisito per la chiamata alla shell. Vincoli: maxLength: 10485760	Sì

OpenAI.FunctionShellCallOutputExitOutcome

Esito di uscita di shell call

Indica che i comandi della shell sono stati completati e restituiti un codice di uscita.

Name	Type	Description	Obbligatorio	Predefinito
exit_code	integer	Uscire dal processo della shell.	Sì
type	enum	Tipo di risultato. Sempre `exit`. Valori possibili: `exit`	Sì	exit

OpenAI.FunctionShellCallOutputExitOutcomeParam

Esito di uscita di shell call

Indica che i comandi della shell sono stati completati e restituiti un codice di uscita.

Name	Type	Description	Obbligatorio	Predefinito
exit_code	integer	Il codice di uscita restituito dal processo shell.	Sì
type	enum	Tipo di risultato. Sempre `exit`. Valori possibili: `exit`	Sì	exit

OpenAI.FunctionShellCallOutputOutcome

Risultato della chiamata shell

Rappresenta un risultato di uscita (con un codice di uscita) o un risultato di timeout per un blocco di output della chiamata della shell.

Discriminare per OpenAI.FunctionShellCallOutputOutcome

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.FunctionShellCallOutputOutcomeType		Sì

OpenAI.FunctionShellCallOutputOutcomeParam

Risultato della chiamata shell

Risultato di uscita o timeout associato a questa chiamata alla shell.

Discriminare per OpenAI.FunctionShellCallOutputOutcomeParam

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Sì

OpenAI.FunctionShellCallOutputOutcomeParamType

Proprietà	Value
Type	string
Valori	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Proprietà	Value
Type	string
Valori	`timeout` `exit`

OpenAI.FunctionShellCallOutputStatusEnum

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Risultato del timeout della chiamata di shell

Indica che la chiamata della shell ha superato il limite di tempo configurato.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di risultato. Sempre `timeout`. Valori possibili: `timeout`	Sì	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Risultato del timeout della chiamata di shell

Indica che la chiamata della shell ha superato il limite di tempo configurato.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di risultato. Sempre `timeout`. Valori possibili: `timeout`	Sì	timeout

OpenAI.FunctionShellCallStatus

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Strumento a guscio

Strumento che consente al modello di eseguire comandi della shell.

Name	Type	Description	Obbligatorio	Predefinito
environment	OpenAI.FunctionShellToolParamEnvironment o null		No
type	enum	Tipo dello strumento shell. Sempre `shell`. Valori possibili: `shell`	Sì	shell

OpenAI.FunctionShellToolParamEnvironment

Discriminatore per OpenAI.FunctionShellToolParamEnvironment

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`local`	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.FunctionShellToolParamEnvironmentType		Sì

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Type	Description	Obbligatorio	Predefinito
container_id	string	L'ID del contenitore menzionato.	Sì
type	enum	Fa riferimento a un container creato con l'endpoint /v1/containers Valori possibili: `container_reference`	Sì	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Type	Description	Obbligatorio	Predefinito
competenze	array di OpenAI.LocalSkillParam	Una lista opzionale di abilità. Vincoli: maxOggetti: 200	No
type	enum	Usa un ambiente di computer locale. Valori possibili: `local`	Sì	local

OpenAI.FunctionShellToolParamEnvironmentType

Proprietà	Value
Type	string
Valori	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Funzione

Definisce una funzione nel tuo codice che il modello può chiamare.

Name	Type	Description	Obbligatorio	Predefinito
defer_loading	boolean	Se questa funzione venga differita e caricata tramite la ricerca degli strumenti.	No
descrizione	stringa o null		No
nome	string	Il nome della funzione da chiamare.	Sì
parameters	oggetto o null		Sì
rigido	booleano o null		Sì
type	enum	Tipo di strumento funzionale. Sempre `function`. Valori possibili: `function`	Sì	funzione

OpenAI.FunctionToolParam

Name	Type	Description	Obbligatorio	Predefinito
defer_loading	boolean	Se questa funzione debba essere posticipata e scoperta tramite la ricerca degli strumenti.	No
descrizione	stringa o null		No
nome	string	Vincoli: minLunghezza: 1, maxLunghezza: 128, pattern: `^[a-zA-Z0-9_-]+$`	Sì
parameters	OpenAI.EmptyModelParam o null		No
rigido	booleano o null		No
type	enum	Valori possibili: `function`	Sì	funzione

OpenAI.GrammarSyntax1

Proprietà	Value
Type	string
Valori	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Type	Description	Obbligatorio	Predefinito
embedding_weight	Numero	Peso dell'incorporamento nella fusione di rango reciproca.	Sì
text_weight	Numero	Peso del testo nella fusione di rango reciproco.	Sì

OpenAI.ImageDetail

Proprietà	Value
Type	string
Valori	`low` `high` `auto` `original`

OpenAI.ImageGenActionEnum

Proprietà	Value
Type	string
Valori	`generate` `edit` `auto`

OpenAI.ImageGenTool

Strumento di generazione immagini

Strumento che genera immagini usando i modelli di immagine GPT.

Modelli validi:

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

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ImageGenActionEnum		No
sfondo	enum	Tipo di sfondo per l'immagine generata. Uno di `transparent`, `opaque`, o `auto`. Impostazione predefinita: `auto`. Valori possibili: `transparent`, `opaque`, `auto`	No	auto
fedeltà dell'input	OpenAI.InputFidelity o null		No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└ file_id	string		No
└ image_url	stringa (uri)		No
model	string (vedere modelli validi di seguito)		No
Moderazione	enum	Livello di moderazione per l'immagine generata. Impostazione predefinita: `auto`. Valori possibili: `auto`, `low`	No	auto
Compressione dell'output	integer	Livello di compressione per l'immagine di output. Impostazione predefinita: 100. Vincoli: min: 0, max: 100	No	100
formato_di_output	enum	Formato di output dell'immagine generata. Uno di `png`, `webp`, o `jpeg`. Impostazione predefinita: `png`. Valori possibili: `png`, `webp`, `jpeg`	No	png
immagini parziali	integer	Numero di immagini parziali da generare in modalità di streaming, da 0 (valore predefinito) a 3. Vincoli: min: 0, max: 3	No
qualità	enum	Qualità dell'immagine generata. Uno di `low`, `medium`, `high`, , o `auto`. Impostazione predefinita: `auto`. Valori possibili: `low`, `medium`, `high`, `auto`	No	auto
size	string (vedere modelli validi di seguito)	La dimensione delle immagini generate. Per `gpt-image-2` e `gpt-image-2-2026-04-21`, risoluzioni arbitrarie sono supportate come `WIDTHxHEIGHT` stringhe, ad esempio `1536x864`. Larghezza e altezza devono essere entrambe divisibili per 16 e il rapporto d'aspetto richiesto deve essere tra 1:3 e 3:1. Le risoluzioni sopra `2560x1440` sono sperimentali, e la risoluzione massima supportata è `3840x2160`. La dimensione richiesta deve anche soddisfare i limiti attuali di pixel e bordi del modello. Le dimensioni `1024x1024`standard , `1536x1024`, e `1024x1536` sono supportate dai modelli immagine GPT; `auto` è supportata per modelli che permettono il dimensionamento automatico. Per `dall-e-2`, usa uno di `256x256`, `512x512`, o `1024x1024`. Per `dall-e-3`, usa uno di `1024x1024`, `1792x1024`, o `1024x1792`.	No
type	enum	Tipo dello strumento di generazione di immagini. Sempre `image_generation`. Valori possibili: `image_generation`	Sì	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Type	Description	Obbligatorio	Predefinito
ID del file	string		No
image_url	stringa (uri)		No

OpenAI.IncludeEnum

Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono:

web_search_call.results: Includere i risultati di ricerca della chiamata dello strumento di ricerca web.
web_search_call.action.sources: includere le origini della chiamata dello strumento di ricerca Web.
code_interpreter_call.outputs: include gli output dell'esecuzione del codice Python negli elementi di chiamata dello strumento dell'interprete del codice.
computer_call_output.output.image_url: includere gli URL delle immagini provenienti dall'output della chiamata computer.
file_search_call.results: includere i risultati della ricerca della chiamata allo strumento di ricerca file.
message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.
message.output_text.logprobs: includere logprobs con messaggi di assistente.
reasoning.encrypted_content: include una versione crittografata dei token di ragionamento negli output degli elementi di ragionamento. Ciò consente di usare gli elementi di ragionamento nelle conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su falseo quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).

Proprietà	Value
Descrizione	Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono: - `web_search_call.results`: Includere i risultati di ricerca della chiamata dello strumento di ricerca web. - `web_search_call.action.sources`: Includere le fonti dello strumento di ricerca web chiamato. - `code_interpreter_call.outputs`: includono i risultati dell'esecuzione di Python negli elementi di chiamata dello strumento interprete di codice. - `computer_call_output.output.image_url`: includere gli URL delle immagini provenienti dall'output della chiamata computer. - `file_search_call.results`: includere i risultati della ricerca della chiamata allo strumento di ricerca file. - `message.input_image.image_url`: includere gli URL dell'immagine dal messaggio di input. - `message.output_text.logprobs`: includere logprobs con messaggi di assistente. - `reasoning.encrypted_content`: Includere una versione crittografata dei token di ragionamento negli output degli elementi di ragionamento. Ciò consente di usare gli elementi di ragionamento nelle conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il `store` parametro è impostato su `false`o quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).
Type	string
Valori	`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	Obbligatorio	Predefinito
descrizione	string	La descrizione dell'abilità.	Sì
nome	string	Il nome dell'abilità.	Sì
source	OpenAI.InlineSkillSourceParam	Carico utile per abilità in linea	Sì
└* dati	string	Pacchetto zip di abilità codificato in base64. Vincoli: minLunghezza: 1, maxLunghezza: 70254592	Sì
└─ media_type	enum	Il tipo di media del payload inline di competenza. Deve essere `application/zip`. Valori possibili: `application/zip`	Sì	application/zip
└─ Tipo	enum	Il tipo di fonte di abilità inline. Deve essere `base64`. Valori possibili: `base64`	Sì	base64
type	enum	Definisce una competenza inline per questa richiesta. Valori possibili: `inline`	Sì	inline

OpenAI.InlineSkillSourceParam

Carico utile per abilità in linea

Name	Type	Description	Obbligatorio	Predefinito
data	string	Pacchetto zip di abilità codificato in base64. Vincoli: minLunghezza: 1, maxLunghezza: 70254592	Sì
media_type	enum	Il tipo di media del payload inline di competenza. Deve essere `application/zip`. Valori possibili: `application/zip`	Sì	application/zip
type	enum	Il tipo di fonte di abilità inline. Deve essere `base64`. Valori possibili: `base64`	Sì	base64

OpenAI.InputContent

Discriminare per OpenAI.InputContent

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.InputContentType		Sì

OpenAI.InputContentInputFileContent

File di input

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.FileInputDetail		No
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa o null		No
file_url	stringa (uri)	URL del file da inviare al modello.	No
filename	string	Nome del file da inviare al modello.	No
type	enum	Tipo dell'elemento di input. Sempre `input_file`. Valori possibili: `input_file`	Sì	input_file

OpenAI.InputContentInputImageContent

Immagine di input

Un'immagine come input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.ImageDetail		Sì
ID del file	stringa o null		No
image_url	stringa o null		No
type	enum	Tipo dell'elemento di input. Sempre `input_image`. Valori possibili: `input_image`	Sì	input_image

OpenAI.InputContentInputTextContent

Testo di input

Input di testo per il modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Input di testo per il modello.	Sì
type	enum	Tipo dell'elemento di input. Sempre `input_text`. Valori possibili: `input_text`	Sì	input_text

OpenAI.InputContentType

Proprietà	Value
Type	string
Valori	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Controllare quanto sforzo il modello eserciterà per corrispondere allo stile e alle caratteristiche, in particolare quelle facciali, delle immagini di ingresso. Questo parametro è supportato solo per gpt-image-1 e gpt-image-1.5 e modelli successivi, non supportati per gpt-image-1-mini. Supporti high e low. Di default è low.

Proprietà	Value
Type	string
Valori	`high` `low`

OpenAI.InputFileContent

File di input

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.FileInputDetail		No
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa o null		No
file_url	stringa (uri)	URL del file da inviare al modello.	No
filename	string	Nome del file da inviare al modello.	No
type	enum	Tipo dell'elemento di input. Sempre `input_file`. Valori possibili: `input_file`	Sì	input_file

OpenAI.InputFileContentParam

File di input

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.FileInputDetail		No
file_data	stringa o null		No
ID del file	stringa o null		No
file_url	stringa o null		No
filename	stringa o null		No
type	enum	Tipo dell'elemento di input. Sempre `input_file`. Valori possibili: `input_file`	Sì	input_file

OpenAI.InputImageContent

Immagine di input

Un'immagine come input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.ImageDetail		Sì
ID del file	stringa o null		No
image_url	stringa o null		No
type	enum	Tipo dell'elemento di input. Sempre `input_image`. Valori possibili: `input_image`	Sì	input_image

OpenAI.InputImageContentParamAutoParam

Immagine di input

Un'immagine come input per il modello. Scopri gli input delle immagini

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.DetailEnum o null		No
ID del file	stringa o null		No
image_url	stringa o null		No
type	enum	Tipo dell'elemento di input. Sempre `input_image`. Valori possibili: `input_image`	Sì	input_image

OpenAI.InputItem

Elemento che rappresenta parte del contesto per la risposta da generare dal modello. Può contenere input di testo, immagini e audio, nonché risposte assistente precedenti e output delle chiamate degli strumenti.

Discriminare per OpenAI.InputItem

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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	Obbligatorio	Predefinito
type	OpenAI.InputItemType		Sì

OpenAI.InputItemApplyPatchToolCallItemParam

Applica chiamata dello strumento patch

Chiamata dello strumento che rappresenta una richiesta di creazione, eliminazione o aggiornamento di file tramite patch diff.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento applica patch generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa o null		No
operazione	OpenAI.ApplyPatchOperationParam	Una delle operazioni di create_file, delete_file o update_file fornite allo strumento di apply_patch.	Sì
└─ Tipo	OpenAI.ApplyPatchOperationParamType		Sì
Stato	OpenAI.ApplyPatchCallStatusParam	Valori di stato segnalati per le chiamate degli strumenti apply_patch.	Sì
type	enum	Tipo dell'elemento. Sempre `apply_patch_call`. Valori possibili: `apply_patch_call`	Sì	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Applicare l'uscita chiamata dello strumento patch

Output trasmesso da una chiamata di applicazione dello strumento patch.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento applica patch generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa o null		No
output	stringa o null		No
Stato	OpenAI.ApplyPatchCallOutputStatusParam	Valori dei risultati segnalati per gli output delle chiamate dello strumento apply_patch.	Sì
type	enum	Tipo dell'elemento. Sempre `apply_patch_call_output`. Valori possibili: `apply_patch_call_output`	Sì	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Chiamata dello strumento interprete del codice

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa o null		Sì
container_id	string	ID del contenitore usato per eseguire il codice.	Sì
id	string	ID univoco della chiamata dello strumento interprete del codice.	Sì
outputs	matrice di OpenAI.CodeInterpreterOutputLogs o OpenAI.CodeInterpreterOutputImage o null		Sì
Stato	enum	Stato della chiamata dello strumento dell'interprete del codice. I valori validi sono `in_progress`, `completed`, `incomplete`, `interpreting` e `failed`. Valori possibili: `in_progress`, `completedincomplete`, , `interpreting`,`failed`	Sì
type	enum	Tipo di chiamata dello strumento dell'interprete del codice. Sempre `code_interpreter_call`. Valori possibili: `code_interpreter_call`	Sì	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Elemento di compattazione

Un elemento di compattazione generato dall'API v1/responses/compact .

Name	Type	Description	Obbligatorio	Predefinito
encrypted_content	string	Contenuto crittografato del riepilogo della compattazione. Vincoli: maxLength: 10485760	Sì
id	stringa o null		No
type	enum	Tipo dell'elemento. Sempre `compaction`. Valori possibili: `compaction`	Sì	Compattazione

OpenAI.InputItemComputerCallOutputItemParam

Output chiamata di strumento informatico

Output di una chiamata allo strumento del computer.

Name	Type	Description	Obbligatorio	Predefinito
acknowledged_safety_checks	array di OpenAI.ComputerCallSafetyCheckParam o null		No
call_id	string	ID della chiamata dello strumento del computer che ha prodotto l'output. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa o null		No
output	OpenAI.ComputerScreenshotImage	Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer.	Sì
Stato	OpenAI.FunctionCallItemStatus o null		No
type	enum	Tipo dell'output della chiamata dello strumento computer. Sempre `computer_call_output`. Valori possibili: `computer_call_output`	Sì	computer_call_output

OpenAI.InputItemComputerToolCall

Chiamata di strumento informatico

Chiamata di uno strumento a uno strumento per l'uso del computer.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Azioni in lotta appiattite per `computer_use`. Ogni azione include un `type` campi discriminatori e specifici per azione.	No
call_id	string	Identificatore usato per rispondere alla chiamata dello strumento con output.	Sì
id	string	ID univoco della chiamata computer.	Sì
pending_safety_checks	matrice di OpenAI.ComputerCallSafetyCheckParam	Controlli di sicurezza in sospeso per la chiamata computer.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo di chiamata al computer. Sempre `computer_call`. Valori possibili: `computer_call`	Sì	computer_call

OpenAI.InputItemCustomToolCall

Chiamata di uno strumento personalizzato

Chiamata a uno strumento personalizzato creato dal modello.

Name	Type	Description	Obbligatorio
call_id	string	Identificatore usato per eseguire il mapping di questa chiamata personalizzata a un output di chiamata dello strumento.	Sì
id	string	ID univoco della chiamata dello strumento personalizzato nella piattaforma OpenAI.	No
input	string	Input per la chiamata personalizzata dello strumento generata dal modello.	Sì
nome	string	Nome dello strumento personalizzato chiamato.	Sì
namespace	string	Il namespace dello strumento personalizzato che viene chiamato.	No
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre `custom_tool_call`. Valori possibili: `custom_tool_call`	Sì

OpenAI.InputItemCustomToolCallOutput

Output di chiamata di strumento personalizzata

L'output di una chiamata personalizzata dello strumento dal codice, che viene inviato al modello.

Name	Type	Description	Obbligatorio
call_id	string	ID chiamata, usato per eseguire il mapping dell'output della chiamata di questo strumento personalizzato a una chiamata di strumento personalizzata.	Sì
id	string	ID univoco dell'output delle chiamate dello strumento personalizzato nella piattaforma OpenAI.	No
output	stringa o matrice di OpenAI.FunctionAndCustomToolCallOutput	Output della chiamata dello strumento personalizzato generata dal codice. Può essere una stringa o un elenco di contenuto di output.	Sì
type	enum	Tipo dell'output delle chiamate dello strumento personalizzato. Sempre `custom_tool_call_output`. Valori possibili: `custom_tool_call_output`	Sì

OpenAI.InputItemFileSearchToolCall

Chiamata allo strumento di ricerca file

Risultati di una chiamata allo strumento di ricerca file.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata allo strumento per la ricerca dei file.	Sì
queries	matrice di valori string	Le interrogazioni usate per cercare i file.	Sì
results	matrice di OpenAI.FileSearchToolCallResults o null		No
Stato	enum	Stato della chiamata allo strumento di ricerca file. Uno di `in_progress`, `searching`, `incomplete` o `failed`, Valori possibili: `in_progress`, `searchingcompleted`, , `incomplete`,`failed`	Sì
type	enum	Tipo di chiamata allo strumento di ricerca file. Sempre `file_search_call`. Valori possibili: `file_search_call`	Sì

OpenAI.InputItemFunctionCallOutputItemParam

Uscita chiamata dello strumento di funzione

Output di una chiamata dello strumento di funzione.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa o null		No
output	stringa o matrice di OpenAI.InputTextContentParam o OpenAI.InputImageContentParamAutoParam o OpenAI.InputFileContentParam	Testo, immagine o output di file della chiamata dello strumento di funzione.	Sì
Stato	OpenAI.FunctionCallItemStatus o null		No
type	enum	Tipo di output della chiamata dello strumento di funzione. Sempre `function_call_output`. Valori possibili: `function_call_output`	Sì	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Chiamata dello strumento shell

Strumento che rappresenta una richiesta per eseguire uno o più comandi della shell.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.FunctionShellActionParam	Comandi e limiti che descrivono come eseguire la chiamata allo strumento shell.	Sì
Comandi └*	matrice di valori string	Comandi della shell ordinati per l'esecuzione dell'ambiente di esecuzione.	Sì
└max_output_length	integer o null		No
└timeout_ms	integer o null		No
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
environment	OpenAI.FunctionShellCallItemParamEnvironment o null		No
id	stringa o null		No
Stato	OpenAI.FunctionShellCallItemStatus o null		No
type	enum	Tipo dell'elemento. Sempre `shell_call`. Valori possibili: `shell_call`	Sì	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Output chiamata dello strumento shell

Elementi di output trasmessi generati da una chiamata allo strumento shell.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa o null		No
max_output_length	integer o null		No
output	matrice di OpenAI.FunctionShellCallOutputContentParam	Blocchi acquisiti di output stdout e stderr, insieme ai risultati associati.	Sì
Stato	OpenAI.FunctionShellCallItemStatus o null		No
type	enum	Tipo dell'elemento. Sempre `shell_call_output`. Valori possibili: `shell_call_output`	Sì	shell_call_output

OpenAI.InputItemFunctionToolCall

Chiamata dello strumento funzionale

Chiamata di uno strumento per eseguire una funzione.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON degli argomenti da passare alla funzione.	Sì
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string (sola lettura)	ID univoco della chiamata dello strumento di funzione.	Sì
nome	string	Nome della funzione da eseguire.	Sì
namespace	string	Il namespace della funzione da eseguire.	No
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di chiamata dello strumento di funzione. Sempre `function_call`. Valori possibili: `function_call`	Sì

OpenAI.InputItemImageGenToolCall

Chiamata di generazione immagini

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa o null		Sì
Stato	enum	Stato della chiamata di generazione dell'immagine. Valori possibili: `in_progress`, `completed`, `generating`, `failed`	Sì
type	enum	Tipo della chiamata di generazione dell'immagine. Sempre `image_generation_call`. Valori possibili: `image_generation_call`	Sì

OpenAI.InputItemLocalShellToolCall

Chiamata locale di shell

Chiamata dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio
action	OpenAI.LocalShellExecAction	Eseguire un comando shell nel server.	Sì
call_id	string	ID univoco della chiamata dello strumento shell locale generata dal modello.	Sì
id	string	ID univoco della chiamata della shell locale.	Sì
Stato	enum	Stato della chiamata della shell locale. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo di chiamata della shell locale. Sempre `local_shell_call`. Valori possibili: `local_shell_call`	Sì

OpenAI.InputItemLocalShellToolCallOutput

Uscita locale di chiamata shell

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata dello strumento shell locale generata dal modello.	Sì
output	string	Stringa JSON dell'output della chiamata allo strumento shell locale.	Sì
Stato	stringa o null		No
type	enum	Tipo dell'output delle chiamate dello strumento shell locale. Sempre `local_shell_call_output`. Valori possibili: `local_shell_call_output`	Sì

OpenAI.InputItemMcpApprovalRequest

Richiesta di approvazione MCP

Richiesta di approvazione umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON di argomenti per lo strumento.	Sì
id	string	ID univoco della richiesta di approvazione.	Sì
nome	string	Nome dello strumento da eseguire.	Sì
etichetta del server	string	Etichetta del server MCP che effettua la richiesta.	Sì
type	enum	Tipo dell'elemento. Sempre `mcp_approval_request`. Valori possibili: `mcp_approval_request`	Sì

OpenAI.InputItemMcpApprovalResponse

Risposta all'approvazione del MCP

Risposta a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio
approval_request_id	string	ID della richiesta di approvazione a cui si sta rispondendo.	Sì
approve	boolean	Indica se la richiesta è stata approvata.	Sì
id	stringa o null		No
reason	stringa o null		No
type	enum	Tipo dell'elemento. Sempre `mcp_approval_response`. Valori possibili: `mcp_approval_response`	Sì

OpenAI.InputItemMcpListTools

Strumenti per liste MCP

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio
error	OpenAI.RealtimeMCPError		No
id	string	ID univoco dell'elenco.	Sì
etichetta del server	string	Etichetta del server MCP.	Sì
Strumenti	matrice di OpenAI.MCPListToolsTool	Strumenti disponibili nel server.	Sì
type	enum	Tipo dell'elemento. Sempre `mcp_list_tools`. Valori possibili: `mcp_list_tools`	Sì

OpenAI.InputItemMcpToolCall

Chiamata allo strumento MCP

Chiamata di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio
approval_request_id	stringa o null		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	OpenAI.RealtimeMCPError		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa o null		No
etichetta del server	string	Etichetta del server MCP che esegue lo strumento.	Sì
Stato	OpenAI.MCPToolCallStatus		No
type	enum	Tipo dell'elemento. Sempre `mcp_call`. Valori possibili: `mcp_call`	Sì

OpenAI.InputItemOutputMessage

Messaggio di uscita

Messaggio di output del modello.

Name	Type	Description	Obbligatorio
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
Fase	OpenAI.MessagePhase o null		No
Ruolo	enum	Ruolo del messaggio di output. Sempre `assistant`. Valori possibili: `assistant`	Sì
Stato	enum	Stato dell'input del messaggio. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi di input vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo del messaggio di output. Sempre `message`. Valori possibili: `output_message`	Sì

OpenAI.InputItemReasoningItem

Reasoning

Descrizione della catena di pensiero usata da un modello di ragionamento durante la generazione di una risposta. Assicurarsi di includere questi elementi nell'API input Risposte per i turni successivi di una conversazione se si gestisce manualmente il contesto.

Name	Type	Description	Obbligatorio
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa o null		No
id	string	Identificatore univoco del contenuto di ragionamento.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
summary	array di OpenAI.SummaryTextContent	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre `reasoning`. Valori possibili: `reasoning`	Sì

OpenAI.InputItemToolSearchCallItemParam

Name	Type	Description	Obbligatorio	Predefinito
arguments	OpenAI.EmptyModelParam		Sì
call_id	stringa o null		No
esecuzione	OpenAI.ToolSearchExecutionType		No
id	stringa o null		No
Stato	OpenAI.FunctionCallItemStatus o null		No
type	enum	Tipo di elemento. Sempre `tool_search_call`. Valori possibili: `tool_search_call`	Sì	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Name	Type	Description	Obbligatorio	Predefinito
call_id	stringa o null		No
esecuzione	OpenAI.ToolSearchExecutionType		No
id	stringa o null		No
Stato	OpenAI.FunctionCallItemStatus o null		No
Strumenti	matrice di OpenAI.Tool	Le definizioni degli strumenti caricati sono restituite dall'output della ricerca dello strumento.	Sì
type	enum	Tipo di elemento. Sempre `tool_search_output`. Valori possibili: `tool_search_output`	Sì	tool_search_output

OpenAI.InputItemType

Proprietà Value

Type string

Valori 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

Chiamata allo strumento di ricerca web

Risultati di una chiamata allo strumento di ricerca Web.

Name	Type	Description	Obbligatorio
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include dettagli su come il modello utilizzava il web (ricerca, open_page, find_in_page).	Sì
id	string	ID univoco della chiamata dello strumento di ricerca Web.	Sì
Stato	enum	Stato della chiamata dello strumento di ricerca Web. Valori possibili: `in_progress`, `searching`, `completed`, `failed`	Sì
type	enum	Tipo di chiamata dello strumento di ricerca Web. Sempre `web_search_call`. Valori possibili: `web_search_call`	Sì

OpenAI.InputMessageContentList

Elenco dei contenuti degli elementi in input

Elenco di uno o più elementi di input per il modello, contenente tipi di contenuto diversi.

Matrice di: OpenAI.InputContent

OpenAI.InputParam

Input di testo, immagine o file nel modello, usato per generare una risposta. Ulteriori informazioni:

Input e output di testo
Input immagine
Input file
Stato della conversazione
Chiamata di funzione

Questo componente può essere uno dei seguenti:

string
array

OpenAI.InputTextContent

Testo di input

Input di testo per il modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Input di testo per il modello.	Sì
type	enum	Tipo dell'elemento di input. Sempre `input_text`. Valori possibili: `input_text`	Sì	input_text

OpenAI.InputTextContentParam

Testo di input

Input di testo per il modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Input di testo per il modello. Vincoli: maxLength: 10485760	Sì
type	enum	Tipo dell'elemento di input. Sempre `input_text`. Valori possibili: `input_text`	Sì	input_text

OpenAI.ItemReferenceParam

Riferimento all'elemento

Identificatore interno di un elemento a cui fare riferimento.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID dell'elemento a cui fare riferimento.	Sì
type	enum	Tipo di elemento a cui fare riferimento. Sempre `item_reference`. Valori possibili: `item_reference`	Sì	item_reference

OpenAI.ItemResource

Elemento di contenuto usato per generare una risposta.

Discriminatorio per OpenAI.ItemResource

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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.ItemRisorsaRagionamentoOggetto
`compaction`	OpenAI.ItemResourceCompactionBody
`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	Obbligatorio	Predefinito
type	OpenAI.ItemResourceType		Sì

OpenAI.ItemResourceApplyPatchToolCall

Applica chiamata dello strumento patch

Chiamata dello strumento che applica differenze di file creando, eliminando o aggiornando i file.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento applica patch generata dal modello.	Sì
creato_da	string	ID dell'entità che ha creato questa chiamata allo strumento.	No
id	string	ID univoco della chiamata dello strumento apply patch. Viene popolato quando questo elemento è restituito tramite API.	Sì
operazione	OpenAI.ApplyPatchFileOperation	Una delle operazioni di create_file, delete_file o update_file applicate tramite apply_patch.	Sì
└─ Tipo	OpenAI.ApplyPatchFileOperationType		Sì
Stato	OpenAI.ApplyPatchCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre `apply_patch_call`. Valori possibili: `apply_patch_call`	Sì	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Applicare l'uscita chiamata dello strumento patch

Output generato da una chiamata di applicazione dello strumento patch.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento applica patch generata dal modello.	Sì
creato_da	string	ID dell'entità che ha creato l'output della chiamata dello strumento.	No
id	string	ID univoco dell'output della chiamata dello strumento patch apply. Viene popolato quando questo elemento è restituito tramite API.	Sì
output	stringa o null		No
Stato	OpenAI.ApplyPatchCallOutputStatus		Sì
type	enum	Tipo dell'elemento. Sempre `apply_patch_call_output`. Valori possibili: `apply_patch_call_output`	Sì	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Chiamata dello strumento interprete del codice

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa o null		Sì
container_id	string	ID del contenitore usato per eseguire il codice.	Sì
id	string	ID univoco della chiamata dello strumento interprete del codice.	Sì
outputs	matrice di OpenAI.CodeInterpreterOutputLogs o OpenAI.CodeInterpreterOutputImage o null		Sì
Stato	enum	Stato della chiamata dello strumento dell'interprete del codice. I valori validi sono `in_progress`, `completed`, `incomplete`, `interpreting` e `failed`. Valori possibili: `in_progress`, `completedincomplete`, , `interpreting`,`failed`	Sì
type	enum	Tipo di chiamata dello strumento dell'interprete del codice. Sempre `code_interpreter_call`. Valori possibili: `code_interpreter_call`	Sì	code_interpreter_call

OpenAI.ItemResourceCompactionBody

Elemento di compattazione

Un elemento di compattazione generato dall'API v1/responses/compact .

Name	Type	Description	Obbligatorio	Predefinito
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
encrypted_content	string	Contenuto crittografato prodotto dalla compattazione.	Sì
id	string	ID univoco dell'elemento di compattazione.	Sì
type	enum	Tipo dell'elemento. Sempre `compaction`. Valori possibili: `compaction`	Sì	Compattazione

OpenAI.ItemResourceComputerToolCall

Chiamata di strumento informatico

Chiamata di uno strumento a uno strumento per l'uso del computer.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Azioni in lotta appiattite per `computer_use`. Ogni azione include un `type` campi discriminatori e specifici per azione.	No
call_id	string	Identificatore usato per rispondere alla chiamata dello strumento con output.	Sì
id	string	ID univoco della chiamata computer.	Sì
pending_safety_checks	matrice di OpenAI.ComputerCallSafetyCheckParam	Controlli di sicurezza in sospeso per la chiamata computer.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo di chiamata al computer. Sempre `computer_call`. Valori possibili: `computer_call`	Sì	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Output chiamata di strumento informatico

Output di una chiamata allo strumento del computer.

Name	Type	Description	Obbligatorio	Predefinito
acknowledged_safety_checks	matrice di OpenAI.ComputerCallSafetyCheckParam	I controlli di sicurezza segnalati dall'API che sono stati riconosciuti dal sviluppatore.	No
call_id	string	ID della chiamata dello strumento del computer che ha prodotto l'output.	Sì
id	string (sola lettura)	ID dell'output della chiamata dello strumento computer.	Sì
output	OpenAI.ComputerScreenshotImage	Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer.	Sì
Stato	enum	Stato dell'input del messaggio. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi di input vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo dell'output della chiamata dello strumento computer. Sempre `computer_call_output`. Valori possibili: `computer_call_output`	Sì	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

RispostaToolPersonalizzatoChiamataOutputElemento

Name	Type	Description	Obbligatorio
call_id	string	ID chiamata, usato per eseguire il mapping dell'output della chiamata di questo strumento personalizzato a una chiamata di strumento personalizzata.	Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
id	string	ID univoco dell'output delle chiamate dello strumento personalizzato nella piattaforma OpenAI.	No
output	stringa o matrice di OpenAI.FunctionAndCustomToolCallOutput	Output della chiamata dello strumento personalizzato generata dal codice. Può essere una stringa o un elenco di contenuto di output.	Sì
Stato	OpenAI.FunctionCallOutputStatusEnum		Sì
type	enum	Tipo dell'output delle chiamate dello strumento personalizzato. Sempre `custom_tool_call_output`. Valori possibili: `custom_tool_call_output`	Sì

OpenAI.ItemResourceCustomToolCallResource

RispondenzaToolChiamataOggetto

Name	Type	Description	Obbligatorio
call_id	string	Identificatore usato per eseguire il mapping di questa chiamata personalizzata a un output di chiamata dello strumento.	Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
id	string	ID univoco della chiamata dello strumento personalizzato nella piattaforma OpenAI.	No
input	string	Input per la chiamata personalizzata dello strumento generata dal modello.	Sì
nome	string	Nome dello strumento personalizzato chiamato.	Sì
namespace	string	Il namespace dello strumento personalizzato che viene chiamato.	No
Stato	OpenAI.FunctionCallStatus		Sì
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre `custom_tool_call`. Valori possibili: `custom_tool_call`	Sì

OpenAI.ItemResourceFileSearchToolCall

Chiamata allo strumento di ricerca file

Risultati di una chiamata allo strumento di ricerca file.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata allo strumento per la ricerca dei file.	Sì
queries	matrice di valori string	Le interrogazioni usate per cercare i file.	Sì
results	matrice di OpenAI.FileSearchToolCallResults o null		No
Stato	enum	Stato della chiamata allo strumento di ricerca file. Uno di `in_progress`, `searching`, `incomplete` o `failed`, Valori possibili: `in_progress`, `searchingcompleted`, , `incomplete`,`failed`	Sì
type	enum	Tipo di chiamata allo strumento di ricerca file. Sempre `file_search_call`. Valori possibili: `file_search_call`	Sì

OpenAI.ItemResourceFunctionShellCall

Chiamata dello strumento shell

Chiamata dello strumento che esegue uno o più comandi della shell in un ambiente gestito.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.FunctionShellAction	Eseguire un comando shell.	Sì
Comandi └*	matrice di valori string		Sì
└max_output_length	integer o null		Sì
└timeout_ms	integer o null		Sì
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello.	Sì
creato_da	string	ID dell'entità che ha creato questa chiamata allo strumento.	No
environment	OpenAI.FunctionShellCallEnvironment o null		Sì
id	string	ID univoco della chiamata dello strumento shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
Stato	OpenAI.FunctionShellCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre `shell_call`. Valori possibili: `shell_call`	Sì	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Output chiamata shell

Output di una chiamata dello strumento shell generata.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello.	Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
id	string	ID univoco dell'output della chiamata della shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
max_output_length	integer o null		Sì
output	matrice di OpenAI.FunctionShellCallOutputContent	Matrice di contenuti di output delle chiamate shell	Sì
Stato	OpenAI.FunctionShellCallOutputStatusEnum		Sì
type	enum	Tipo dell'output delle chiamate della shell. Sempre `shell_call_output`. Valori possibili: `shell_call_output`	Sì	shell_call_output

OpenAI.ItemResourceFunctionToolCall

Chiamata dello strumento funzionale

Chiamata di uno strumento per eseguire una funzione.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON degli argomenti da passare alla funzione.	Sì
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string (sola lettura)	ID univoco della chiamata dello strumento di funzione.	Sì
nome	string	Nome della funzione da eseguire.	Sì
namespace	string	Il namespace della funzione da eseguire.	No
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di chiamata dello strumento di funzione. Sempre `function_call`. Valori possibili: `function_call`	Sì

OpenAI.ItemResourceFunctionToolCallOutput

Uscita chiamata dello strumento di funzione

Output di una chiamata dello strumento di funzione.

Name	Type	Description	Obbligatorio
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string (sola lettura)	ID univoco dell'output della chiamata dello strumento di funzione. Popolato quando questo elemento viene restituito tramite l'API.	Sì
output	stringa o matrice di OpenAI.FunctionAndCustomToolCallOutput	Output della chiamata di funzione generata dal codice. Può essere una stringa o un elenco di contenuto di output.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di output della chiamata dello strumento di funzione. Sempre `function_call_output`. Valori possibili: `function_call_output`	Sì

OpenAI.ItemResourceImageGenToolCall

Chiamata di generazione immagini

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa o null		Sì
Stato	enum	Stato della chiamata di generazione dell'immagine. Valori possibili: `in_progress`, `completed`, `generating`, `failed`	Sì
type	enum	Tipo della chiamata di generazione dell'immagine. Sempre `image_generation_call`. Valori possibili: `image_generation_call`	Sì

OpenAI.ItemResourceInputMessage

Messaggio di input

Name	Type	Description	Obbligatorio	Predefinito
contenuto	OpenAI.InputMessageContentList	Elenco di uno o più elementi di input per il modello, contenente contenuto diverso types.	Sì
id	string (sola lettura)	ID univoco dell'input del messaggio.	Sì
Ruolo	enum	Ruolo dell'inserimento del messaggio. Uno tra `user`, `system` e `developer`. Valori possibili: `user`, `system`, `developer`	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di input del messaggio. Sempre impostato su `message`. Valori possibili: `message`	Sì	message

OpenAI.ItemResourceLocalShellToolCall

Chiamata locale di shell

Chiamata dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio
action	OpenAI.LocalShellExecAction	Eseguire un comando shell nel server.	Sì
call_id	string	ID univoco della chiamata dello strumento shell locale generata dal modello.	Sì
id	string	ID univoco della chiamata della shell locale.	Sì
Stato	enum	Stato della chiamata della shell locale. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo di chiamata della shell locale. Sempre `local_shell_call`. Valori possibili: `local_shell_call`	Sì

OpenAI.ItemResourceLocalShellToolCallOutput

Uscita locale di chiamata shell

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata dello strumento shell locale generata dal modello.	Sì
output	string	Stringa JSON dell'output della chiamata allo strumento shell locale.	Sì
Stato	stringa o null		No
type	enum	Tipo dell'output delle chiamate dello strumento shell locale. Sempre `local_shell_call_output`. Valori possibili: `local_shell_call_output`	Sì

OpenAI.ItemResourceMcpApprovalRequest

Richiesta di approvazione MCP

Richiesta di approvazione umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON di argomenti per lo strumento.	Sì
id	string	ID univoco della richiesta di approvazione.	Sì
nome	string	Nome dello strumento da eseguire.	Sì
etichetta del server	string	Etichetta del server MCP che effettua la richiesta.	Sì
type	enum	Tipo dell'elemento. Sempre `mcp_approval_request`. Valori possibili: `mcp_approval_request`	Sì

OpenAI.ItemResourceMcpApprovalResponseResource

Risposta all'approvazione del MCP

Risposta a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio
approval_request_id	string	ID della richiesta di approvazione a cui si sta rispondendo.	Sì
approve	boolean	Indica se la richiesta è stata approvata.	Sì
id	string	ID univoco della risposta di approvazione	Sì
reason	stringa o null		No
type	enum	Tipo dell'elemento. Sempre `mcp_approval_response`. Valori possibili: `mcp_approval_response`	Sì

OpenAI.ItemResourceMcpListTools

Strumenti per liste MCP

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio
error	OpenAI.RealtimeMCPError		No
id	string	ID univoco dell'elenco.	Sì
etichetta del server	string	Etichetta del server MCP.	Sì
Strumenti	matrice di OpenAI.MCPListToolsTool	Strumenti disponibili nel server.	Sì
type	enum	Tipo dell'elemento. Sempre `mcp_list_tools`. Valori possibili: `mcp_list_tools`	Sì

OpenAI.ItemResourceMcpToolCall

Chiamata allo strumento MCP

Chiamata di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio
approval_request_id	stringa o null		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	OpenAI.RealtimeMCPError		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa o null		No
etichetta del server	string	Etichetta del server MCP che esegue lo strumento.	Sì
Stato	OpenAI.MCPToolCallStatus		No
type	enum	Tipo dell'elemento. Sempre `mcp_call`. Valori possibili: `mcp_call`	Sì

OpenAI.ItemResourceOutputMessage

Messaggio di uscita

Messaggio di output del modello.

Name	Type	Description	Obbligatorio
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
Fase	OpenAI.MessagePhase o null		No
Ruolo	enum	Ruolo del messaggio di output. Sempre `assistant`. Valori possibili: `assistant`	Sì
Stato	enum	Stato dell'input del messaggio. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi di input vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo del messaggio di output. Sempre `message`. Valori possibili: `output_message`	Sì

OpenAI.ItemRisorsaRagionamentoOggetto

Reasoning

Name	Type	Description	Obbligatorio
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa o null		No
id	string	Identificatore univoco del contenuto di ragionamento.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
summary	array di OpenAI.SummaryTextContent	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre `reasoning`. Valori possibili: `reasoning`	Sì

OpenAI.ItemResourceToolSearchCall

Name	Type	Description	Obbligatorio	Predefinito
arguments		Argomenti usati per la chiamata di ricerca dello strumento.	Sì
call_id	stringa o null		Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
esecuzione	OpenAI.ToolSearchExecutionType		Sì
id	string	L'ID unico dell'elemento di ricerca dello strumento.	Sì
Stato	OpenAI.FunctionCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre `tool_search_call`. Valori possibili: `tool_search_call`	Sì	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Name	Type	Description	Obbligatorio	Predefinito
call_id	stringa o null		Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
esecuzione	OpenAI.ToolSearchExecutionType		Sì
id	string	L'ID unico dell'elemento di ricerca dello strumento.	Sì
Stato	OpenAI.FunctionCallOutputStatusEnum		Sì
Strumenti	matrice di OpenAI.Tool	Le definizioni degli strumenti caricati restituite tramite la ricerca degli strumenti.	Sì
type	enum	Tipo dell'elemento. Sempre `tool_search_output`. Valori possibili: `tool_search_output`	Sì	tool_search_output

OpenAI.ItemResourceType

Proprietà Value

Type string

OpenAI.ItemResourceWebSearchToolCall

Chiamata allo strumento di ricerca web

Risultati di una chiamata allo strumento di ricerca Web.

Name	Type	Description	Obbligatorio
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include dettagli su come il modello utilizzava il web (ricerca, open_page, find_in_page).	Sì
id	string	ID univoco della chiamata dello strumento di ricerca Web.	Sì
Stato	enum	Stato della chiamata dello strumento di ricerca Web. Valori possibili: `in_progress`, `searching`, `completed`, `failed`	Sì
type	enum	Tipo di chiamata dello strumento di ricerca Web. Sempre `web_search_call`. Valori possibili: `web_search_call`	Sì

OpenAI.KeyPressAction

KeyPress

Una raccolta di pressioni di tasti che il modello desidera eseguire.

Name	Type	Description	Obbligatorio	Predefinito
keys	matrice di valori string	La combinazione di tasti che il modello richiede di premere. Si tratta di una matrice di stringhe, ognuna che rappresenta una chiave.	Sì
type	enum	Specifica il tipo di evento. Per un'azione keypress, questa proprietà è sempre impostata su `keypress`. Valori possibili: `keypress`	Sì	Pressione del tasto

OpenAI.LocalEnvironmentResource

Ambiente locale

Rappresenta l'uso di un ambiente locale per eseguire azioni da shell.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di ambiente. Sempre `local`. Valori possibili: `local`	Sì	local

OpenAI.LocalShellExecAction

Azione locale dell'executive shell

Eseguire un comando shell nel server.

Name	Type	Description	Obbligatorio	Predefinito
Comando	matrice di valori string	Comando da eseguire.	Sì
Env	object	Variabili di ambiente da impostare per il comando.	Sì
timeout_ms	integer o null		No
type	enum	Tipo dell'azione della shell locale. Sempre `exec`. Valori possibili: `exec`	Sì	exec
user	stringa o null		No
working_directory	stringa o null		No

OpenAI.LocalShellToolParam

Strumento a guscio locale

Strumento che consente al modello di eseguire comandi della shell in un ambiente locale.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo dello strumento della shell locale. Sempre `local_shell`. Valori possibili: `local_shell`	Sì	local_shell

OpenAI.LocalSkillParam

Name	Type	Description	Obbligatorio
descrizione	string	La descrizione dell'abilità.	Sì
nome	string	Il nome dell'abilità.	Sì
path	string	Il percorso verso la directory che contiene l'abilità.	Sì

OpenAI.LogProb

Probabilità logaritmica

Probabilità del log di un token.

Name	Type	Obbligatorio
bytes	matrice di numeri interi	Sì
logprob	Numero	Sì
token	string	Sì
top_logprobs	matrice di OpenAI.TopLogProb	Sì

OpenAI.MCPListToolsTool

Strumento degli strumenti per liste MCP

Strumento disponibile in un server MCP.

Name	Type	Description	Obbligatorio
annotations	OpenAI.MCPListToolsToolAnnotations o null		No
descrizione	stringa o null		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Sì
nome	string	Nome dello strumento.	Sì

OpenAI.MCPListToolsToolAnnotations

Tipo: oggetto

OpenAI.MCPListToolsToolInputSchema

Tipo: oggetto

OpenAI.MCPTool

Strumento MCP

Concedere al modello l'accesso a strumenti aggiuntivi tramite server MCP (Model Context Protocol) remoti.

Name	Type	Description	Obbligatorio
strumenti consentiti	matrice di string o OpenAI.MCPToolFilter o null		No
authorization	string	Token di accesso OAuth che può essere usato con un server MCP remoto, con un URL del server MCP personalizzato o un connettore di servizi. Applicazione deve gestire il flusso di autorizzazione OAuth e fornire il token qui.	No
connector_id	enum	Identificatore per i connettori del servizio, ad esempio quelli disponibili in ChatGPT. Uno dei `server_url` o `connector_id` deve essere fornito. Altre informazioni sul servizio Qui connettori. I valori attualmente supportati `connector_id` sono: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Calendar: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams:`connector_microsoftteams` - Calendario di Outlook: `connector_outlookcalendar` - Posta elettronica di Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Valori possibili: `connector_dropbox`, `connector_gmail`, `connector_googlecalendarconnector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , `connector_outlookemailconnector_sharepoint`	No
defer_loading	boolean	Se questo strumento MCP viene differito e scoperto tramite la ricerca degli strumenti.	No
headers	oggetto o null		No
richiedere_approvazione	OpenAI.MCPToolRequireApproval o stringa o null		No
server_description	string	Descrizione facoltativa del server MCP, usata per fornire più contesto.	No
etichetta del server	string	Etichetta per questo server MCP, usata per identificarla nelle chiamate degli strumenti.	Sì
URL del server	stringa (uri)	URL del server MCP. Uno di `server_url` o `connector_id` deve essere Fornito.	No
type	enum	Tipo dello strumento MCP. Sempre `mcp`. Valori possibili: `mcp`	Sì

OpenAI.MCPToolCallStatus

Proprietà	Value
Type	string
Valori	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Filtro utensile MCP

Oggetto filtro per specificare gli strumenti consentiti.

Name	Type	Description	Obbligatorio	Predefinito
Read_only	boolean	Indica se uno strumento modifica o meno i dati o è di sola lettura. Se un oggetto Il server MCP viene annotato con `readOnlyHint`, corrisponderà a questo filtro.	No
tool_names	matrice di valori string	Elenco dei nomi degli strumenti consentiti.	No

OpenAI.MCPToolRequireApproval

Name	Type	Description	Obbligatorio	Predefinito
Sempre	OpenAI.MCPToolFilter	Oggetto filtro per specificare gli strumenti consentiti.	No
mai	OpenAI.MCPToolFilter	Oggetto filtro per specificare gli strumenti consentiti.	No

OpenAI.MessageContent

Parte del contenuto che costituisce un elemento di input o output.

Discriminare per OpenAI.MessageContent

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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	Obbligatorio	Predefinito
type	OpenAI.MessageContentType		Sì

OpenAI.MessageContentInputFileContent

File di input

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.FileInputDetail		No
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa o null		No
file_url	stringa (uri)	URL del file da inviare al modello.	No
filename	string	Nome del file da inviare al modello.	No
type	enum	Tipo dell'elemento di input. Sempre `input_file`. Valori possibili: `input_file`	Sì	input_file

OpenAI.MessageContentInputImageContent

Immagine di input

Un'immagine come input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	OpenAI.ImageDetail		Sì
ID del file	stringa o null		No
image_url	stringa o null		No
type	enum	Tipo dell'elemento di input. Sempre `input_image`. Valori possibili: `input_image`	Sì	input_image

OpenAI.MessageContentInputTextContent

Testo di input

Input di testo per il modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Input di testo per il modello.	Sì
type	enum	Tipo dell'elemento di input. Sempre `input_text`. Valori possibili: `input_text`	Sì	input_text

OpenAI.MessageContentOutputTextContent

Testo in uscita

Output di testo del modello.

Name	Type	Description	Obbligatorio	Predefinito
annotations	matrice di OpenAI.Annotation	Annotazioni dell'output di testo.	Sì
logprobs	matrice di OpenAI.LogProb		Sì
text	string	L'output di testo generato dal modello.	Sì
type	enum	Tipo del testo di uscita. Sempre `output_text`. Valori possibili: `output_text`	Sì	output_text

OpenAI.MessageContentReasoningTextContent

Testo di ragionamento

Ragionamento del testo dal modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Testo di ragionamento del modello.	Sì
type	enum	Tipo del testo di ragionamento. Sempre `reasoning_text`. Valori possibili: `reasoning_text`	Sì	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

Rifiuto da parte del modello.

Name	Type	Description	Obbligatorio	Predefinito
refusal	string	Spiegazione del rifiuto da parte del modello.	Sì
type	enum	Tipo di rifiuto. Sempre `refusal`. Valori possibili: `refusal`	Sì	refusal

OpenAI.MessageContentType

Proprietà	Value
Type	string
Valori	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessagePhase

Etichetta un assistant messaggio come commento intermedio (commentary) o come risposta finale (final_answer). Per modelli simili gpt-5.3-codex e successivi, quando si inviano richieste di followup, si conserva e si riinvia la fase di tutti i messaggi dell'assistente — perdere la fase può degradare le prestazioni. Non usato per i messaggi degli utenti.

Proprietà	Value
Type	string
Valori	`commentary` `final_answer`

OpenAI.Metadata

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Ciò può essere utile per archiviare informazioni aggiuntive sull'oggetto in un formato strutturato ed eseguire query sugli oggetti tramite API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.

Tipo: oggetto

OpenAI.MoveParam

Move

Azione di spostamento del mouse.

Name	Type	Description	Obbligatorio	Predefinito
keys	matrice di stringhe o null		No
type	enum	Specifica il tipo di evento. Per un'azione di spostamento, questa proprietà è sempre impostata su `move`. Valori possibili: `move`	Sì	spostamento
x	integer	Coordinata x in cui spostarsi.	Sì
y	integer	Coordinata y su cui spostarsi.	Sì

OpenAI.NamespaceToolParam

Namespace

Raggruppa la funzione/strumenti personalizzati sotto uno spazio di nomi condiviso.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione dello spazio dei nomi mostrata al modello. Vincoli: minLength: 1	Sì
nome	string	Il nome dello spazio di nomi usato nelle chiamate agli strumenti (ad esempio, `crm`). Vincoli: minLength: 1	Sì
Strumenti	array di OpenAI.FunctionToolParam o OpenAI.CustomToolParam	Le funzioni/strumenti personalizzati disponibili all'interno di questo namespace. Vincoli: minOggetti: 1	Sì
type	enum	Tipo dello strumento. Sempre `namespace`. Valori possibili: `namespace`	Sì	namespace

OpenAI.OutputContent

Discriminare per OpenAI.OutputContent

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.OutputContentType		Sì

OpenAI.OutputContentOutputTextContent

Testo in uscita

Output di testo del modello.

Name	Type	Description	Obbligatorio	Predefinito
annotations	matrice di OpenAI.Annotation	Annotazioni dell'output di testo.	Sì
logprobs	matrice di OpenAI.LogProb		Sì
text	string	L'output di testo generato dal modello.	Sì
type	enum	Tipo del testo di uscita. Sempre `output_text`. Valori possibili: `output_text`	Sì	output_text

OpenAI.OutputContentReasoningTextContent

Testo di ragionamento

Ragionamento del testo dal modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Testo di ragionamento del modello.	Sì
type	enum	Tipo del testo di ragionamento. Sempre `reasoning_text`. Valori possibili: `reasoning_text`	Sì	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

Rifiuto da parte del modello.

Name	Type	Description	Obbligatorio	Predefinito
refusal	string	Spiegazione del rifiuto da parte del modello.	Sì
type	enum	Tipo di rifiuto. Sempre `refusal`. Valori possibili: `refusal`	Sì	refusal

OpenAI.OutputContentType

Proprietà	Value
Type	string
Valori	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Discriminare per OpenAI.OutputItem

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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	Obbligatorio	Predefinito
type	OpenAI.OutputItemType		Sì

OpenAI.OutputItemApplyPatchToolCall

Applica chiamata dello strumento patch

Chiamata dello strumento che applica differenze di file creando, eliminando o aggiornando i file.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento applica patch generata dal modello.	Sì
creato_da	string	ID dell'entità che ha creato questa chiamata allo strumento.	No
id	string	ID univoco della chiamata dello strumento apply patch. Viene popolato quando questo elemento è restituito tramite API.	Sì
operazione	OpenAI.ApplyPatchFileOperation	Una delle operazioni di create_file, delete_file o update_file applicate tramite apply_patch.	Sì
└─ Tipo	OpenAI.ApplyPatchFileOperationType		Sì
Stato	OpenAI.ApplyPatchCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre `apply_patch_call`. Valori possibili: `apply_patch_call`	Sì	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Applicare l'uscita chiamata dello strumento patch

Output generato da una chiamata di applicazione dello strumento patch.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento applica patch generata dal modello.	Sì
creato_da	string	ID dell'entità che ha creato l'output della chiamata dello strumento.	No
id	string	ID univoco dell'output della chiamata dello strumento patch apply. Viene popolato quando questo elemento è restituito tramite API.	Sì
output	stringa o null		No
Stato	OpenAI.ApplyPatchCallOutputStatus		Sì
type	enum	Tipo dell'elemento. Sempre `apply_patch_call_output`. Valori possibili: `apply_patch_call_output`	Sì	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Chiamata dello strumento interprete del codice

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa o null		Sì
container_id	string	ID del contenitore usato per eseguire il codice.	Sì
id	string	ID univoco della chiamata dello strumento interprete del codice.	Sì
outputs	matrice di OpenAI.CodeInterpreterOutputLogs o OpenAI.CodeInterpreterOutputImage o null		Sì
Stato	enum	Stato della chiamata dello strumento dell'interprete del codice. I valori validi sono `in_progress`, `completed`, `incomplete`, `interpreting` e `failed`. Valori possibili: `in_progress`, `completedincomplete`, , `interpreting`,`failed`	Sì
type	enum	Tipo di chiamata dello strumento dell'interprete del codice. Sempre `code_interpreter_call`. Valori possibili: `code_interpreter_call`	Sì	code_interpreter_call

OpenAI.OutputItemCompactionBody

Elemento di compattazione

Un elemento di compattazione generato dall'API v1/responses/compact .

Name	Type	Description	Obbligatorio	Predefinito
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
encrypted_content	string	Contenuto crittografato prodotto dalla compattazione.	Sì
id	string	ID univoco dell'elemento di compattazione.	Sì
type	enum	Tipo dell'elemento. Sempre `compaction`. Valori possibili: `compaction`	Sì	Compattazione

OpenAI.OutputItemComputerToolCall

Chiamata di strumento informatico

Chiamata di uno strumento a uno strumento per l'uso del computer.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		No
actions	OpenAI.ComputerActionList	Azioni in lotta appiattite per `computer_use`. Ogni azione include un `type` campi discriminatori e specifici per azione.	No
call_id	string	Identificatore usato per rispondere alla chiamata dello strumento con output.	Sì
id	string	ID univoco della chiamata computer.	Sì
pending_safety_checks	matrice di OpenAI.ComputerCallSafetyCheckParam	Controlli di sicurezza in sospeso per la chiamata computer.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo di chiamata al computer. Sempre `computer_call`. Valori possibili: `computer_call`	Sì	computer_call

OpenAI.OutputItemComputerToolCallOutput

Output chiamata di strumento informatico

Output di una chiamata allo strumento del computer.

Name	Type	Description	Obbligatorio	Predefinito
acknowledged_safety_checks	matrice di OpenAI.ComputerCallSafetyCheckParam	I controlli di sicurezza segnalati dall'API che sono stati riconosciuti dal sviluppatore.	No
call_id	string	ID della chiamata dello strumento del computer che ha prodotto l'output.	Sì
id	string (sola lettura)	ID dell'output della chiamata dello strumento computer.	Sì
output	OpenAI.ComputerScreenshotImage	Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer.	Sì
Stato	enum	Stato dell'input del messaggio. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi di input vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo dell'output della chiamata dello strumento computer. Sempre `computer_call_output`. Valori possibili: `computer_call_output`	Sì	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

RispostaToolPersonalizzatoChiamataOutputElemento

Name	Type	Description	Obbligatorio
call_id	string	ID chiamata, usato per eseguire il mapping dell'output della chiamata di questo strumento personalizzato a una chiamata di strumento personalizzata.	Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
id	string	ID univoco dell'output delle chiamate dello strumento personalizzato nella piattaforma OpenAI.	No
output	stringa o matrice di OpenAI.FunctionAndCustomToolCallOutput	Output della chiamata dello strumento personalizzato generata dal codice. Può essere una stringa o un elenco di contenuto di output.	Sì
Stato	OpenAI.FunctionCallOutputStatusEnum		Sì
type	enum	Tipo dell'output delle chiamate dello strumento personalizzato. Sempre `custom_tool_call_output`. Valori possibili: `custom_tool_call_output`	Sì

OpenAI.OutputItemCustomToolCallResource

RispondenzaToolChiamataOggetto

Name	Type	Description	Obbligatorio
call_id	string	Identificatore usato per eseguire il mapping di questa chiamata personalizzata a un output di chiamata dello strumento.	Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
id	string	ID univoco della chiamata dello strumento personalizzato nella piattaforma OpenAI.	No
input	string	Input per la chiamata personalizzata dello strumento generata dal modello.	Sì
nome	string	Nome dello strumento personalizzato chiamato.	Sì
namespace	string	Il namespace dello strumento personalizzato che viene chiamato.	No
Stato	OpenAI.FunctionCallStatus		Sì
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre `custom_tool_call`. Valori possibili: `custom_tool_call`	Sì

OpenAI.OutputItemFileSearchToolCall

Chiamata allo strumento di ricerca file

Risultati di una chiamata allo strumento di ricerca file.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata allo strumento per la ricerca dei file.	Sì
queries	matrice di valori string	Le interrogazioni usate per cercare i file.	Sì
results	matrice di OpenAI.FileSearchToolCallResults o null		No
Stato	enum	Stato della chiamata allo strumento di ricerca file. Uno di `in_progress`, `searching`, `incomplete` o `failed`, Valori possibili: `in_progress`, `searchingcompleted`, , `incomplete`,`failed`	Sì
type	enum	Tipo di chiamata allo strumento di ricerca file. Sempre `file_search_call`. Valori possibili: `file_search_call`	Sì

OpenAI.OutputItemFunctionShellCall

Chiamata dello strumento shell

Chiamata dello strumento che esegue uno o più comandi della shell in un ambiente gestito.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.FunctionShellAction	Eseguire un comando shell.	Sì
Comandi └*	matrice di valori string		Sì
└max_output_length	integer o null		Sì
└timeout_ms	integer o null		Sì
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello.	Sì
creato_da	string	ID dell'entità che ha creato questa chiamata allo strumento.	No
environment	OpenAI.FunctionShellCallEnvironment o null		Sì
id	string	ID univoco della chiamata dello strumento shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
Stato	OpenAI.FunctionShellCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre `shell_call`. Valori possibili: `shell_call`	Sì	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Output chiamata shell

Output di una chiamata dello strumento shell generata.

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello.	Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
id	string	ID univoco dell'output della chiamata della shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
max_output_length	integer o null		Sì
output	matrice di OpenAI.FunctionShellCallOutputContent	Matrice di contenuti di output delle chiamate shell	Sì
Stato	OpenAI.FunctionShellCallOutputStatusEnum		Sì
type	enum	Tipo dell'output delle chiamate della shell. Sempre `shell_call_output`. Valori possibili: `shell_call_output`	Sì	shell_call_output

OpenAI.OutputItemFunctionToolCall

Chiamata dello strumento funzionale

Chiamata di uno strumento per eseguire una funzione.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON degli argomenti da passare alla funzione.	Sì
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string (sola lettura)	ID univoco della chiamata dello strumento di funzione.	Sì
nome	string	Nome della funzione da eseguire.	Sì
namespace	string	Il namespace della funzione da eseguire.	No
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di chiamata dello strumento di funzione. Sempre `function_call`. Valori possibili: `function_call`	Sì

OpenAI.OutputItemFunctionToolCallOutput

Uscita chiamata dello strumento di funzione

Output di una chiamata dello strumento di funzione.

Name	Type	Description	Obbligatorio
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string (sola lettura)	ID univoco dell'output della chiamata dello strumento di funzione. Popolato quando questo elemento viene restituito tramite l'API.	Sì
output	stringa o matrice di OpenAI.FunctionAndCustomToolCallOutput	Output della chiamata di funzione generata dal codice. Può essere una stringa o un elenco di contenuto di output.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
type	enum	Tipo di output della chiamata dello strumento di funzione. Sempre `function_call_output`. Valori possibili: `function_call_output`	Sì

OpenAI.OutputItemImageGenToolCall

Chiamata di generazione immagini

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa o null		Sì
Stato	enum	Stato della chiamata di generazione dell'immagine. Valori possibili: `in_progress`, `completed`, `generating`, `failed`	Sì
type	enum	Tipo della chiamata di generazione dell'immagine. Sempre `image_generation_call`. Valori possibili: `image_generation_call`	Sì

OpenAI.OutputItemLocalShellToolCall

Chiamata locale di shell

Chiamata dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio
action	OpenAI.LocalShellExecAction	Eseguire un comando shell nel server.	Sì
call_id	string	ID univoco della chiamata dello strumento shell locale generata dal modello.	Sì
id	string	ID univoco della chiamata della shell locale.	Sì
Stato	enum	Stato della chiamata della shell locale. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo di chiamata della shell locale. Sempre `local_shell_call`. Valori possibili: `local_shell_call`	Sì

OpenAI.OutputItemLocalShellToolCallOutput

Uscita locale di chiamata shell

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio
id	string	ID univoco della chiamata dello strumento shell locale generata dal modello.	Sì
output	string	Stringa JSON dell'output della chiamata allo strumento shell locale.	Sì
Stato	stringa o null		No
type	enum	Tipo dell'output delle chiamate dello strumento shell locale. Sempre `local_shell_call_output`. Valori possibili: `local_shell_call_output`	Sì

OpenAI.OutputItemMcpApprovalRequest

Richiesta di approvazione MCP

Richiesta di approvazione umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON di argomenti per lo strumento.	Sì
id	string	ID univoco della richiesta di approvazione.	Sì
nome	string	Nome dello strumento da eseguire.	Sì
etichetta del server	string	Etichetta del server MCP che effettua la richiesta.	Sì
type	enum	Tipo dell'elemento. Sempre `mcp_approval_request`. Valori possibili: `mcp_approval_request`	Sì

OpenAI.OutputItemMcpApprovalResponseResource

Risposta all'approvazione del MCP

Risposta a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio
approval_request_id	string	ID della richiesta di approvazione a cui si sta rispondendo.	Sì
approve	boolean	Indica se la richiesta è stata approvata.	Sì
id	string	ID univoco della risposta di approvazione	Sì
reason	stringa o null		No
type	enum	Tipo dell'elemento. Sempre `mcp_approval_response`. Valori possibili: `mcp_approval_response`	Sì

OpenAI.OutputItemMcpListTools

Strumenti per liste MCP

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio
error	OpenAI.RealtimeMCPError		No
id	string	ID univoco dell'elenco.	Sì
etichetta del server	string	Etichetta del server MCP.	Sì
Strumenti	matrice di OpenAI.MCPListToolsTool	Strumenti disponibili nel server.	Sì
type	enum	Tipo dell'elemento. Sempre `mcp_list_tools`. Valori possibili: `mcp_list_tools`	Sì

OpenAI.OutputItemMcpToolCall

Chiamata allo strumento MCP

Chiamata di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio
approval_request_id	stringa o null		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	OpenAI.RealtimeMCPError		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa o null		No
etichetta del server	string	Etichetta del server MCP che esegue lo strumento.	Sì
Stato	OpenAI.MCPToolCallStatus		No
type	enum	Tipo dell'elemento. Sempre `mcp_call`. Valori possibili: `mcp_call`	Sì

OpenAI.OutputItemOutputMessage

Messaggio di uscita

Messaggio di output del modello.

Name	Type	Description	Obbligatorio
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
Fase	OpenAI.MessagePhase o null		No
Ruolo	enum	Ruolo del messaggio di output. Sempre `assistant`. Valori possibili: `assistant`	Sì
Stato	enum	Stato dell'input del messaggio. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi di input vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	Sì
type	enum	Tipo del messaggio di output. Sempre `message`. Valori possibili: `output_message`	Sì

OpenAI.OutputItemReasoningItem

Reasoning

Name	Type	Description	Obbligatorio
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa o null		No
id	string	Identificatore univoco del contenuto di ragionamento.	Sì
Stato	enum	Stato dell'elemento. Uno di `in_progress`, `completed`, o `incomplete`. Popolato quando gli elementi vengono restituiti tramite l'API. Valori possibili: `in_progress`, `completed`, `incomplete`	No
summary	array di OpenAI.SummaryTextContent	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre `reasoning`. Valori possibili: `reasoning`	Sì

OpenAI.OutputItemToolSearchCall

Name	Type	Description	Obbligatorio	Predefinito
arguments		Argomenti usati per la chiamata di ricerca dello strumento.	Sì
call_id	stringa o null		Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
esecuzione	OpenAI.ToolSearchExecutionType		Sì
id	string	L'ID unico dell'elemento di ricerca dello strumento.	Sì
Stato	OpenAI.FunctionCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre `tool_search_call`. Valori possibili: `tool_search_call`	Sì	tool_search_call

OpenAI.OutputItemToolSearchOutput

Name	Type	Description	Obbligatorio	Predefinito
call_id	stringa o null		Sì
creato_da	string	Identificatore dell'attore che ha creato l'elemento.	No
esecuzione	OpenAI.ToolSearchExecutionType		Sì
id	string	L'ID unico dell'elemento di ricerca dello strumento.	Sì
Stato	OpenAI.FunctionCallOutputStatusEnum		Sì
Strumenti	matrice di OpenAI.Tool	Le definizioni degli strumenti caricati restituite tramite la ricerca degli strumenti.	Sì
type	enum	Tipo dell'elemento. Sempre `tool_search_output`. Valori possibili: `tool_search_output`	Sì	tool_search_output

OpenAI.OutputItemType

Proprietà Value

Type string

Valori 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

Chiamata allo strumento di ricerca web

Risultati di una chiamata allo strumento di ricerca Web.

Name	Type	Description	Obbligatorio
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include dettagli su come il modello utilizzava il web (ricerca, open_page, find_in_page).	Sì
id	string	ID univoco della chiamata dello strumento di ricerca Web.	Sì
Stato	enum	Stato della chiamata dello strumento di ricerca Web. Valori possibili: `in_progress`, `searching`, `completed`, `failed`	Sì
type	enum	Tipo di chiamata dello strumento di ricerca Web. Sempre `web_search_call`. Valori possibili: `web_search_call`	Sì

OpenAI.OutputMessageContent

Discriminatorio per OpenAI.OutputMessageContent

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.OutputMessageContentType		Sì

OpenAI.OutputMessageContentOutputTextContent

Testo in uscita

Output di testo del modello.

Name	Type	Description	Obbligatorio	Predefinito
annotations	matrice di OpenAI.Annotation	Annotazioni dell'output di testo.	Sì
logprobs	matrice di OpenAI.LogProb		Sì
text	string	L'output di testo generato dal modello.	Sì
type	enum	Tipo del testo di uscita. Sempre `output_text`. Valori possibili: `output_text`	Sì	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

Rifiuto da parte del modello.

Name	Type	Description	Obbligatorio	Predefinito
refusal	string	Spiegazione del rifiuto da parte del modello.	Sì
type	enum	Tipo di rifiuto. Sempre `refusal`. Valori possibili: `refusal`	Sì	refusal

OpenAI.OutputMessageContentType

Proprietà	Value
Type	string
Valori	`output_text` `refusal`

OpenAI.Prompt

Riferimento a un modello di richiesta e alle relative variabili.

Name	Type	Description	Obbligatorio
id	string	Identificatore univoco del modello di richiesta da usare.	Sì
variables	OpenAI.ResponsePromptVariables o null		No
version	stringa o null		No

OpenAI.RankerVersionType

Proprietà	Value
Type	string
Valori	`auto` `default-2024-11-15`

OpenAI.OpzioniDiClassifica

Name	Type	Description	Obbligatorio
hybrid_search	OpenAI.HybridSearchOptions		No
└embedding_weight	Numero	Peso dell'incorporamento nella fusione di rango reciproca.	Sì
└text_weight	Numero	Peso del testo nella fusione di rango reciproco.	Sì
classificatore	OpenAI.RankerVersionType		No
soglia_punteggio	Numero	Soglia del punteggio per la ricerca di file, un numero compreso tra 0 e 1. I numeri più vicini a 1 tenteranno di restituire solo i risultati più rilevanti, ma potrebbero restituire meno risultati.	No

OpenAI.RealtimeMCPError

Discriminatore per OpenAI.RealtimeMCPError

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.RealtimeMcpErrorType		Sì

OpenAI.RealtimeMCPHTTPError

Errore HTTP MCP in tempo reale

Name	Type	Description	Obbligatorio
codice	integer		Sì
message	string		Sì
type	enum	Valori possibili: `http_error`	Sì

OpenAI.RealtimeMCPProtocolError

Errore del protocollo MCP in tempo reale

Name	Type	Description	Obbligatorio
codice	integer		Sì
message	string		Sì
type	enum	Valori possibili: `protocol_error`	Sì

OpenAI.RealtimeMCPToolExecutionError

Errore di esecuzione dello strumento MCP in tempo reale

Name	Type	Description	Obbligatorio	Predefinito
message	string		Sì
type	enum	Valori possibili: `tool_execution_error`	Sì

OpenAI.RealtimeMcpErrorType

Proprietà	Value
Type	string
Valori	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

Reasoning

Solo modelli gpt-5 e serie O Opzioni di configurazione per i modelli di ragionamento.

Name	Type	Description	Obbligatorio
effort	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono `none`, `minimal`, `lowmedium`, , `high`e `xhigh`. Ridurre l'impegno di ragionamento può comportare risposte più veloci e meno token usati sul ragionamento in una risposta. - `gpt-5.1` il valore predefinito è `none`, che non esegue il ragionamento. I valori di ragionamento supportati per `gpt-5.1` sono `none`, `low`, `medium`e `high`. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. - Tutti i modelli prima `gpt-5.1` di eseguire il ragionamento per impostazione predefinita `medium` e non supportano `none`. - Il `gpt-5-pro` modello usa per impostazione predefinita (e supporta solo) `high` il ragionamento. - `xhigh` è supportato per tutti i modelli dopo `gpt-5.1-codex-max`.	No
generate_summary	stringa o null		No
summary	stringa o null		No

Sforzo di Ragionamento OpenAI

Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, lowmedium, , highe xhigh. Ridurre lo sforzo di ragionamento può portare a risposte più rapide e a meno token utilizzati per ragionare in una risposta.

gpt-5.1 il valore predefinito è none, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 sono none, low, mediume high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1.
Tutti i modelli prima gpt-5.1 del medium ragionamento predefinito e non supportano none.
Il gpt-5-pro modello usa per impostazione predefinita (e supporta solo) high il ragionamento.
xhigh è supportato per tutti i modelli dopo gpt-5.1-codex-max.

Proprietà	Value
Descrizione	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono `none`, `minimal`, `lowmedium`, , `high`e `xhigh`. Ridurre l'impegno di ragionamento può comportare risposte più veloci e meno token usati sul ragionamento in una risposta. - `gpt-5.1` il valore predefinito è `none`, che non esegue il ragionamento. I valori di ragionamento supportati per `gpt-5.1` sono `none`, `low`, `medium`e `high`. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. - Tutti i modelli prima `gpt-5.1` di eseguire il ragionamento per impostazione predefinita `medium` e non supportano `none`. - Il `gpt-5-pro` modello usa per impostazione predefinita (e supporta solo) `high` il ragionamento. - `xhigh` è supportato per tutti i modelli dopo `gpt-5.1-codex-max`.
Type	string
Valori	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Testo di ragionamento

Ragionamento del testo dal modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Testo di ragionamento del modello.	Sì
type	enum	Tipo del testo di ragionamento. Sempre `reasoning_text`. Valori possibili: `reasoning_text`	Sì	reasoning_text

OpenAI.Response

L'oggetto risposta

Name	Type	Description	Obbligatorio	Predefinito
sfondo	booleano o null		No
completed_at	stringa o null		No
content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
conversazione	OpenAI.ConversationReference o Null		No
creato_il	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
error	OpenAI.ResponseError o null		Sì
id	string	Identificatore univoco per questa risposta.	Sì
incomplete_details	OpenAI.ResponseIncompleteDetails o null		Sì
instructions	stringa o matrice di OpenAI.InputItem o null		Sì
max_output_tokens	integer o null		No
max_tool_calls	integer o null		No
metadata	OpenAI.Metadata o Null		No
model	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
object	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
output	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
output_text	stringa o null		No
chiamate_parallele_agli_strumenti	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
previous_response_id	stringa o null		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
prompt_cache_retention	stringa o null		No
reasoning	OpenAI.Reasoning o null		No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
Stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
Temperatura	number o null		No
text	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
top_logprobs	integer o null		No
top_p	number o null		No
truncation	stringa o null		No
uso	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
user	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No

OpenAI.ResponseAudioDeltaEvent

Generato quando è presente una risposta audio parziale.

Name	Type	Description	Obbligatorio
delta	string	Blocco di byte audio della risposta con codifica Base64. Vincoli: codifica: base64	Sì
sequence_number	integer	Numero di sequenza per questo blocco della risposta del flusso.	Sì
type	enum	Tipo di evento. Sempre `response.audio.delta`. Valori possibili: `response.audio.delta`	Sì

OpenAI.ResponseAudioDoneEvent

Generato al termine della risposta audio.

Name	Type	Description	Obbligatorio	Predefinito
sequence_number	integer	Il numero di sequenza del delta.	Sì
type	enum	Tipo di evento. Sempre `response.audio.done`. Valori possibili: `response.audio.done`	Sì

OpenAI.ResponseAudioTranscriptDeltaEvent

Generato quando è presente una trascrizione parziale dell'audio.

Name	Type	Description	Obbligatorio
delta	string	Trascrizione parziale della risposta audio.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.audio.transcript.delta`. Valori possibili: `response.audio.transcript.delta`	Sì

OpenAI.ResponseAudioTranscriptDoneEvent

Generato al termine della trascrizione audio completa.

Name	Type	Description	Obbligatorio	Predefinito
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.audio.transcript.done`. Valori possibili: `response.audio.transcript.done`	Sì

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Generato quando un frammento di codice parziale viene trasmesso dall'interprete di codice.

Name	Type	Description	Obbligatorio
delta	string	Frammento di codice parziale trasmesso dall'interprete di codice.	Sì
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	integer	Indice dell'elemento di output nella risposta per cui viene trasmesso il codice.	Sì
sequence_number	integer	Numero di sequenza di questo evento, utilizzato per ordinare gli eventi di streaming.	Sì
type	enum	Tipo di evento. Sempre `response.code_interpreter_call_code.delta`. Valori possibili: `response.code_interpreter_call_code.delta`	Sì

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Generato quando il frammento di codice viene finalizzato dall'interprete di codice.

Name	Type	Description	Obbligatorio
codice	string	Output finale del frammento di codice generato dall'interprete di codice.	Sì
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	integer	Indice dell'elemento di output nella risposta per cui viene finalizzato il codice.	Sì
sequence_number	integer	Numero di sequenza di questo evento, utilizzato per ordinare gli eventi di streaming.	Sì
type	enum	Tipo di evento. Sempre `response.code_interpreter_call_code.done`. Valori possibili: `response.code_interpreter_call_code.done`	Sì

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Generato al termine della chiamata dell'interprete del codice.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	integer	Indice dell'elemento di output nella risposta per cui viene completata la chiamata dell'interprete del codice.	Sì
sequence_number	integer	Numero di sequenza di questo evento, utilizzato per ordinare gli eventi di streaming.	Sì
type	enum	Tipo di evento. Sempre `response.code_interpreter_call.completed`. Valori possibili: `response.code_interpreter_call.completed`	Sì

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Generato quando è in corso una chiamata a un interprete di codice.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	integer	Indice dell'elemento di output nella risposta per cui è in corso la chiamata dell'interprete del codice.	Sì
sequence_number	integer	Numero di sequenza di questo evento, utilizzato per ordinare gli eventi di streaming.	Sì
type	enum	Tipo di evento. Sempre `response.code_interpreter_call.in_progress`. Valori possibili: `response.code_interpreter_call.in_progress`	Sì

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Generato quando l'interprete di codice interpreta attivamente il frammento di codice.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	integer	Indice dell'elemento di output nella risposta per cui l'interprete del codice interpreta il codice.	Sì
sequence_number	integer	Numero di sequenza di questo evento, utilizzato per ordinare gli eventi di streaming.	Sì
type	enum	Tipo di evento. Sempre `response.code_interpreter_call.interpreting`. Valori possibili: `response.code_interpreter_call.interpreting`	Sì

OpenAI.ResponseCompletedEvent

Generato al termine della risposta del modello.

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└* sfondo	booleano o null		No
└completed_at	stringa o null (unixTimestamp)		No
└content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
└* conversazione	OpenAI.ConversationReference o Null		No
└created_at	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError o null		Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails o null		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem o null		Sì
└ max_output_tokens	integer o null		No
└max_tool_calls	integer o null		No
└─ metadati	OpenAI.Metadata o Null		No
└─ Modello	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
└─ oggetto	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
└─ uscita	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
└output_text	stringa o null		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa o null		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
└prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
└prompt_cache_retention	stringa o null		No
└* ragionamento	OpenAI.Reasoning o null		No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
└─ stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
└* temperatura	number o null		No	1
└─ testo	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
└tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti └*	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	integer o null		No
└top_p	number o null		No	1
└─ troncamento	stringa o null		No	disabled
└─ utilizzo	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
└─ utente	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No
sequence_number	integer	Numero di sequenza per questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.completed`. Valori possibili: `response.completed`	Sì

OpenAI.ResponseContentPartAddedEvent

Generato quando viene aggiunta una nuova parte di contenuto.

Name	Type	Description	Obbligatorio
content_index	integer	Indice della parte di contenuto aggiunta.	Sì
item_id	string	ID dell'elemento di output a cui è stata aggiunta la parte di contenuto.	Sì
output_index	integer	Indice dell'elemento di output a cui è stata aggiunta la parte di contenuto.	Sì
part	OpenAI.OutputContent		Sì
└─ Tipo	OpenAI.OutputContentType		Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.content_part.added`. Valori possibili: `response.content_part.added`	Sì

OpenAI.ResponseContentPartDoneEvent

Generato al termine di una parte del contenuto.

Name	Type	Description	Obbligatorio
content_index	integer	Indice della parte di contenuto eseguita.	Sì
item_id	string	ID dell'elemento di output a cui è stata aggiunta la parte di contenuto.	Sì
output_index	integer	Indice dell'elemento di output a cui è stata aggiunta la parte di contenuto.	Sì
part	OpenAI.OutputContent		Sì
└─ Tipo	OpenAI.OutputContentType		Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.content_part.done`. Valori possibili: `response.content_part.done`	Sì

OpenAI.ResponseCreatedEvent

Evento generato quando viene creata una risposta.

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└* sfondo	booleano o null		No
└completed_at	stringa o null (unixTimestamp)		No
└content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
└* conversazione	OpenAI.ConversationReference o Null		No
└created_at	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError o null		Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails o null		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem o null		Sì
└ max_output_tokens	integer o null		No
└max_tool_calls	integer o null		No
└─ metadati	OpenAI.Metadata o Null		No
└─ Modello	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
└─ oggetto	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
└─ uscita	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
└output_text	stringa o null		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa o null		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
└prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
└prompt_cache_retention	stringa o null		No
└* ragionamento	OpenAI.Reasoning o null		No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
└─ stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
└* temperatura	number o null		No	1
└─ testo	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
└tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti └*	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	integer o null		No
└top_p	number o null		No	1
└─ troncamento	stringa o null		No	disabled
└─ utilizzo	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
└─ utente	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No
sequence_number	integer	Numero di sequenza per questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.created`. Valori possibili: `response.created`	Sì

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

Evento che rappresenta un delta (aggiornamento parziale) per l'input di una chiamata personalizzata allo strumento.

Name	Type	Description	Obbligatorio
delta	string	Dati di input incrementali (delta) per la chiamata allo strumento personalizzato.	Sì
item_id	string	Identificatore univoco per l'elemento API associato a questo evento.	Sì
output_index	integer	L'indice dell'output a cui si applica questo delta.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Identificatore del tipo di evento. Valori possibili: `response.custom_tool_call_input.delta`	Sì

OpenAI.ResponseCustomToolCallInputDoneEvent

RispostaToolPersonalizzatoChiamataInputCompletato

Evento che indica che l'input per una chiamata personalizzata dello strumento è stato completato.

Name	Type	Description	Obbligatorio
input	string	Dati di input completi per la chiamata allo strumento personalizzato.	Sì
item_id	string	Identificatore univoco per l'elemento API associato a questo evento.	Sì
output_index	integer	L'indice dell'output a cui si applica questo evento.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Identificatore del tipo di evento. Valori possibili: `response.custom_tool_call_input.done`	Sì

OpenAI.ResponseError

Oggetto di errore restituito quando il modello non riesce a generare una risposta.

Name	Type	Description	Obbligatorio	Predefinito
codice	OpenAI.ResponseErrorCode	Codice di errore per la risposta.	Sì
message	string	Una descrizione leggibile dall'uomo dell'errore.	Sì

OpenAI.ResponseErrorCode

Codice di errore per la risposta.

Proprietà	Value
Type	string
Valori	`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

Generato quando si verifica un errore.

Name	Type	Description	Obbligatorio
codice	stringa o null		Sì
message	string	Messaggio di errore.	Sì
param	stringa o null		Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `error`. Valori possibili: `error`	Sì

OpenAI.ResponseFailedEvent

Evento generato quando una risposta ha esito negativo.

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└* sfondo	booleano o null		No
└completed_at	stringa o null (unixTimestamp)		No
└content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
└* conversazione	OpenAI.ConversationReference o Null		No
└created_at	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError o null		Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails o null		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem o null		Sì
└ max_output_tokens	integer o null		No
└max_tool_calls	integer o null		No
└─ metadati	OpenAI.Metadata o Null		No
└─ Modello	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
└─ oggetto	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
└─ uscita	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
└output_text	stringa o null		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa o null		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
└prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
└prompt_cache_retention	stringa o null		No
└* ragionamento	OpenAI.Reasoning o null		No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
└─ stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
└* temperatura	number o null		No	1
└─ testo	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
└tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti └*	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	integer o null		No
└top_p	number o null		No	1
└─ troncamento	stringa o null		No	disabled
└─ utilizzo	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
└─ utente	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.failed`. Valori possibili: `response.failed`	Sì

OpenAI.ResponseFileSearchCallCompletedEvent

Generato quando viene completata una chiamata di ricerca file (risultati trovati).

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
output_index	integer	Indice dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.file_search_call.completed`. Valori possibili: `response.file_search_call.completed`	Sì

OpenAI.ResponseFileSearchCallInProgressEvent

Generato quando viene avviata una chiamata di ricerca file.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
output_index	integer	Indice dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.file_search_call.in_progress`. Valori possibili: `response.file_search_call.in_progress`	Sì

OpenAI.ResponseFileSearchCallSearchingEvent

Generato quando una ricerca di file è attualmente in corso.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
output_index	integer	L'indice dell'elemento di output che la chiamata di ricerca file sta cercando.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.file_search_call.searching`. Valori possibili: `response.file_search_call.searching`	Sì

OpenAI.ResponseFormatJsonSchemaSchema

Schema JSON

Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.

Tipo: oggetto

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Generato quando è presente un delta degli argomenti di chiamata di funzione parziale.

Name	Type	Description	Obbligatorio
delta	string	Delta degli argomenti di chiamata di funzione aggiunto.	Sì
item_id	string	ID dell'elemento di output a cui viene aggiunto il delta degli argomenti di chiamata di funzione.	Sì
output_index	integer	Indice dell'elemento di output a cui viene aggiunto il delta degli argomenti di chiamata di funzione.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.function_call_arguments.delta`. Valori possibili: `response.function_call_arguments.delta`	Sì

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Generato quando gli argomenti della chiamata di funzione vengono finalizzati.

Name	Type	Description	Obbligatorio
arguments	string	Argomenti di chiamata di funzione.	Sì
item_id	string	ID dell'elemento.	Sì
nome	string	Il nome della funzione chiamata.	Sì
output_index	integer	Indice dell'elemento di output.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Valori possibili: `response.function_call_arguments.done`	Sì

OpenAI.ResponseImageGenCallCompletedEvent

RipostazioneImmagineGenChiamataEventoCompletatoT

Generato quando una chiamata dello strumento di generazione di immagini è stata completata e l'immagine finale è disponibile.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre «response.image_generation_call.completed». Valori possibili: `response.image_generation_call.completed`	Sì

OpenAI.ResponseImageGenCallGeneratingEvent

ResponseImageGenCallGeneratingEvent

Generato quando una chiamata dello strumento di generazione di immagini genera attivamente un'immagine (stato intermedio).

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza dell'elemento di generazione dell'immagine da elaborare.	Sì
type	enum	Tipo di evento. Sempre "response.image_generation_call.generating". Valori possibili: `response.image_generation_call.generating`	Sì

OpenAI.ResponseImageGenCallInProgressEvent

RispostaImmagineGenChiamataInProgressEvento

Generato quando è in corso una chiamata dello strumento di generazione di immagini.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza dell'elemento di generazione dell'immagine da elaborare.	Sì
type	enum	Tipo di evento. Sempre 'response.image_generation_call.in_progress'. Valori possibili: `response.image_generation_call.in_progress`	Sì

OpenAI.ResponseImageGenCallPartialImageEvent

RispostaImmagineGenChiamataImmaginePartialeEvento

Generato quando un'immagine parziale è disponibile durante il flusso di generazione di immagini.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
partial_image_b64	string	Dati di immagine parziali codificati in Base64, adatti per il rendering come immagine.	Sì
partial_image_index	integer	Indice in base 0 per l'immagine parziale (il back-end è basato su 1, ma questo è basato su 0 per l'utente).	Sì
sequence_number	integer	Numero di sequenza dell'elemento di generazione dell'immagine da elaborare.	Sì
type	enum	Tipo di evento. Sempre 'response.image_generation_call.partial_image'. Valori possibili: `response.image_generation_call.partial_image`	Sì

OpenAI.ResponseInProgressEvent

Generato quando la risposta è in corso.

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└* sfondo	booleano o null		No
└completed_at	stringa o null (unixTimestamp)		No
└content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
└* conversazione	OpenAI.ConversationReference o Null		No
└created_at	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError o null		Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails o null		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem o null		Sì
└ max_output_tokens	integer o null		No
└max_tool_calls	integer o null		No
└─ metadati	OpenAI.Metadata o Null		No
└─ Modello	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
└─ oggetto	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
└─ uscita	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
└output_text	stringa o null		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa o null		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
└prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
└prompt_cache_retention	stringa o null		No
└* ragionamento	OpenAI.Reasoning o null		No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
└─ stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
└* temperatura	number o null		No	1
└─ testo	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
└tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti └*	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	integer o null		No
└top_p	number o null		No	1
└─ troncamento	stringa o null		No	disabled
└─ utilizzo	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
└─ utente	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.in_progress`. Valori possibili: `response.in_progress`	Sì

OpenAI.ResponseIncompleteDetails

Name	Type	Description	Obbligatorio	Predefinito
reason	enum	Valori possibili: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

L'evento che viene emesso quando una risposta si conclude come incompleta.

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└* sfondo	booleano o null		No
└completed_at	stringa o null (unixTimestamp)		No
└content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
└* conversazione	OpenAI.ConversationReference o Null		No
└created_at	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError o null		Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails o null		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem o null		Sì
└ max_output_tokens	integer o null		No
└max_tool_calls	integer o null		No
└─ metadati	OpenAI.Metadata o Null		No
└─ Modello	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
└─ oggetto	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
└─ uscita	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
└output_text	stringa o null		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa o null		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
└prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
└prompt_cache_retention	stringa o null		No
└* ragionamento	OpenAI.Reasoning o null		No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
└─ stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
└* temperatura	number o null		No	1
└─ testo	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
└tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti └*	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	integer o null		No
└top_p	number o null		No	1
└─ troncamento	stringa o null		No	disabled
└─ utilizzo	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
└─ utente	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.incomplete`. Valori possibili: `response.incomplete`	Sì

OpenAI.ResponseItemList

Elenco di elementi di risposta.

Name	Type	Description	Obbligatorio
data	matrice di OpenAI.ItemResource	Elenco di elementi utilizzati per generare questa risposta.	Sì
first_id	string	ID del primo elemento dell'elenco.	Sì
ha_di_piu	boolean	Indica se sono disponibili altri elementi.	Sì
last_id	string	ID dell'ultimo elemento nell'elenco.	Sì
object	enum	Il tipo di oggetto restituito deve essere `list`. Valori possibili: `list`	Sì

OpenAI.ResponseLogProb

Un logprob è la probabilità logaritmica assegnata dal modello alla produzione di un token specifico in una determinata posizione nella sequenza. I valori di logprob meno negativi (superiori) indicano maggiore attendibilità del modello in tale scelta di token.

Name	Type	Description	Obbligatorio
logprob	Numero	Probabilità del log di questo token.	Sì
token	string	Un possibile token di testo.	Sì
top_logprobs	matrice di OpenAI.ResponseLogProbTopLogprobs	Le probabilità logarime di fino a 20 dei token più probabili.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Obbligatorio	Predefinito
logprob	Numero		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

RispostaMCPCallArgomentiEvento Delta

Generato quando è presente un delta (aggiornamento parziale) agli argomenti di una chiamata allo strumento MCP.

Name	Type	Description	Obbligatorio
delta	string	Stringa JSON contenente l'aggiornamento parziale agli argomenti per la chiamata allo strumento MCP.	Sì
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre "response.mcp_call_arguments.delta". Valori possibili: `response.mcp_call_arguments.delta`	Sì

OpenAI.ResponseMCPCallArgumentsDoneEvent

RispostaMCPCallArgomentiFattoEvento

Generato quando gli argomenti per una chiamata allo strumento MCP vengono finalizzati.

Name	Type	Description	Obbligatorio
arguments	string	Stringa JSON contenente gli argomenti finali per la chiamata allo strumento MCP.	Sì
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre 'response.mcp_call_arguments.done'. Valori possibili: `response.mcp_call_arguments.done`	Sì

OpenAI.ResponseMCPCallCompletedEvent

ResponseMCPCallCompletedEvent

Generato quando una chiamata allo strumento MCP è stata completata correttamente.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di chiamata dello strumento MCP completato.	Sì
output_index	integer	L'indice dell'elemento in uscita completato.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre "response.mcp_call.completed". Valori possibili: `response.mcp_call.completed`	Sì

OpenAI.ResponseMCPCallFailedEvent

EventoFallitoRispostaMCPCallFallito

Generato quando una chiamata allo strumento MCP non è riuscita.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di chiamata dello strumento MCP non riuscito.	Sì
output_index	integer	Indice dell'elemento di output non riuscito.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Lasciare invariato 'response.mcp_call.failed'. Valori possibili: `response.mcp_call.failed`	Sì

OpenAI.ResponseMCPCallInProgressEvent

ResponseMCPCallInProgressEvent

Generato quando è in corso una chiamata allo strumento MCP.

Name	Type	Description	Obbligatorio
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre 'response.mcp_call.in_progress'. Valori possibili: `response.mcp_call.in_progress`	Sì

OpenAI.ResponseMCPListToolsCompletedEvent

RispostaMCPListToolsCompletedEvent.

Generato quando l'elenco degli strumenti MCP disponibili è stato recuperato correttamente.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di chiamata dello strumento MCP che ha generato questo output.	Sì
output_index	integer	L'indice dell'elemento in uscita che è stato elaborato.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre "response.mcp_list_tools.completed". Valori possibili: `response.mcp_list_tools.completed`	Sì

OpenAI.ResponseMCPListToolsFailedEvent

RispostaMCPListToolsFailedEvent

Generato quando il tentativo di elencare gli strumenti MCP disponibili non è riuscito.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di chiamata dello strumento MCP non riuscito.	Sì
output_index	integer	Indice dell'elemento di output non riuscito.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre 'response.mcp_list_tools.failed'. Valori possibili: `response.mcp_list_tools.failed`	Sì

OpenAI.ResponseMCPListToolsInProgressEvent

ResponseMCPListToolsInProgressEvent

Generato quando il sistema è in corso di recupero dell'elenco degli strumenti MCP disponibili.

Name	Type	Description	Obbligatorio
item_id	string	ID dell'elemento di chiamata dello strumento MCP in fase di elaborazione.	Sì
output_index	integer	Indice dell'elemento di output da elaborare.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre 'response.mcp_list_tools.in_progress'. Valori possibili: `response.mcp_list_tools.in_progress`	Sì

OpenAI.ResponseOutputItemAddedEvent

Generato quando viene aggiunto un nuovo elemento di output.

Name	Type	Description	Obbligatorio
oggetto	OpenAI.OutputItem		Sì
└─ Tipo	OpenAI.OutputItemType		Sì
output_index	integer	Indice dell'elemento di output aggiunto.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.output_item.added`. Valori possibili: `response.output_item.added`	Sì

OpenAI.ResponseOutputItemDoneEvent

Generato quando un elemento di output viene contrassegnato come completato.

Name	Type	Description	Obbligatorio
oggetto	OpenAI.OutputItem		Sì
└─ Tipo	OpenAI.OutputItemType		Sì
output_index	integer	Indice dell'elemento di output contrassegnato come completato.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.output_item.done`. Valori possibili: `response.output_item.done`	Sì

OpenAI.ResponseOutputTextAnnotationAddedEvent

RispostaOutputTestoAnnotazioneAggiuntoEvento

Generato quando viene aggiunta un'annotazione al contenuto di testo di output.

Name	Type	Description	Obbligatorio
Annotazione	OpenAI.Annotation	Annotazione applicabile a un intervallo di testo di output.	Sì
└─ Tipo	OpenAI.AnnotationType		Sì
annotation_index	integer	Indice dell'annotazione all'interno della parte del contenuto.	Sì
content_index	integer	Indice della parte di contenuto all'interno dell'elemento di output.	Sì
item_id	string	Identificatore univoco dell'elemento a cui viene aggiunta l'annotazione.	Sì
output_index	integer	Indice dell'elemento di output nella matrice di output della risposta.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre 'response.output_text.annotation.added'. Valori possibili: `response.output_text.annotation.added`	Sì

OpenAI.ResponsePromptVariables

Variabili di prompt

Mapping facoltativo dei valori da sostituire con le variabili nel prompt. I valori di sostituzione possono essere stringhe o altri tipi di input response, ad esempio immagini o file.

Tipo: oggetto

OpenAI.ResponseQueuedEvent

ResponseQueuedEvent

Generato quando una risposta viene accodata e in attesa di essere elaborata.

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└* sfondo	booleano o null		No
└completed_at	stringa o null (unixTimestamp)		No
└content_filters	matrice di AzureContentFilterForResponsesAPI	Il filtro contenuto restituisce i risultati di RAI.	No
└* conversazione	OpenAI.ConversationReference o Null		No
└created_at	intero (unixtime)	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError o null		Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails o null		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem o null		Sì
└ max_output_tokens	integer o null		No
└max_tool_calls	integer o null		No
└─ metadati	OpenAI.Metadata o Null		No
└─ Modello	string	ID modello usato per generare la risposta, ad esempio `gpt-4o` o `o3`. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, prestazioni caratteristiche e punti di prezzo. Consulta la guida ai modelli per esplorare e confrontare i modelli disponibili.	No
└─ oggetto	enum	Tipo di oggetto di questa risorsa: sempre impostato su `response`. Valori possibili: `response`	Sì
└─ uscita	matrice di OpenAI.OutputItem	Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella `output` matrice dipendono sulla risposta del modello. - Anziché accedere al primo elemento nella `output` matrice e presupponendo che si tratti di un `assistant` messaggio con il contenuto generato da il modello, è consigliabile usare la proprietà `output_text` se supportato negli SDK.	Sì
└output_text	stringa o null		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa o null		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili.	No
└prompt_cache_key	string	Usato da OpenAI per memorizzare nella cache le risposte per richieste simili per ottimizzare la frequenza di riscontri nella cache. Sostituisce il `user` campo.	No
└prompt_cache_retention	stringa o null		No
└* ragionamento	OpenAI.Reasoning o null		No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID dovrebbero essere una stringa che identifichi in modo unico ogni utente, con una lunghezza massima di 64 caratteri. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Vincoli: maxLunghezza: 64	No
└─ stato	enum	Stato della generazione della risposta. Uno di `completed`, `failed`, `in_progress` `cancelled`, `queued`, o `incomplete`. Valori possibili: `completed`, `failedin_progress`, `cancelled`, , `queuedincomplete`	No
└* temperatura	number o null		No	1
└─ testo	OpenAI.ResponseTextParam	Opzioni di configurazione per una risposta di testo dal modello. Può essere semplice dati JSON strutturati o di testo. Ulteriori informazioni: - Input e output testuali - Output strutturati	No
└tool_choice	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceParam		No
Strumenti └*	OpenAI.ToolsArray	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro . Sono supportate le categorie di strumenti seguenti: - Strumenti integrati: strumenti forniti da OpenAI che estendono Capacità del modello, come la ricerca web O cerca i file. Altre informazioni Strumenti integrati. - Strumenti MCP: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni Strumenti MCP. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello per chiamare il proprio codice con argomenti fortemente tipizzato e output. Altre informazioni Funzione che chiama. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	integer o null		No
└top_p	number o null		No	1
└─ troncamento	stringa o null		No	disabled
└─ utilizzo	OpenAI.ResponseUsage	Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, suddivisione dei token di output e dei token totali usati.	No
└─ utente	stringa (deprecata)	Questo campo viene sostituito da `safety_identifier` e `prompt_cache_key`. Usare `prompt_cache_key` invece per mantenere le ottimizzazioni della memorizzazione nella cache. Identificatore stabile per gli utenti finali. Usato per aumentare la frequenza di riscontri nella cache migliorando il bucket di richieste simili e per consentire a OpenAI di rilevare e prevenire abusi.	No
sequence_number	integer	Numero di sequenza per questo evento.	Sì
type	enum	Tipo di evento. Sempre 'response.queued'. Valori possibili: `response.queued`	Sì

OpenAI.ResponseReasoningSummaryPartAddedEvent

Generato quando viene aggiunta una nuova parte di riepilogo del ragionamento.

Name	Type	Description	Obbligatorio
item_id	string	L'ID dell'elemento a cui è associata questa parte di riepilogo.	Sì
output_index	integer	L'indice dell'elemento di output a cui è associata questa parte di riepilogo.	Sì
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Sì
└─ testo	string		Sì
└─ Tipo	enum	Valori possibili: `summary_text`	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
summary_index	integer	Indice della parte di sintesi all'interno del riepilogo del ragionamento.	Sì
type	enum	Tipo di evento. Sempre `response.reasoning_summary_part.added`. Valori possibili: `response.reasoning_summary_part.added`	Sì

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Type	Description	Obbligatorio	Predefinito
text	string		Sì
type	enum	Valori possibili: `summary_text`	Sì

OpenAI.ResponseReasoningSummaryPartDoneEvent

Generato quando viene completata una parte di riepilogo del ragionamento.

Name	Type	Description	Obbligatorio
item_id	string	L'ID dell'elemento a cui è associata questa parte di riepilogo.	Sì
output_index	integer	L'indice dell'elemento di output a cui è associata questa parte di riepilogo.	Sì
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Sì
└─ testo	string		Sì
└─ Tipo	enum	Valori possibili: `summary_text`	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
summary_index	integer	Indice della parte di sintesi all'interno del riepilogo del ragionamento.	Sì
type	enum	Tipo di evento. Sempre `response.reasoning_summary_part.done`. Valori possibili: `response.reasoning_summary_part.done`	Sì

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Type	Description	Obbligatorio	Predefinito
text	string		Sì
type	enum	Valori possibili: `summary_text`	Sì

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Generato quando un delta viene aggiunto a un testo di riepilogo del ragionamento.

Name	Type	Description	Obbligatorio
delta	string	Delta del testo aggiunto al riepilogo.	Sì
item_id	string	L'ID dell'elemento a cui è associato questo delta del testo di riepilogo.	Sì
output_index	integer	L'indice dell'elemento di output a cui è associato questo delta del testo di riepilogo.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
summary_index	integer	Indice della parte di sintesi all'interno del riepilogo del ragionamento.	Sì
type	enum	Tipo di evento. Sempre `response.reasoning_summary_text.delta`. Valori possibili: `response.reasoning_summary_text.delta`	Sì

OpenAI.ResponseReasoningSummaryTextDoneEvent

Generato quando viene completato un testo di riepilogo del ragionamento.

Name	Type	Description	Obbligatorio
item_id	string	L'ID dell'elemento a cui è associato questo testo di riepilogo.	Sì
output_index	integer	L'indice dell'elemento di output a cui è associato questo testo di riepilogo.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
summary_index	integer	Indice della parte di sintesi all'interno del riepilogo del ragionamento.	Sì
text	string	Testo completo del riepilogo del ragionamento completato.	Sì
type	enum	Tipo di evento. Sempre `response.reasoning_summary_text.done`. Valori possibili: `response.reasoning_summary_text.done`	Sì

OpenAI.ResponseReasoningTextDeltaEvent

Generato quando un delta viene aggiunto a un testo di ragionamento.

Name	Type	Description	Obbligatorio
content_index	integer	L'indice della parte del contenuto di ragionamento a cui è associato questo delta.	Sì
delta	string	Delta del testo aggiunto al contenuto del ragionamento.	Sì
item_id	string	L'ID dell'elemento a cui è associato questo delta del testo di ragionamento.	Sì
output_index	integer	L'indice dell'elemento di output a cui è associato questo delta del testo di ragionamento.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.reasoning_text.delta`. Valori possibili: `response.reasoning_text.delta`	Sì

OpenAI.ResponseReasoningTextDoneEvent

Generato quando viene completato un testo di ragionamento.

Name	Type	Description	Obbligatorio
content_index	integer	L'indice della parte del contenuto del ragionamento.	Sì
item_id	string	L'ID dell'elemento a cui è associato questo testo di ragionamento.	Sì
output_index	integer	L'indice dell'elemento di output a cui questo testo di ragionamento è associato.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
text	string	Testo completo del contenuto di ragionamento completato.	Sì
type	enum	Tipo di evento. Sempre `response.reasoning_text.done`. Valori possibili: `response.reasoning_text.done`	Sì

OpenAI.ResponseRefusalDeltaEvent

Emesso quando è presente un testo di rifiuto parziale.

Name	Type	Description	Obbligatorio
content_index	integer	Indice della parte del contenuto a cui viene aggiunto il testo di rifiuto.	Sì
delta	string	Testo di rifiuto aggiunto.	Sì
item_id	string	ID dell'elemento di output a cui viene aggiunto il testo di rifiuto.	Sì
output_index	integer	Indice dell'elemento di output a cui viene aggiunto il testo di rifiuto.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.refusal.delta`. Valori possibili: `response.refusal.delta`	Sì

OpenAI.ResponseRefusalDoneEvent

Generato quando viene finalizzato il testo di rifiuto.

Name	Type	Description	Obbligatorio
content_index	integer	Indice della parte del contenuto in cui viene finalizzato il testo di rifiuto.	Sì
item_id	string	ID dell'elemento di output in cui viene finalizzato il testo di rifiuto.	Sì
output_index	integer	Indice dell'elemento di output in cui viene finalizzato il testo di rifiuto.	Sì
refusal	string	Il testo di rifiuto completato.	Sì
sequence_number	integer	Numero di sequenza di questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.refusal.done`. Valori possibili: `response.refusal.done`	Sì

OpenAI.ResponseStreamEvent

Discriminatorio per OpenAI.ResponseStreamEvent

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptDoneEvento
`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.ResponseCustomToolCallInputDoneEvento
`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.ResponseOutputTestoAnnotationAddedEvent
`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.ReasoningTextDeltaEvent
`response.reasoning_text.done`	OpenAI.RispostaRagionamentoTestoFattoEvento
`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	Obbligatorio	Predefinito
type	OpenAI.ResponseStreamEventType		Sì

OpenAI.ResponseStreamEventType

Proprietà Value

Type string

Valori 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

Opzioni per le risposte in streaming. Impostare questa impostazione solo quando si imposta stream: true.

Name	Type	Description	Obbligatorio	Predefinito
include_obfuscation	boolean	Se true, l'offuscamento del flusso verrà abilitato. Aggiunta dell'offuscamento del flusso caratteri casuali in un `obfuscation` campo sugli eventi delta di streaming a normalizzare le dimensioni del payload come mitigazione per determinati attacchi sul canale laterale. Questi campi offuscamento sono inclusi per impostazione predefinita, ma aggiungono una piccola quantità sovraccarico per il flusso di dati. È possibile impostare su `include_obfuscation` false per ottimizzare la larghezza di banda se si considera attendibile il collegamento di rete tra l'applicazione e l'API OpenAI.	No

OpenAI.ResponseTextDeltaEvent

Generato quando è presente un delta di testo aggiuntivo.

Name	Type	Description	Obbligatorio
content_index	integer	Indice della parte di contenuto a cui è stato aggiunto il delta del testo.	Sì
delta	string	Delta del testo aggiunto.	Sì
item_id	string	ID dell'elemento di output a cui è stato aggiunto il delta del testo.	Sì
logprobs	matrice di OpenAI.ResponseLogProb	Probabilità di log dei token nel delta.	Sì
output_index	integer	Indice dell'elemento di output a cui è stato aggiunto il delta del testo.	Sì
sequence_number	integer	Numero di sequenza per questo evento.	Sì
type	enum	Tipo di evento. Sempre `response.output_text.delta`. Valori possibili: `response.output_text.delta`	Sì

OpenAI.ResponseTextDoneEvent

Generato quando viene finalizzato il contenuto di testo.

Name	Type	Description	Obbligatorio
content_index	integer	Indice della parte del contenuto in cui viene finalizzato il contenuto del testo.	Sì
item_id	string	ID dell'elemento di output in cui viene finalizzato il contenuto del testo.	Sì
logprobs	matrice di OpenAI.ResponseLogProb	Probabilità di log dei token nel delta.	Sì
output_index	integer	Indice dell'elemento di output in cui viene finalizzato il contenuto del testo.	Sì
sequence_number	integer	Numero di sequenza per questo evento.	Sì
text	string	Contenuto di testo finalizzato.	Sì
type	enum	Tipo di evento. Sempre `response.output_text.done`. Valori possibili: `response.output_text.done`	Sì

OpenAI.ResponseTextParam

Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. Ulteriori informazioni:

Input e output di testo
Output strutturati

Name	Type	Description	Obbligatorio	Predefinito
format	OpenAI.TextResponseFormatConfiguration	Oggetto che specifica il formato che il modello deve restituire. La configurazione `{ "type": "json_schema" }` abilita output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere Il formato predefinito è `{ "type": "text" }` senza opzioni aggiuntive. Non consigliato per i modelli gpt-4o e versioni successive: L'impostazione su `{ "type": "json_object" }` abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. Utilizzo di `json_schema` è preferibile per i modelli che lo supportano.	No
Dettaglio	OpenAI.Verbosity	Vincola il livello di dettaglio della risposta del modello. I valori inferiori genereranno risposte più concise, mentre valori più elevati generano risposte più dettagliate. I valori attualmente supportati sono `low`, `medium`, e `high`.	No

OpenAI.ResponseUsage

Rappresenta i dettagli di utilizzo dei token, inclusi i token di input, i token di output, la suddivisione dei token di output e i token totali usati.

Name	Type	Description	Obbligatorio
input_tokens	integer	Numero di token di input.	Sì
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sì
└cached_tokens	integer		Sì
output_tokens	integer	Numero di token in uscita.	Sì
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Sì
└─ token_di_ragionamento	integer		Sì
total_tokens	integer	Numero totale di token usati.	Sì

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Obbligatorio	Predefinito
cached_tokens	integer		Sì

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Obbligatorio	Predefinito
reasoning_tokens	integer		Sì

OpenAI.ResponseWebSearchCallCompletedEvent

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name	Type	Description	Obbligatorio
item_id	string	ID univoco per l'elemento di output associato alla chiamata di ricerca Web.	Sì
output_index	integer	Indice dell'elemento di output a cui è associata la chiamata di ricerca Web.	Sì
sequence_number	integer	Numero di sequenza della chiamata di ricerca Web in corso di elaborazione.	Sì
type	enum	Tipo di evento. Sempre `response.web_search_call.completed`. Valori possibili: `response.web_search_call.completed`	Sì

OpenAI.ResponseWebSearchCallInProgressEvent

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name	Type	Description	Obbligatorio
item_id	string	ID univoco per l'elemento di output associato alla chiamata di ricerca Web.	Sì
output_index	integer	Indice dell'elemento di output a cui è associata la chiamata di ricerca Web.	Sì
sequence_number	integer	Numero di sequenza della chiamata di ricerca Web in corso di elaborazione.	Sì
type	enum	Tipo di evento. Sempre `response.web_search_call.in_progress`. Valori possibili: `response.web_search_call.in_progress`	Sì

OpenAI.ResponseWebSearchCallSearchingEvent

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name	Type	Description	Obbligatorio
item_id	string	ID univoco per l'elemento di output associato alla chiamata di ricerca Web.	Sì
output_index	integer	Indice dell'elemento di output a cui è associata la chiamata di ricerca Web.	Sì
sequence_number	integer	Numero di sequenza della chiamata di ricerca Web in corso di elaborazione.	Sì
type	enum	Tipo di evento. Sempre `response.web_search_call.searching`. Valori possibili: `response.web_search_call.searching`	Sì

OpenAI.ScreenshotParam

Screenshot

Azione screenshot.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Specifica il tipo di evento. Per un'azione screenshot, questa proprietà è sempre impostata su `screenshot`. Valori possibili: `screenshot`	Sì	Screenshot

OpenAI.ScrollParam

Scroll

Azione di scorrimento.

Name	Type	Description	Obbligatorio	Predefinito
keys	matrice di stringhe o null		No
scroll_x	integer	Distanza di scorrimento orizzontale.	Sì
scroll_y	integer	Distanza di scorrimento verticale.	Sì
type	enum	Specifica il tipo di evento. Per un'azione di scorrimento, questa proprietà è sempre impostata su `scroll`. Valori possibili: `scroll`	Sì	scorrere
x	integer	Coordinata x in cui si è verificato lo scorrimento.	Sì
y	integer	Coordinata y in cui si è verificato lo scorrimento.	Sì

OpenAI.SearchContentType

Proprietà	Value
Type	string
Valori	`text` `image`

OpenAI.SearchContextSize

Proprietà	Value
Type	string
Valori	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Type	Description	Obbligatorio	Predefinito
skill_id	string	L'ID dell'abilità di riferimento. Vincoli: minLength: 1, maxLength: 64	Sì
type	enum	Fa riferimento a un'abilità creata con l'endpoint /v1/skills. Valori possibili: `skill_reference`	Sì	skill_reference
version	string	Versione opzionale dell'abilità. Usa un intero positivo o 'più recente'. Ometti per default.	No

OpenAI.SpecificApplyPatchParam

Scelta dello strumento specifico per la patch

Forza il modello a chiamare lo strumento apply_patch durante l'esecuzione di una chiamata allo strumento.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Strumento da chiamare. Sempre `apply_patch`. Valori possibili: `apply_patch`	Sì	apply_patch

OpenAI.SpecificFunctionShellParam

Scelta specifica dello strumento shell

Forza il modello a chiamare lo strumento shell quando è necessaria una chiamata allo strumento.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Strumento da chiamare. Sempre `shell`. Valori possibili: `shell`	Sì	shell

OpenAI.SummaryTextContent

Testo riassuntivo

Testo di riepilogo del modello.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Riepilogo dell'output di ragionamento del modello finora.	Sì
type	enum	Tipo dell'oggetto . Sempre `summary_text`. Valori possibili: `summary_text`	Sì	summary_text

OpenAI.TextContent

Contenuto testuale

Contenuto di testo.

Name	Type	Description	Obbligatorio	Predefinito
text	string		Sì
type	enum	Valori possibili: `text`	Sì	text

OpenAI.TextResponseFormatConfiguration

Oggetto che specifica il formato che il modello deve restituire. La configurazione { "type": "json_schema" } abilita gli output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere

Il formato predefinito è { "type": "text" } senza opzioni aggiuntive. Non consigliato per GPT-4O e modelli più recenti: Impostando per { "type": "json_object" } abilita la vecchia modalità JSON, che garantisce che il messaggio generato dal modello sia JSON valido. L'uso json_schema è preferibile per i modelli che lo supportano.

Discriminare per OpenAI.TextResponseFormatConfiguration

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.TextResponseFormatConfigurationType		Sì

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Oggetto JSON

Formato della risposta dell'oggetto JSON. Metodo precedente di generazione di risposte JSON. Si consiglia di utilizzare json_schema per i modelli che lo supportano. Si noti che il modello non genererà JSON senza un messaggio di sistema o utente che lo istruisca a farlo.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di formato di risposta definito. Sempre `json_object`. Valori possibili: `json_object`	Sì

OpenAI.TextResponseFormatConfigurationResponseFormatText

Testo

Formato di risposta predefinito. Usato per generare risposte di testo.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di formato di risposta definito. Sempre `text`. Valori possibili: `text`	Sì

OpenAI.TextResponseFormatConfigurationType

Proprietà	Value
Type	string
Valori	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Schema JSON

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate.

Name	Type	Description	Obbligatorio
descrizione	string	Descrizione del formato di risposta, usato dal modello per decidere come rispondere al formato.	No
nome	string	Nome del formato della risposta. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64.	Sì
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.	Sì
rigido	booleano o null		No
type	enum	Tipo di formato di risposta definito. Sempre `json_schema`. Valori possibili: `json_schema`	Sì

OpenAI.Tool

Strumento che può essere usato per generare una risposta.

Discriminatore per OpenAI.Tool

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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	Obbligatorio	Predefinito
type	OpenAI.ToolType		Sì

OpenAI.ToolChoiceAllowed

Strumenti consentiti

Vincola gli strumenti disponibili al modello a un set predefinito.

Name	Type	Description	Obbligatorio
mode	enum	Vincola gli strumenti disponibili al modello a un set predefinito. `auto` consente al modello di scegliere tra gli strumenti consentiti e generare un messaggio. `required` richiede al modello di chiamare uno o più degli strumenti consentiti. Valori possibili: `auto`, `required`	Sì
Strumenti	matrice di oggetti	Elenco di definizioni degli strumenti che il modello deve essere autorizzato a chiamare. Per l'API Risposte, l'elenco delle definizioni degli strumenti potrebbe essere simile al seguente: `json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br>`	Sì
type	enum	Tipo di configurazione dello strumento consentito. Sempre `allowed_tools`. Valori possibili: `allowed_tools`	Sì

OpenAI.ToolChoiceCodeInterpreter

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `code_interpreter`	Sì

OpenAI.ToolChoiceComputer

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `computer`	Sì

OpenAI.ToolChoiceComputerUse

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `computer_use`	Sì

OpenAI.ToolChoiceComputerUsePreview

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `computer_use_preview`	Sì

OpenAI.ToolChoiceCustom

Strumento personalizzato

Usare questa opzione per forzare il modello a chiamare uno strumento personalizzato specifico.

Name	Type	Description	Obbligatorio	Predefinito
nome	string	Nome dello strumento personalizzato da chiamare.	Sì
type	enum	Per la chiamata a uno strumento personalizzato, il tipo è sempre `custom`. Valori possibili: `custom`	Sì

OpenAI.ToolChoiceFileSearch

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `file_search`	Sì

OpenAI.ToolChoiceFunction

Strumento funzionale

Usare questa opzione per forzare il modello a chiamare una funzione specifica.

Name	Type	Description	Obbligatorio	Predefinito
nome	string	Il nome della funzione da chiamare.	Sì
type	enum	Per la chiamata di funzione, il tipo è sempre `function`. Valori possibili: `function`	Sì

OpenAI.ToolChoiceImageGeneration

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `image_generation`	Sì

OpenAI.ToolChoiceMCP

Strumento MCP

Usare questa opzione per forzare il modello a chiamare uno strumento specifico in un server MCP remoto.

Name	Type	Description	Obbligatorio
nome	stringa o null		No
etichetta del server	string	Etichetta del server MCP da usare.	Sì
type	enum	Per gli strumenti MCP, il tipo è sempre `mcp`. Valori possibili: `mcp`	Sì

OpenAI.ToolChoiceOptions

Modalità di scelta dello strumento

Controlla quale strumento (se presente) viene chiamato dal modello. none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio. auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti. required significa che il modello deve chiamare uno o più strumenti.

Proprietà	Value
Type	string
Valori	`none` `auto` `required`

OpenAI.ToolChoiceParam

Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il tools parametro per informazioni su come specificare gli strumenti che il modello può chiamare.

Discriminante per OpenAI.ToolChoiceParam

Questo componente usa la proprietà type per distinguere tra tipi diversi:

Valore del tipo	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	Obbligatorio	Predefinito
type	OpenAI.ToolChoiceParamType		Sì

OpenAI.ToolChoiceParamType

Proprietà	Value
Type	string
Valori	`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

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `web_search_preview`	Sì

OpenAI.ToolChoiceWebSearchPreview20250311

Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `web_search_preview_2025_03_11`	Sì

OpenAI.ToolSearchExecutionType

Proprietà	Value
Type	string
Valori	`server` `client`

OpenAI.ToolSearchToolParam

Strumento di ricerca degli strumenti

Configurazione di ricerca di strumenti ospitati o BYOT per strumenti differiti.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	stringa o null		No
esecuzione	OpenAI.ToolSearchExecutionType		No
parameters	OpenAI.EmptyModelParam o null		No
type	enum	Tipo dello strumento. Sempre `tool_search`. Valori possibili: `tool_search`	Sì	tool_search

OpenAI.ToolType

Proprietà	Value
Type	string
Valori	`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

Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. È possibile specificare lo strumento da usare impostando il tool_choice parametro . Sono supportate le categorie di strumenti seguenti:

Strumenti integrati: Strumenti forniti da OpenAI che estendono le capacità del modello, come la ricerca web o la ricerca file. Scopri di più sugli strumenti integrati.
MCP Tools: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Scopri di più sugli strumenti MCP.
Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, consentendo al modello di chiamare il proprio codice con argomenti e output fortemente tipizzato. Altre informazioni sulla chiamata alle funzioni. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.

Matrice di: OpenAI.Tool

OpenAI.TopLogProb

Probabilità logaritmica massima

Probabilità di log principale di un token.

Name	Type	Obbligatorio
bytes	matrice di numeri interi	Sì
logprob	Numero	Sì
token	string	Sì

OpenAI.TypeParam

Type

Azione per digitare del testo.

Name	Type	Description	Obbligatorio	Predefinito
text	string	Testo da digitare.	Sì
type	enum	Specifica il tipo di evento. Per un'azione di tipo, questa proprietà è sempre impostata su `type`. Valori possibili: `type`	Sì	type

OpenAI.UrlCitationBody

Citazione URL

Citazione per una risorsa Web usata per generare una risposta del modello.

Name	Type	Description	Obbligatorio	Predefinito
end_index	integer	Indice dell'ultimo carattere della citazione URL nel messaggio.	Sì
start_index	integer	Indice del primo carattere della citazione URL nel messaggio.	Sì
Titolo	string	Titolo della risorsa Web.	Sì
type	enum	Tipo di citazione URL. Sempre `url_citation`. Valori possibili: `url_citation`	Sì	url_citation
url	stringa (uri)	URL della risorsa Web.	Sì

OpenAI.VectorStoreFileAttributes

Tipo: oggetto

OpenAI.Verbosity

Vincola il livello di dettaglio della risposta del modello. I valori inferiori generano risposte più concise, mentre i valori più elevati generano risposte più dettagliate. I valori attualmente supportati sono low, medium, e high.

Proprietà	Value
Descrizione	Vincola il livello di dettaglio della risposta del modello. I valori inferiori genereranno risposte più concise, mentre valori più elevati generano risposte più dettagliate. I valori attualmente supportati sono `low`, `medium`, e `high`.
Type	string
Valori	`low` `medium` `high`

OpenAI.WaitParam

Wait

Azione di attesa.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Specifica il tipo di evento. Per un'azione di attesa, questa proprietà è sempre impostata su `wait`. Valori possibili: `wait`	Sì	wait

OpenAI.WebSearchActionFind

Trova azione

Tipo d'azione "find_in_page": Cerca un pattern all'interno di una pagina caricata.

Name	Type	Description	Obbligatorio
pattern	string	Modello o testo da cercare all'interno della pagina.	Sì
type	enum	Tipo di azione. Valori possibili: `find_in_page`	Sì
url	stringa (uri)	URL della pagina in cui è stato cercato il modello.	Sì

OpenAI.WebSearchActionOpenPage

Azione pagina aperta

Tipo di azione "open_page" - Apre un URL specifico dai risultati della ricerca.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di azione. Valori possibili: `open_page`	Sì
url	stringa o null	URL aperto dal modello.	No

OpenAI.WebSearchActionSearch

Azione di ricerca

Tipo di azione "search" - Esegue una query di ricerca Web.

Name	Type	Description	Obbligatorio
queries	matrice di valori string	Query di ricerca.	No
query	stringa (deprecata)	[DEPRECATO] Query di ricerca.	Sì
Fonti	matrice di OpenAI.WebSearchActionSearchSources	Origini utilizzate nella ricerca.	No
type	enum	Tipo di azione. Valori possibili: `search`	Sì

OpenAI.WebSearchActionSearchSources

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: `url`	Sì
url	stringa (uri)		Sì

OpenAI.WebSearchApproximateLocation

Ricerca web posizione approssimativa

Posizione approssimativa dell'utente.

Name	Type	Description	Obbligatorio	Predefinito
Città	stringa o null		No
paese	stringa o null		No
region	stringa o null		No
timezone	stringa o null		No
type	enum	Tipo di approssimazione della posizione. Sempre `approximate`. Valori possibili: `approximate`	Sì	approssimativa

OpenAI.WebSearchPreviewTool

Anteprima della ricerca web

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name	Type	Description	Obbligatorio	Predefinito
search_content_types	array di OpenAI.SearchContentType		No
dimensione_del_contesto_di_ricerca	OpenAI.SearchContextSize		No
type	enum	Tipo dello strumento di ricerca Web. Uno di `web_search_preview` o `web_search_preview_2025_03_11`. Valori possibili: `web_search_preview`	Sì	web_search_preview
posizione_utente	OpenAI.ApproximateLocation o null		No

OpenAI.WebSearchTool

Ricerca Web

Nota: web_search non è ancora disponibile tramite Azure OpenAI.

Name	Type	Description	Obbligatorio	Predefinito
Filtri	OpenAI.WebSearchToolFilters o null		No
dimensione_del_contesto_di_ricerca	enum	Linee guida generali per la quantità di spazio della finestra di contesto da usare per la ricerca. Uno tra `low`, `medium` e `high`. `medium` è l'impostazione predefinita. Valori possibili: `low`, `medium`, `high`	No	medium
type	enum	Tipo dello strumento di ricerca Web. Uno di `web_search` o `web_search_2025_08_26`. Valori possibili: `web_search`	Sì	ricerca sul web
posizione_utente	OpenAI.WebSearchApproximateLocation o null		No

OpenAI.WebSearchToolFilters

Name	Type	Description	Obbligatorio	Predefinito
allowed_domains	matrice di stringhe o null		No

Last updated on 2026-07-10