Microsoft Foundry

Versione API: v1

Autenticazione

Flusso: implicito

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

Ambiti:

• https://ai.azure.com/.default

Agents

Agenti - Creare l'agente

POST {endpoint}/agents?api-version=v1

Crea l'agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
Definizione	AgentDefinition		Sì
└* tipo	AgentKind		Sì
└rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome univoco che identifica l'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - elencare gli agenti

GET {endpoint}/agents?api-version=v1

Restituisce l'elenco di tutti gli agenti.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
kind	query	No	string Valori possibili: prompt, hosted, container_app, workflow	Filtra gli agenti per tipo. Se non specificato, vengono restituiti tutti gli agenti.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Ottenere l'agente

GET {endpoint}/agents/{agent_name}?api-version=v1

Recupera l'agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Agente di aggiornamento

POST {endpoint}/agents/{agent_name}?api-version=v1

Aggiorna l'agente aggiungendo una nuova versione se sono presenti modifiche alla definizione dell'agente. Se non viene apportata alcuna modifica, restituisce la versione dell'agente esistente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
Definizione	AgentDefinition		Sì
└* tipo	AgentKind		Sì
└rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Eliminare l'agente

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Elimina un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente da eliminare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteAgentResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti : aggiornare l'agente dal manifesto

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Aggiorna l'agente da un manifesto aggiungendo una nuova versione se sono presenti modifiche alla definizione dell'agente. Se non viene apportata alcuna modifica, restituisce la versione dell'agente esistente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente da aggiornare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	string	ID manifesto da cui importare la versione dell'agente.	Sì
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti : creare la versione dell'agente

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Creare una nuova versione dell'agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome univoco che identifica l'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview, HostedAgents=V1Preview, WorkflowAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
Definizione	AgentDefinition		Sì
└* tipo	AgentKind		Sì
└rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentVersionObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Elencare le versioni degli agenti

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Restituisce l'elenco delle versioni di un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente per cui recuperare le versioni.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Ottenere la versione dell'agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Recupera una versione specifica di un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente da recuperare.
agent_version	path	Sì	string	Versione dell'agente da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentVersionObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Eliminare la versione dell'agente

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Elimina una versione specifica di un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente da eliminare.
agent_version	path	Sì	string	Versione dell'agente da eliminare
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteAgentVersionResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti : creare la versione dell'agente dal manifesto

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Creare una nuova versione dell'agente da un manifesto.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome univoco che identifica l'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	string	ID manifesto da cui importare la versione dell'agente.	Sì
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentVersionObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti: creare l'agente dal manifesto

POST {endpoint}/agents:import?api-version=v1

Crea un agente da un manifesto.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	string	ID manifesto da cui importare la versione dell'agente.	Sì
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome univoco che identifica l'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Sì
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori agente

Contenitori dell'agente - Elencare le operazioni del contenitore dell'agente

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Elencare le operazioni del contenitore per un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente - Operazione get agent container

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Ottenere lo stato di un'operazione contenitore per un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
operation_id	path	Sì	string	ID operazione.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentContainerOperationObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente - Ottenere il contenitore dell'agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Ottenere un contenitore per una versione specifica di un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentContainerObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente - Elencare le operazioni del contenitore della versione dell'agente

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Elencare le operazioni del contenitore per una versione specifica di un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente - Eliminare il contenitore dell'agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Eliminare un contenitore per una versione specifica di un agente. Se il contenitore non esiste, l'operazione sarà no-op. L'operazione è un'operazione a esecuzione prolungata. Seguendo le linee guida di progettazione per le operazioni a esecuzione prolungata nelle API REST di Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 202

Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Tipo di contenuto	Type	Descrizione
application/json	AgentContainerOperationObject

Intestazioni di risposta:

Intestazione	Type	Description
Operazione-Localizzazione	string

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente : log dei contenitori dell'agente di flusso

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Voce del log del contenitore trasmessa dal contenitore come blocchi di testo. Ogni blocco è una stringa UTF-8 che può essere una riga di log di testo normale o una voce di log in formato JSON, a seconda del tipo di log del contenitore trasmesso. I client devono considerare ogni blocco come testo opaco e, se necessario, tentare di analizzarlo come JSON in base ai requisiti di registrazione.

Per i log di sistema, il formato è JSON con la struttura seguente: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connessione all'agente di raccolta eventi...","Motivo":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connected to events server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Per i log della console, il formato è testo normale come generato dal stdout/stderr del contenitore. 2025-12-15T08:43:48.72656 Connessione al contenitore 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
kind	query	No	string Valori possibili: console, system	la console restituisce stdout/stderr del contenitore, il sistema restituisce il flusso di eventi dell'app contenitore. per impostazione predefinita la console
replica_name	query	No	string	Se omesso, il server sceglie la prima replica per i log della console. Obbligatorio per specificare come destinazione una replica specifica.
coda	query	No	integer	Numero di righe finali restituite. Applicato a 1-300. Il valore predefinito è 20
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente : avviare il contenitore dell'agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Avviare un contenitore per una versione specifica di un agente. Se il contenitore è già in esecuzione, l'operazione sarà no-op. L'operazione è un'operazione a esecuzione prolungata. Seguendo le linee guida di progettazione per le operazioni a esecuzione prolungata nelle API REST di Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
max_replicas	integer	Numero massimo di repliche. Il valore predefinito è 1.	No	1
min_replicas	integer	Numero minimo di repliche. Il valore predefinito è 1.	No	1

Risposte

Codice di stato: 202

Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Tipo di contenuto	Type	Descrizione
application/json	AgentContainerOperationObject

Intestazioni di risposta:

Intestazione	Type	Description
Operazione-Localizzazione	string

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente - Arrestare il contenitore dell'agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Arrestare un contenitore per una versione specifica di un agente. Se il contenitore non è in esecuzione o è già fermato, l'operazione sarà no-op. L'operazione è un'operazione a esecuzione prolungata. Seguendo le linee guida di progettazione per le operazioni a esecuzione prolungata nelle API REST di Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 202

Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Tipo di contenuto	Type	Descrizione
application/json	AgentContainerOperationObject

Intestazioni di risposta:

Intestazione	Type	Description
Operazione-Localizzazione	string

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Contenitori dell'agente - Aggiornare il contenitore dell'agente

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Aggiornare un contenitore per una versione specifica di un agente. Se il contenitore non è in esecuzione, l'operazione sarà no-op. L'operazione è un'operazione a esecuzione prolungata. Seguendo le linee guida di progettazione per le operazioni a esecuzione prolungata nelle API REST di Azure. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Sì	string	Nome dell'agente.
agent_version	path	Sì	string	Versione dell'agente.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: ContainerAgents=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
max_replicas	integer	Numero massimo di repliche.	No
min_replicas	integer	Numero minimo di repliche.	No

Risposte

Codice di stato: 202

Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Tipo di contenuto	Type	Descrizione
application/json	AgentContainerOperationObject

Intestazioni di risposta:

Intestazione	Type	Description
Operazione-Localizzazione	string

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Connections

Connessioni - elenco

GET {endpoint}/connections?api-version=v1

Elencare tutte le connessioni nel progetto, senza popolare le credenziali di connessione

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
connectionType	query	No	string Valori possibili: AzureOpenAI, AzureBlob, AzureStorageAccountCognitiveSearch, CosmosDB, ApiKey, AppConfig, AppInsights, CustomKeysRemoteTool_Preview	Elencare le connessioni di questo tipo specifico
defaultConnection	query	No	boolean	Elencare le connessioni predefinite

Intestazione della richiesta

Name	Obbligatorio	Type	Description
x-ms-client-request-id	Falso	string	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedConnection

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-client-request-id		Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Connessioni - ottenere

GET {endpoint}/connections/{name}?api-version=v1

Ottenere una connessione in base al nome, senza popolare le credenziali di connessione

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	Nome descrittivo della connessione, fornito dall'utente.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
x-ms-client-request-id	Falso	string	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Connection

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-client-request-id		Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Connessioni : ottenere con le credenziali

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Ottenere una connessione in base al nome, con le relative credenziali di connessione

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	Nome descrittivo della connessione, fornito dall'utente.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
x-ms-client-request-id	Falso	string	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Connection

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-client-request-id		Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Datasets

Set di dati - Elencare la versione più recente

GET {endpoint}/datasets?api-version=v1

Elencare la versione più recente di ogni DatasetVersion

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedDatasetVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Set di dati - elencare le versioni

GET {endpoint}/datasets/{name}/versions?api-version=v1

Elencare tutte le versioni di DatasetVersion specificato

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedDatasetVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Set di dati - Ottenere la versione

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Ottenere la versione specifica di DatasetVersion. Il servizio restituisce l'errore 404 Not Found se DatasetVersion non esiste.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico di DatasetVersion da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DatasetVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Set di dati - Eliminare la versione

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Eliminare la versione specifica di DatasetVersion. Il servizio restituisce 204 Nessun contenuto se DatasetVersion è stato eliminato correttamente o se DatasetVersion non esiste.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	Versione di DatasetVersion da eliminare.

Risposte

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Set di dati: creare o aggiornare la versione

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Creare un oggetto DatasetVersion nuovo o aggiornare un oggetto DatasetVersion esistente con l'ID versione specificato

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico di DatasetVersion da creare o aggiornare.

Corpo della richiesta

Content-Type: application/merge-patch+json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	DatasetType	Enumerazione per determinare il tipo di dati.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DatasetVersion

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	DatasetVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Set di dati - Ottenere le credenziali

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Ottenere le credenziali di firma di accesso condiviso per accedere all'account di archiviazione associato a una versione del set di dati.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico di DatasetVersion su cui operare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AssetCredentialResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Set di dati: avviare la versione di caricamento in sospeso

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Avviare un nuovo o ottenere un caricamento esistente in sospeso di un set di dati per una versione specifica.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico di DatasetVersion su cui operare.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
Connectionname	string	Nome di connessione dell'account di archiviazione di Azure da usare per la generazione di un token di firma di accesso condiviso temporaneo	No
pendingUploadId	string	Se PendingUploadId non viene specificato, verrà usato un GUID casuale.	No
pendingUploadType	enum	BlobReference è l'unico tipo supportato. Valori possibili: BlobReference	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PendingUploadResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Implementazioni

Distribuzioni - elenco

GET {endpoint}/deployments?api-version=v1

Elencare tutti i modelli distribuiti nel progetto

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
modelPublisher	query	No	string	Autore di modelli per filtrare i modelli in base
modelName	query	No	string	Nome del modello (nome specifico dell'editore) per filtrare i modelli in base a
deploymentType	query	No	string Valori possibili: ModelDeployment	Tipo di distribuzione per cui filtrare l'elenco

Intestazione della richiesta

Name	Obbligatorio	Type	Description
x-ms-client-request-id	Falso	string	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedDeployment

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-client-request-id		Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Distribuzioni : ottenere

GET {endpoint}/deployments/{name}?api-version=v1

Ottieni un modello distribuito.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	Nome della distribuzione

Intestazione della richiesta

Name	Obbligatorio	Type	Description
x-ms-client-request-id	Falso	string	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Deployment

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-client-request-id		Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Tassonomie di valutazione

Tassonomie di valutazione - elenco

GET {endpoint}/evaluationtaxonomies?api-version=v1

Elencare le tassonomie di valutazione

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
inputName	query	No	string	Filtrare in base al nome dell'input di valutazione.
inputType	query	No	string	Filtrare in base al tipo di input tassonomia.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedEvaluationTaxonomy

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Tassonomie di valutazione - get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Ottenere un'esecuzione di valutazione in base al nome.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationTaxonomy

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Tassonomie di valutazione - eliminazione

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Eliminare una tassonomia di valutazione in base al nome.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Tassonomie di valutazione : creazione

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Creare una tassonomia di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	Nome della tassonomia di valutazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
properties	object	Proprietà aggiuntive per la tassonomia di valutazione.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
tassonomiaCategorie	matrice di TassonomiaCategory	Elenco delle categorie di tassonomia.	No
tassonomiaInput	EvaluationTaxonomyInput	Configurazione di input per la tassonomia di valutazione.	Sì
└─ Tipo	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationTaxonomy

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationTaxonomy

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Tassonomie di valutazione - aggiornamento

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Aggiornare una tassonomia di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	Nome della tassonomia di valutazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
properties	object	Proprietà aggiuntive per la tassonomia di valutazione.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
tassonomiaCategorie	matrice di TassonomiaCategory	Elenco delle categorie di tassonomia.	No
tassonomiaInput	EvaluationTaxonomyInputUpdate	Configurazione di input per la tassonomia di valutazione.	No
└─ Tipo	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationTaxonomy

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Regole di valutazione

Regole di valutazione - elenco

GET {endpoint}/evaluationrules?api-version=v1

Elencare tutte le regole di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
actionType	query	No	string Valori possibili: continuousEvaluation, humanEvaluationPreview	Filtrare in base al tipo di regola di valutazione.
nomeagente	query	No	string	Filtra in base al nome dell'agente.
enabled	query	No	boolean	Filtrare in base allo stato abilitato.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedEvaluationRule

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Regole di valutazione - get

GET {endpoint}/evaluationrules/{id}?api-version=v1

Ottenere una regola di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore univoco per la regola di valutazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationRule

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Regole di valutazione - eliminazione

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Eliminare una regola di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore univoco per la regola di valutazione.

Risposte

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Regole di valutazione: creare o aggiornare

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Creare o aggiornare una regola di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore univoco per la regola di valutazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	Falso	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
action	EvaluationRuleAction	Modello di azione di valutazione.	Sì
└─ Tipo	EvaluationRuleActionType	Tipo di azione di valutazione.	Sì
descrizione	string	Descrizione per la regola di valutazione.	No
displayName	string	Nome visualizzato per la regola di valutazione.	No
enabled	boolean	Indica se la regola di valutazione è abilitata. Il valore predefinito è vero.	Sì
eventType	EvaluationRuleEventType	Tipo di evento della regola di valutazione.	Sì
filter	EvaluationRuleFilter	Modello di filtro di valutazione.	No
└* agentName	string	Filtrare in base al nome dell'agente.	Sì
id	string (sola lettura)	Identificatore univoco per la regola di valutazione.	Sì
dati di sistema	oggetto (sola lettura)	Metadati di sistema per la regola di valutazione.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationRule

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	EvaluationRule

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Valutatori

Analizzatori - Elencare le versioni più recenti

GET {endpoint}/evaluators?api-version=v1

Elenca l'ultima versione di ogni analizzatore

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
type	query	No	string Valori possibili: builtin, custom, all	Filtrare gli analizzatori per tipo. Valori possibili: 'all', 'custom', 'builtin'.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedEvaluatorVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Analizzatori - Elencare le versioni

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Elenca tutte le versioni dell'analizzatore specificato

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
type	query	No	string Valori possibili: builtin, custom, all	Filtrare gli analizzatori per tipo. Valori possibili: 'all', 'custom', 'builtin'.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedEvaluatorVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Analizzatori - Creare la versione

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Creare un nuovo EvaluatorVersion con ID versione incrementato automaticamente

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
categories	matrice di analizzatoriCategory	Le categorie del valutatore	Sì
Definizione	AnalizzatoreDefinition	Configurazione dell'analizzatore di base con discriminatore	Sì
└data_schema	object	Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
└init_parameters	object	Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
└* Metriche	object	Elenco delle metriche di output prodotte da questo valutatore	No
└─ Tipo	AnalizzatoreDefinitionType	Il tipo di definizione del valutatore	Sì
descrizione	string	Testo della descrizione dell'asset.	No
display_name	string	Nome visualizzato per l'analizzatore. Aiuta facilmente a trovare il valutatore in AI Foundry. Non è necessario che sia univoco.	No
evaluator_type	AnalizzatoreType	Il tipo di valutatore	Sì
metadata	object	Metadati relativi all'analizzatore	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No

Risposte

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	AnalizzatoreVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Analizzatori : ottenere la versione

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Ottenere la versione specifica di EvaluatorVersion. Il servizio restituisce l'errore 404 Not Found se EvaluatorVersion non esiste.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico dell'analizzatoreVersion da recuperare.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AnalizzatoreVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Analizzatori - Eliminare la versione

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Eliminare la versione specifica di EvaluatorVersion. Il servizio restituisce 204 No Content se EvaluatorVersion è stato eliminato correttamente o se EvaluatorVersion non esiste.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	Versione di EvaluatorVersion da eliminare.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Analizzatori - versione di aggiornamento

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Aggiorna un EvaluatorVersion esistente con l'ID versione specificato

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	Versione di EvaluatorVersion da aggiornare.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Evaluations=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
categories	matrice di analizzatoriCategory	Le categorie del valutatore	No
descrizione	string	Testo della descrizione dell'asset.	No
display_name	string	Nome visualizzato per l'analizzatore. Aiuta facilmente a trovare il valutatore in AI Foundry. Non è necessario che sia univoco.	No
metadata	object	Metadati relativi all'analizzatore	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AnalizzatoreVersion

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Indexes

Indici - elenco più recente

GET {endpoint}/indexes?api-version=v1

Elencare la versione più recente di ogni indice

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedIndex

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Indici - elencare le versioni

GET {endpoint}/indexes/{name}/versions?api-version=v1

Elencare tutte le versioni dell'indice specificato

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedIndex

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Indici - ottenere la versione

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Ottenere la versione specifica dell'indice. Se l'indice non esiste, il servizio restituisce l'errore 404 Not Found.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico dell'indice da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Indice

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Indici - Eliminare la versione

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Eliminare la versione specifica dell'indice. Il servizio restituisce 204 Nessun contenuto se l'indice è stato eliminato correttamente o se l'indice non esiste.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	Versione dell'indice da eliminare.

Risposte

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Indici : creare o aggiornare la versione

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Creare un indice nuovo o aggiornare un indice esistente con l'ID versione specificato

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	nome della risorsa.
version	path	Sì	string	ID versione specifico dell'indice da creare o aggiornare.

Corpo della richiesta

Content-Type: application/merge-patch+json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	IndexType		Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Indice

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	Indice

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Insights

Informazioni dettagliate : genera

POST {endpoint}/insights?api-version=v1

Generare informazioni dettagliate

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Insights=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.
Ripetibilità-Request-ID	Falso	string	Identificatore univoco generato dal client per garantire l'idempotenza della richiesta. Utilizzare lo stesso ID per i tentativi per evitare valutazioni duplicate.
Ripetibilità-First-Sent	Falso	string	Timestamp che indica quando la richiesta è stata avviata per la prima volta. Utilizzato in combinazione con repeatability-request-id per il controllo dell'idempotenza.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
displayName	string	Nome visualizzato descrittivo per le informazioni dettagliate.	Sì
id	string (sola lettura)	Identificatore univoco per il report di informazioni dettagliate.	Sì
metadata	InsightsMetadata (sola lettura)	Metadati relativi alle informazioni dettagliate.	Sì
└* completedAt	string	Timestamp al termine delle informazioni dettagliate.	No
└> createdAt	string	Timestamp al momento della creazione delle informazioni dettagliate.	Sì
request	InsightRequest	La richiesta del report di approfondimento.	Sì
└─ Tipo	InsightType	Tipo di richiesta.	Sì
result	InsightResult (sola lettura)	Il risultato degli approfondimenti.	No
└─ Tipo	InsightType	Tipo di risultato di informazioni dettagliate.	Sì
state	Azure. Core.Foundations.OperationState (sola lettura)	Enumerazione che descrive gli stati di funzionamento consentiti.	Sì

Risposte

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	Informazioni dettagliate

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Informazioni dettagliate - elenco

GET {endpoint}/insights?api-version=v1

Elencare tutte le informazioni dettagliate in ordine cronologico inverso (prima più recente).

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
type	query	No	string Valori possibili: EvaluationRunClusterInsight, AgentClusterInsight, EvaluationComparison	Filtra in base al tipo di analisi.
evalId	query	No	string	Filtrare in base all'ID di valutazione.
runId	query	No	string	Filtrare in base all'ID dell'esecuzione della valutazione.
nomeagente	query	No	string	Filtra in base al nome dell'agente.
includeCoordinates	query	No	boolean	Indica se includere le coordinate per la visualizzazione nella risposta. Il valore predefinito è falso.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Insights=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedInsight

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Informazioni dettagliate - Ottenere

GET {endpoint}/insights/{id}?api-version=v1

Ottenere informazioni dettagliate specifiche in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore univoco per il report di informazioni dettagliate.
includeCoordinates	query	No	boolean	Indica se includere le coordinate per la visualizzazione nella risposta. Il valore predefinito è falso.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Insights=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Informazioni dettagliate

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Archivi di memoria

Creare un archivio di memoria

POST {endpoint}/memory_stores?api-version=v1

Creare un archivio di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
Definizione	MemoryStoreDefinition	Definizione di base per le configurazioni dell'archivio di memoria.	Sì
└* tipo	MemoryStoreKind	Tipo di archivio di memoria.	Sì
descrizione	string	Descrizione leggibile dell'archivio memoria. Vincoli: maxLength: 512	No
metadata	object	Metadati arbitrari chiave-valore da associare all'archivio di memoria.	No
nome	string	Nome dell'archivio di memoria. Vincoli: maxLength: 256	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare gli archivi di memoria

GET {endpoint}/memory_stores?api-version=v1

Elencare tutti gli archivi di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Aggiornare l'archivio memoria

POST {endpoint}/memory_stores/{name}?api-version=v1

Aggiornare un archivio di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria da aggiornare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione leggibile dell'archivio memoria. Vincoli: maxLength: 512	No
metadata	object	Metadati arbitrari chiave-valore da associare all'archivio di memoria.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Ottenere l'archivio di memoria

GET {endpoint}/memory_stores/{name}?api-version=v1

Recuperare un archivio di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Eliminare l'archivio memoria

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Eliminare un archivio di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria da eliminare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteMemoryStoreResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Ottenere il risultato dell'aggiornamento

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Ottenere il risultato dell'aggiornamento dell'archivio di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria.
update_id	path	Sì	string	ID dell'operazione di aggiornamento della memoria.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreUpdateResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Eliminare i ricordi dell'ambito

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Eliminare tutte le memorie associate a un oscilloscopio specifico da un archivio di memoria.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
scope	string	Spazio dei nomi che raggruppa logicamente e isola i ricordi da eliminare, ad esempio un ID utente.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreDeleteScopeResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Cerca ricordi

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Cerca ricordi rilevanti da un archivio di memoria in base al contesto della conversazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria da cercare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
items	matrice di OpenAI.InputItem	Elementi per i quali cercare i ricordi pertinenti.	No
options	MemorySearchOptions	Opzioni di ricerca in memoria.	No
└max_memories	integer	Numero massimo di elementi di memoria da restituire.	No
previous_search_id	string	ID univoco della richiesta di ricerca precedente, abilitando la ricerca incrementale della memoria da cui è stata interrotta l'ultima operazione.	No
scope	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreSearchResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Aggiornare i ricordi

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Aggiorna l'archivio di memoria con le memorie di conversazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
nome	path	Sì	string	Nome dell'archivio di memoria da aggiornare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: MemoryStores=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
items	matrice di OpenAI.InputItem	Elementi di conversazione da cui estrarre i ricordi.	No
previous_update_id	string	ID univoco della richiesta di aggiornamento precedente, abilitando gli aggiornamenti incrementali della memoria da cui è stata interrotta l'ultima operazione.	No
scope	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì
update_delay	integer	Periodo di timeout prima dell'elaborazione dell'aggiornamento della memoria in secondi. Se durante questo periodo viene ricevuta una nuova richiesta di aggiornamento, annulla la richiesta corrente e reimposta il timeout. Impostare su 0 per attivare immediatamente l'aggiornamento senza ritardo. Il valore predefinito è 300 (5 minuti).	No	300

Risposte

Codice di stato: 202

Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Tipo di contenuto	Type	Descrizione
application/json	MemoryStoreUpdateResponse

Intestazioni di risposta:

Intestazione	Type	Description
Operazione-Localizzazione	string	Posizione per il monitoraggio dello stato dell'operazione.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Conversazioni

Creare una conversazione

POST {endpoint}/openai/v1/conversations

Creare una conversazione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
items	matrice di OpenAI.InputItem		No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ConversationResource

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare le conversazioni

GET {endpoint}/openai/v1/conversations

Restituisce l'elenco di tutte le conversazioni.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
agent_name	query	No	string	Filtrare in base al nome dell'agente. Se specificato, verranno restituiti solo gli elementi associati all'agente specificato.
agent_id	query	No	string	Filtrare in base all'ID agente nel formato name:version. Se specificato, verranno restituiti solo gli elementi associati all'ID agente specificato.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Aggiornare la conversazione

POST {endpoint}/openai/v1/conversations/{conversation_id}

Aggiornare una conversazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione da aggiornare.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ConversationResource

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Ottenere una conversazione

GET {endpoint}/openai/v1/conversations/{conversation_id}

Recupera una conversazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ConversationResource

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elimina conversazione

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Elimina una conversazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione da eliminare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.DeletedConversationResource

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Creare elementi di conversazione

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Creare elementi in una conversazione con l'ID specificato.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione in cui deve essere creato l'elemento.
Includono	query	No	matrice	Campi aggiuntivi da includere nella risposta. Per altre informazioni, vedere il include parametro per elencare gli elementi di conversazione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
items	matrice di OpenAI.Item	Elementi da aggiungere alla conversazione. È possibile aggiungere fino a 20 elementi alla volta.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ConversationItemList

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare gli elementi della conversazione

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Elencare tutti gli elementi per una conversazione con l'ID specificato.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione in cui devono essere elencati gli elementi.
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
item_type	query	No	string Valori possibili: , message, , , output_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Filtra per tipo di elemento. Se specificato, verranno restituiti solo gli elementi del tipo specificato.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Ottenere l'elemento della conversazione

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Ottenere un singolo elemento da una conversazione con gli ID specificati.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione che contiene l'elemento.
item_id	path	Sì	string	ID dell'elemento della conversazione da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.OutputItem

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Eliminare l'elemento della conversazione

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Eliminare un elemento da una conversazione con gli ID specificati.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Sì	string	ID della conversazione da cui deve essere eliminato l'elemento.
item_id	path	Sì	string	ID dell'elemento della conversazione da eliminare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ConversationResource

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Evals

Valutazioni - valutazioni list

GET {endpoint}/openai/v1/evals

Elencare tutte le valutazioni Elencare le valutazioni per un progetto.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
dopo	query	No	string	Identificatore dell'ultima esecuzione della richiesta di impaginazione precedente.
limit	query	No	integer	Numero di esecuzioni da recuperare.
order	query	No	string Valori possibili: asc, desc	Ordinamento delle esecuzioni in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente. Di default è asc.
ordina per	query	No	string Valori possibili: created_at, updated_at	Le valutazioni possono essere ordinate in base all'ora di creazione o all'ultima ora di aggiornamento. Usare created_at per l'ora di creazione o updated_at per l'ora dell'ultimo aggiornamento.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Valutazioni - creare valutazioni

POST {endpoint}/openai/v1/evals

Creare la valutazione Creare la struttura di una valutazione che può essere usata per testare le prestazioni di un modello. Una valutazione è un set di criteri di test e la configurazione per un'origine dati, che determina lo schema dei dati usati nella valutazione. Dopo aver creato una valutazione, è possibile eseguirla in modelli e parametri del modello diversi. Sono supportati diversi tipi di classificatori e origini dati. Per altre informazioni, vedere

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
configurazione_sorgente_dati	OpenAI.CreateEvalCustomDataSourceConfig o OpenAI.CreateEvalLogsDataSourceConfig o OpenAI.CreateEvalStoredCompletionsDataSourceConfig o AzureAIDataSourceConfig	Configurazione per l'origine dati utilizzata per le esecuzioni di valutazione. Determina lo schema dei dati usati nella valutazione.	Sì
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome della valutazione.	No
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
criteri_di_test	matrice di OpenAI.EvalGraderLabelModel o OpenAI.EvalGraderStringCheck o OpenAI.EvalGraderTextSimilarity o OpenAI.EvalGraderPython o OpenAI.EvalGraderScoreModel o EvalGraderAzureAIEvaluator	Elenco di classificatori per tutte le esecuzioni di valutazione in questo gruppo. I classificatori possono fare riferimento a variabili nell'origine dati usando la notazione con parentesi graffe doppie, ad esempio {{item.variable_name}}. Per fare riferimento all'output del modello, usare lo sample spazio dei nomi (ad esempio, {{sample.output_text}}).	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Eval

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Valutazioni - elimina la valutazione

DELETE {endpoint}/openai/v1/evals/{eval_id}

Eliminare una valutazione Consente di eliminare una valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione da eliminare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteEvalResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Valutazioni - ottieni la valutazione

GET {endpoint}/openai/v1/evals/{eval_id}

Ottenere una valutazione Ottenere una valutazione in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Eval

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Valutazioni - aggiornamento della valutazione

POST {endpoint}/openai/v1/evals/{eval_id}

Aggiornare una valutazione Aggiornare determinate proprietà di una valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione da aggiornare.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string		No
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Eval

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Evals - Esecuzioni elenco

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Ottenere un elenco di esecuzioni per una valutazione Ottenere un elenco di esecuzioni per una valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione per la quale recuperare le esecuzioni.
dopo	query	No	string	Identificatore dell'ultima esecuzione della richiesta di impaginazione precedente.
limit	query	No	integer	Numero di esecuzioni da recuperare.
order	query	No	string Valori possibili: asc, desc	Ordinamento delle esecuzioni in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente. Di default è asc.
Stato	query	No	string Valori possibili: queued, in_progresscompleted, , canceled, failed . Filtra le esecuzioni per stato. Uno di queued, in_progress, failedcompleted, , canceled.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Evals : creare l'esecuzione di eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Creare un'esecuzione di valutazione

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione per la quale creare un'esecuzione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
fonte_dati	OpenAI.CreateEvalJsonlRunDataSource o OpenAI.CreateEvalCompletionsRunDataSource o OpenAI.CreateEvalResponsesRunDataSource o EvalRunDataSource	Dettagli sull'origine dati dell'esecuzione.	Sì
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome della corsa.	No
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvalRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Valutazioni - elimina la corsa di valutazione

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Eliminare l'esecuzione della valutazione Eliminare un'esecuzione di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione dalla quale eliminare l'esecuzione.
run_id	path	Sì	string	ID della sessione di esecuzione da eliminare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteEvalRunResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Valutazioni - ottieni la valutazione

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Ottenere un'esecuzione di valutazione Ottenere un'esecuzione di valutazione in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione per la quale recuperare le esecuzioni.
run_id	path	Sì	string	ID dell'esecuzione da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvalRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Evals - Annullare l'esecuzione di eval

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Annullare l'esecuzione della valutazione Annullare un'esecuzione di valutazione in corso.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione per la quale si desidera annullare l'esecuzione.
run_id	path	Sì	string	ID dell'esecuzione da annullare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvalRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Evals : ottenere gli elementi di output dell'esecuzione di eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Ottenere gli elementi di output dell'esecuzione della valutazione Ottenere un elenco di elementi di output per un'esecuzione di valutazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string
run_id	path	Sì	string	ID dell'esecuzione per la quale recuperare gli elementi di output.
dopo	query	No	string	Identificatore dell'ultima esecuzione della richiesta di impaginazione precedente.
limit	query	No	integer	Numero di esecuzioni da recuperare.
order	query	No	string Valori possibili: asc, desc	Ordinamento delle esecuzioni in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente. Di default è asc.
Stato	query	No	string Valori possibili: fail, pass	Filtrare gli elementi di output in base allo stato. Usare failed per filtrare in base all'output non riuscito elementi o pass per filtrare in base agli elementi di output passati.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Evals : ottenere l'elemento di output dell'esecuzione di eval

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Ottenere un elemento di output di un'esecuzione di valutazione Ottenere un elemento di output dell'esecuzione della valutazione in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Sì	string	ID della valutazione per la quale recuperare le esecuzioni.
run_id	path	Sì	string	ID dell'esecuzione da recuperare.
output_item_id	path	Sì	string	ID dell'elemento di output da recuperare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	EvalRunOutputItem

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Fine-Tuning

Creare un processo di ottimizzazione fine

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

Crea un processo di ottimizzazione che inizia il processo di creazione di un nuovo modello da un determinato set di dati.

La risposta include i dettagli del processo accodato, inclusi lo stato del processo e il nome dei modelli ottimizzati al termine.

Scopri di più sulla messa a punto

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
iperparametri	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└batch_size	string o OpenAI.integer		No	auto
└learning_rate_multiplier	string o OpenAI.numeric		No
└n_epochs	string o OpenAI.integer		No	auto
integrazioni	matrice di OpenAI.CreateFineTuningJobRequestIntegrations	Elenco di integrazioni da abilitare per il processo di ottimizzazione.	No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
method	OpenAI.FineTuneMethod	Metodo utilizzato per l'ottimizzazione.	No
model	string (vedere modelli validi di seguito)	Nome del modello da ottimizzare. È possibile selezionare una delle c0.	Sì
seed	OpenAI.integer (nullabile)		No
Suffisso	stringa (nullabile)	Stringa di un massimo di 64 caratteri che verrà aggiunta al nome del modello ottimizzato. Ad esempio, un suffix valore di "custom-model-name" produce un nome di modello come ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Vincoli: minLength: 1, maxLength: 64	No
file di allenamento	string	ID di un file caricato che contiene i dati di training. Per informazioni su come caricare un file, vedere Caricare un file. Il set di dati deve essere formattato come file JSONL. Inoltre, è necessario caricare il file con lo scopo fine-tune. Il contenuto del file deve variare a seconda che il modello usi la chat, il formato dei completamenti o se il metodo di ottimizzazione usa il formato preferenza . Consulta la guida fine-tuning per maggiori dettagli.	Sì
file_di_validazione	stringa (nullabile)	ID di un file caricato che contiene i dati di convalida. Se si specifica questo file, i dati vengono usati per generare la convalida metriche periodicamente durante l'ottimizzazione. Queste metriche possono essere visualizzate in file dei risultati di ottimizzazione. Gli stessi dati non devono essere presenti sia nei file di training che in quello di convalida. Il set di dati deve essere formattato come file JSONL. È necessario caricare il file con lo scopo fine-tune. Consulta la guida fine-tuning per maggiori dettagli.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare i processi di ottimizzazione delle prestazioni impaginati

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

Elencare i processi di ottimizzazione dell'organizzazione

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
dopo	query	No	string	Identificatore per l'ultimo processo della richiesta di impaginazione precedente.
limit	query	No	integer	Numero di processi di ottimizzazione da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Recuperare un processo di ottimizzazione fine

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

Ottenere informazioni su un processo di ottimizzazione.

Scopri di più sulla messa a punto

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
id_lavoro_affinamento	path	Sì	string	ID del processo di ottimizzazione.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Annullare il processo di ottimizzazione

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

Annullare immediatamente un processo di ottimizzazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
id_lavoro_affinamento	path	Sì	string	ID del processo di ottimizzazione da annullare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare i checkpoint dei processi di ottimizzazione

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

Elencare i checkpoint per un processo di ottimizzazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
id_lavoro_affinamento	path	Sì	string	ID del processo di ottimizzazione per cui ottenere i checkpoint.
dopo	query	No	string	Identificatore dell'ultimo ID del checkpoint della richiesta di impaginazione precedente.
limit	query	No	integer	Numero di checkpoint da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare gli eventi del processo di ottimizzazione

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

Ottenere aggiornamenti dello stato con granularità fine per un processo di ottimizzazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
id_lavoro_affinamento	path	Sì	string	ID del processo di ottimizzazione per cui ottenere gli eventi.
dopo	query	No	string	Identificatore per l'ultimo evento della precedente richiesta di paginazione.
limit	query	No	integer	Numero di eventi da recuperare.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.ListFineTuningJobEventsResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Sospendere il processo di ottimizzazione fine

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

Sospendere un processo di ottimizzazione in esecuzione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
id_lavoro_affinamento	path	Sì	string	ID del processo di ottimizzazione da sospendere.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Riprendere il processo di ottimizzazione

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

Riprendere un processo di ottimizzazione sospeso.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
id_lavoro_affinamento	path	Sì	string	ID del processo di ottimizzazione da riprendere.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.FineTuningJob

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Risposte

Creare una risposta : creare il flusso di risposta

POST {endpoint}/openai/v1/responses

Crea una risposta del modello. Crea una risposta del modello (risposta di streaming).

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
sfondo	booleano (nullable)		No
conversazione	OpenAI.ConversationParam (nullabile)	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.	No
Includono	matrice di OpenAI.IncludeEnum		No
input	OpenAI.InputParam	Input di testo, immagine o file nel modello, usato per generare una risposta. Ulteriori informazioni: - Input di testo e output - Input dell'immagine - Input di file - Stato conversazione - Chiamata di funzione	No
instructions	stringa (nullabile)		No
max_output_tokens	OpenAI.integer (nullabile)		No
max_tool_calls	OpenAI.integer (nullabile)		No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
model	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	No
chiamate_parallele_agli_strumenti	booleano (nullable)		No	True
previous_response_id	stringa (nullabile)		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
reasoning	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└* sforzo	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
└─ genera_sommario	enum	Valori possibili: auto, concise, detailed	No
└─ Riepilogo	enum	Valori possibili: auto, concise, detailed	No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
livello_servizio	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	No
store	booleano (nullable)		No	True
stream	booleano (nullable)		No
stream_options	OpenAI.ResponseStreamOptions (nullabile)	Opzioni per le risposte in streaming. Impostare questa impostazione solo quando si imposta stream: true.	No
└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
structured_inputs	object	Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta.	No
Temperatura	OpenAI.numeric (nullabile)		No	1
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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
top_logprobs	OpenAI.integer (nullabile)		No
top_p	OpenAI.numeric (nullabile)		No	1
truncation	enum	Valori possibili: auto, disabled	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. Scopri di più.	No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Elencare le risposte

GET {endpoint}/openai/v1/responses

Restituisce l'elenco di tutte le risposte.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.
agent_name	query	No	string	Filtrare in base al nome dell'agente. Se specificato, verranno restituiti solo gli elementi associati all'agente specificato.
agent_id	query	No	string	Filtrare in base all'ID agente nel formato name:version. Se specificato, verranno restituiti solo gli elementi associati all'ID agente specificato.
conversation_id	query	No	string	Filtrare in base all'ID conversazione. Se specificato, verranno restituite solo le risposte associate alla conversazione specificata.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Conversazione di risposta compatta

POST {endpoint}/openai/v1/responses/compact

Produce una compattazione di una conversazione di risposte.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
input	stringa o matrice di OpenAI.InputItem		No
instructions	stringa (nullabile)		No
model	OpenAI.ModelIdsCompaction	ID modello usato per generare la risposta, ad esempio gpt-5 o o3. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, caratteristiche delle prestazioni e punti di prezzo. Fare riferimento alla guida del modello per esplorare e confrontare i modelli disponibili.	Sì
previous_response_id	stringa (nullabile)		No

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.CompactResource

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Ottenere la risposta : ottenere il flusso di risposta

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

Recupera una risposta del modello con l'ID specificato. Recupera una risposta del modello con l'ID specificato (risposta di streaming).

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sì	string
include[]	query	No	matrice
stream	query	No	boolean
starting_after	query	No	integer

Intestazione della richiesta

Name	Obbligatorio	Type	Description
accettare	Falso	string Valori possibili: text/event-stream

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Eliminare la risposta

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

Elimina una risposta del modello.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sì	string	ID della risposta da eliminare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteResponseResult

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Annulla risposta

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

Annulla una risposta del modello.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sì	string	ID della risposta da annullare.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	OpenAI.Response

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

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	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Sì	string
limit	query	No	integer	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20.
order	query	No	string Valori possibili: asc, desc	Ordinare l'ordinamento in base al created_at timestamp degli oggetti. asc per l'ordine crescente edesc per ordine decrescente.
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.
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.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	object	Dati di risposta per un elenco di elementi richiesto.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Redteams

Redteams - elenco

GET {endpoint}/redTeams/runs?api-version=v1

Elencare un redteam in base al nome.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: RedTeams=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedRedTeam

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Redteams - ottieni

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Ottenere un redteam in base al nome.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
nome	path	Sì	string	Identificatore dell'esecuzione del team rosso.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: RedTeams=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	RedTeam

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Redteams - Create

POST {endpoint}/redTeams/runs:run?api-version=v1

Crea un'esecuzione redteam.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: RedTeams=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
applicationScenario	string	Scenario dell'applicazione per l'operazione red team, per generare attacchi specifici dello scenario.	No
attackStrategies	matrice di AttackStrategy	Elenco di strategie di attacco o elenchi annidati di strategie di attacco.	No
displayName	string	Nome dell'esecuzione del red-team.	No
id	string (sola lettura)	Identificatore dell'esecuzione del team rosso.	Sì
numTurns	integer	Numero di round di simulazione.	No
properties	object	Proprietà della squadra rossa. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà.	No
riskCategories	matrice di RiskCategory	Elenco delle categorie di rischio per cui generare gli obiettivi di attacco.	No
simulationOnly	boolean	Solo simulazione o simulazione + valutazione. False predefinito, se true l'analisi restituisce il risultato della conversazione non di valutazione.	No	Falso
Stato	string (sola lettura)	Stato della squadra rossa. È impostato dal servizio ed è di sola lettura.	No
tags	object	Tag della squadra rossa. A differenza delle proprietà, i tag sono completamente modificabili.	No
target	TargetConfig	Classe astratta per la configurazione del target.	Sì
└─ Tipo	string	Tipo della configurazione del modello.	Sì

Risposte

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	RedTeam

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Schedules

Pianificazioni - elenco

GET {endpoint}/schedules?api-version=v1

Elencare tutte le pianificazioni.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
type	query	No	string Valori possibili: Evaluation, Insight	Filtrare in base al tipo di pianificazione.
enabled	query	No	boolean	Filtrare in base allo stato abilitato.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Schedules=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedSchedule

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Pianificazioni - eliminazione

DELETE {endpoint}/schedules/{id}?api-version=v1

Elimina una pianificazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore della pianificazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Schedules=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 204

Descrizione: nessun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili.

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Pianificazioni : ottenere

GET {endpoint}/schedules/{id}?api-version=v1

Ottenere una pianificazione in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore della pianificazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Schedules=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Schedule

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Pianificazioni : creazione o aggiornamento

PUT {endpoint}/schedules/{id}?api-version=v1

Creare o aggiornare il modello di operazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore della pianificazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Schedules=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Corpo della richiesta

Content-Type: application/json

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione della pianificazione.	No
displayName	string	Nome della pianificazione.	No
enabled	boolean	Stato abilitato della pianificazione.	Sì
id	string (sola lettura)	Identificatore della pianificazione.	Sì
properties	object	Proprietà della pianificazione. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà.	No
provisioningStatus	ScheduleProvisioningStatus (sola lettura)	Pianificare lo stato del provisioning.	No
dati di sistema	oggetto (sola lettura)	Metadati di sistema per la risorsa.	Sì
tags	object	Tag della pianificazione. A differenza delle proprietà, i tag sono completamente modificabili.	No
compito	ScheduleTask	Modello di attività di pianificazione.	Sì
Configurazione di └*	object	Configurazione per l'attività.	No
└─ Tipo	ScheduleTaskType	Tipo dell'attività.	Sì
trigger	Trigger	Modello base per il Trigger del programma.	Sì
└─ Tipo	TriggerType	Tipo di trigger.	Sì

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	Schedule

Codice di stato: 201

Descrizione: la richiesta ha avuto esito positivo e una nuova risorsa è stata creata di conseguenza.

Tipo di contenuto	Type	Descrizione
application/json	Schedule

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Pianificazioni - Esecuzioni elenco

GET {endpoint}/schedules/{id}/runs?api-version=v1

Elencare tutte le esecuzioni di pianificazione.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.
id	path	Sì	string	Identificatore della pianificazione.
type	query	No	string Valori possibili: Evaluation, Insight	Filtrare in base al tipo di pianificazione.
enabled	query	No	boolean	Filtrare in base allo stato abilitato.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Schedules=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	PagedScheduleRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	Azure. Core.Foundations.ErrorResponse

Intestazioni di risposta:

Intestazione	Type	Description
x-ms-error-code	string	Codice di errore stringa che indica cosa è andato storto.

Pianificazioni - Get Run

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Ottenere una pianificazione eseguita in base all'ID.

Parametri dell'URI

Name	In	Obbligatorio	Type	Description
endpoint	path	Sì	string	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Sì	string	Identificatore univoco della pianificazione.
run_id	path	Sì	string	Identificatore univoco dell'esecuzione della pianificazione.
api-version	query	Sì	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Name	Obbligatorio	Type	Description
Foundry-Features	True	string Valori possibili: Schedules=V1Preview	È necessario un consenso esplicito del flag di funzionalità quando si usano le operazioni di anteprima o si modificano le risorse di anteprima persistenti.

Risposte

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	ScheduleRun

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Components

A2APreviewTool

Un agente che implementa il protocollo A2A.

Name	Type	Description	Obbligatorio	Predefinito
agent_card_path	string	Il percorso della scheda agente relativa a .base_url Se non specificato, il valore predefinito è /.well-known/agent-card.json	No
base_url	string	URL di base dell'agente.	No
project_connection_id	string	ID connessione nel project per il server A2A. La connessione memorizza l'autenticazione e altri dettagli di connessione necessari per connettersi al server A2A.	No
type	enum	Tipo dello strumento. Sempre "a2a_preview. Valori possibili: a2a_preview	Sì

AISearchIndexResource

Una risorsa dell'indice di ricerca AI.

Name	Type	Description	Obbligatorio	Predefinito
filter	string	stringa di filtro per la risorsa di ricerca. Altre informazioni sono disponibili qui.	No
index_asset_id	string	ID risorsa di indicizzazione per la risorsa di ricerca.	No
index_name	string	Nome di un indice in un oggetto IndexResource associato a questo agente.	No
project_connection_id	string	ID di connessione dell'indice in un oggetto IndexResource associato a questo agente.	No
Query_type	AzureAISearchQueryType	Tipi di query disponibili per lo strumento Azure AI Search.	No
top_k	integer	Numero di documenti da recuperare dalla ricerca e presenti al modello.	No

AgentClusterInsightRequest

Informazioni dettagliate sul set di risultati della valutazione dell'agente

Name	Type	Description	Obbligatorio	Predefinito
nomeagente	string	Identificatore dell'agente.	Sì
modelConfiguration	InsightModelConfiguration	Configurazione del modello utilizzato nella generazione dell'insight.	No
└* modelDeploymentName	string	Distribuzione del modello da valutare. Accetta solo il nome della distribuzione o con il nome della connessione come {connectionName}/<modelDeploymentName>.	Sì
type	enum	Tipo di richiesta. Valori possibili: AgentClusterInsight	Sì

AgentClusterInsightResult

Informazioni dettagliate dall'analisi del cluster di agenti.

Name	Type	Description	Obbligatorio	Predefinito
clusterInsight	ClusterInsightResult	Approfondimenti dall'analisi dei cluster.	Sì
type	enum	Tipo di risultato di informazioni dettagliate. Valori possibili: AgentClusterInsight	Sì

AgentContainerObject

Dettagli del contenitore di una versione specifica di un agente.

Name	Type	Description	Obbligatorio	Predefinito
container	ContainerDetails (sola lettura)	Informazioni dettagliate sul contenitore.	No
└health_state	string	Stato di integrità del contenitore.	Sì
└provisioning_error	string	Errore di provisioning del contenitore, se presente.	No
└provisioning_state	string	Stato di provisioning del contenitore.	Sì
└* repliche	matrice di ContainerReplica	Elenco di repliche nel contenitore.	Sì
└* stato	string	Stato del contenitore.	Sì
└updated_on	string	Ora dell'ultimo aggiornamento del contenitore.	Sì
creato_il	string	Ora di creazione del contenitore.	Sì
error_message	string (sola lettura)	Messaggio di errore se il contenitore non è riuscito a funzionare, se presente.	No
id	string (sola lettura)	Identificatore del contenitore.	No
max_replicas	integer	Numero massimo di repliche per il contenitore. Il valore predefinito è 1.	No
min_replicas	integer	Numero minimo di repliche per il contenitore. Il valore predefinito è 1.	No
object	enum	Tipo di oggetto, che è sempre 'agent.container'. Valori possibili: agent.container	Sì
Stato	AgentContainerStatus (sola lettura)	Stato del contenitore di una versione specifica di un agente.	Sì
updated_at	string	Ora dell'ultimo aggiornamento del contenitore.	Sì

AgentContainerOperationError

Dettagli dell'errore dell'operazione del contenitore, se presente.

Name	Type	Description	Obbligatorio	Predefinito
codice	string	Codice di errore dell'operazione contenitore, se presente.	Sì
message	string	Messaggio di errore dell'operazione contenitore, se presente.	Sì
type	string	Tipo di errore dell'operazione contenitore, se presente.	Sì

AgentContainerOperationObject

Operazione contenitore per una versione specifica di un agente.

Name	Type	Description	Obbligatorio	Predefinito
agent_id	string	L'ID dell'agente.	Sì
agent_version_id	string	ID della versione dell'agente.	Sì
container	AgentContainerObject	Dettagli del contenitore di una versione specifica di un agente.	No
└> contenitore	ContainerDetails (sola lettura)	Informazioni dettagliate sul contenitore.	No
└created_at	string (sola lettura)	Ora di creazione del contenitore.	Sì
└error_message	string (sola lettura)	Messaggio di errore se il contenitore non è riuscito a funzionare, se presente.	No
└* id	string (sola lettura)	Identificatore del contenitore.	No
└max_replicas	integer	Numero massimo di repliche per il contenitore. Il valore predefinito è 1.	No
└min_replicas	integer	Numero minimo di repliche per il contenitore. Il valore predefinito è 1.	No
└─ oggetto	enum	Tipo di oggetto, che è sempre 'agent.container'. Valori possibili: agent.container	Sì
└─ stato	AgentContainerStatus (sola lettura)	Stato del contenitore di una versione specifica di un agente.	Sì
└updated_at	string (sola lettura)	Ora dell'ultimo aggiornamento del contenitore.	Sì
error	AgentContainerOperationError	Dettagli dell'errore dell'operazione del contenitore, se presente.	No
└─ codice	string	Codice di errore dell'operazione contenitore, se presente.	Sì
└* messaggio	string	Messaggio di errore dell'operazione contenitore, se presente.	Sì
└─ Tipo	string	Tipo di errore dell'operazione contenitore, se presente.	Sì
id	string	ID dell'operazione del contenitore. Questo ID è un identificatore univoco nel sistema.	Sì
Stato	AgentContainerOperationStatus	Stato dell'operazione del contenitore per una versione specifica di un agente.	Sì

AgentContainerOperationStatus

Stato dell'operazione del contenitore per una versione specifica di un agente.

Proprietà	Value
Type	string
Valori	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Stato del contenitore di una versione specifica di un agente.

Proprietà	Value
Type	string
Valori	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Discriminante per AgentDefinition

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

Valore del tipo	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Name	Type	Description	Obbligatorio	Predefinito
kind	AgentKind		Sì
rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
└rai_policy_name	string	Nome del criterio RAI da applicare.	Sì

AgentKind

Proprietà	Value
Type	string
Valori	prompt hosted container_app workflow

AgentObject

Name	Type	Description	Obbligatorio	Predefinito
id	string	Identificatore univoco dell'agente.	Sì
nome	string	Nome dell'agente. Vincoli: maxLength: 63	Sì
object	enum	Tipo di oggetto, che è sempre 'agent'. Valori possibili: agent	Sì
versions	object	La versione più recente dell'agente.	Sì
└└+ più recente	AgentVersionObject		Sì

AgentProtocol

Proprietà	Value
Type	string
Valori	activity_protocol responses

AgentReference

Name	Type	Description	Obbligatorio	Predefinito
nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
type	enum	Valori possibili: agent_reference	Sì
version	string	Identificatore della versione dell'agente.	No

AgentTaxonomyInput

Configurazione dell'input per la tassonomia di valutazione quando il tipo di input è agente.

Name	Type	Description	Obbligatorio	Predefinito
riskCategories	matrice di RiskCategory	Elenco delle categorie di rischio da valutare.	Sì
target	Destinazione	Classe base per bersagli con supporto per discriminatore.	Sì
└─ Tipo	string	Tipo di destinazione.	Sì
type	enum	Tipo di input della tassonomia di valutazione. Valori possibili: agent	Sì

AgentTaxonomyInputUpdate

Configurazione dell'input per la tassonomia di valutazione quando il tipo di input è agente.

Name	Type	Description	Obbligatorio	Predefinito
riskCategories	matrice di RiskCategory	Elenco delle categorie di rischio da valutare.	No
target	TargetUpdate	Classe base per bersagli con supporto per discriminatore.	No
└─ Tipo	string	Tipo di destinazione.	Sì
type	enum	Tipo di input della tassonomia di valutazione. Valori possibili: agent	Sì

AgentVersionObject

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Il timestamp Unix (secondi) al momento della creazione dell'agente.	Sì
Definizione	AgentDefinition		Sì
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
id	string	Identificatore univoco della versione dell'agente.	Sì
metadata	oggetto (nullable)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	Sì
nome	string	Nome dell'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. Vincoli: maxLength: 256	Sì
object	enum	Il tipo di oggetto, che è sempre 'agent.version'. Valori possibili: agent.version	Sì
version	string	Identificatore della versione dell'agente. Gli agenti sono immutabili e ogni aggiornamento crea una nuova versione mantenendo lo stesso nome.	Sì

AgenticIdentityPreviewCredentials

Definizione delle credenziali di identità agentica

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di credenziale Valori possibili: AgenticIdentityToken_Preview	Sì

ApiErrorResponse

Risposta di errore per errori API.

Name	Type	Description	Obbligatorio	Predefinito
error	OpenAI.Error		Sì

ApiKeyCredentials

Definizione delle credenziali della chiave API

Name	Type	Description	Obbligatorio	Predefinito
key	string (sola lettura)	Chiave API	No
type	enum	Tipo di credenziale Valori possibili: ApiKey	Sì

AssetCredentialResponse

Rappresenta un riferimento a un BLOB per l'utilizzo

Name	Type	Description	Obbligatorio	Predefinito
blobReference	BlobReference	Dettagli di riferimento BLOB.	Sì
└* blobUri	string	Percorso URI BLOB per il caricamento dei dati da parte del client. Esempio: https://blob.windows.core.net/Container/Path	Sì
└* credenziali	SasCredential	Informazioni sulle credenziali per accedere all'account di archiviazione.	Sì
└\ storageAccountArmId	string	ID ARM dell'account di archiviazione da usare.	Sì

AssetId

Identificatore di un asset salvato.

Tipo: string

AttaccoStrategy

Strategie per gli attacchi.

Proprietà	Value
Descrizione	Strategie per gli attacchi.
Type	string
Valori	easy moderate difficult ascii_art ascii_smuggler atbash base64 binary caesar character_space jailbreak ansi_attack character_swap suffix_append string_join unicode_confusable unicode_substitution diacritic flip leetspeak rot13 morse url baseline indirect_jailbreak tense multi_turn crescendo

Azure. Core.Foundations.Error

Oggetto error.

Name	Type	Description	Obbligatorio	Predefinito
codice	string	Uno di un set definito dal server di codici di errore.	Sì
details	matrice di Azure. Core.Foundations.Error	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.	No
innererror	Azure. Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ codice	string	Uno di un set definito dal server di codici di errore.	No
└\ innererror	Azure. Core.Foundations.InnerError	Errore interno.	No
message	string	Rappresentazione leggibile dell'errore.	Sì
target	string	Destinazione dell'errore.	No

Azure. Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Name	Type	Description	Obbligatorio	Predefinito
error	Azure. Core.Foundations.Error	Oggetto error.	Sì
└─ codice	string	Uno di un set definito dal server di codici di errore.	Sì
└* dettagli	matrice di Azure. Core.Foundations.Error	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.	No
└\ innererror	Azure. Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.	No
└* messaggio	string	Rappresentazione leggibile dell'errore.	Sì
Destinazione └*	string	Destinazione dell'errore.	No

Azure. Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description	Obbligatorio	Predefinito
codice	string	Uno di un set definito dal server di codici di errore.	No
innererror	Azure. Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ codice	string	Uno di un set definito dal server di codici di errore.	No
└\ innererror	Azure. Core.Foundations.InnerError	Errore interno.	No

Azure. Core.Foundations.OperationState

Enumerazione che descrive gli stati di funzionamento consentiti.

Proprietà	Value
Descrizione	Enumerazione che descrive gli stati di funzionamento consentiti.
Type	string
Valori	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Identificatore univoco universale

Tipo: string

Formato: uuid

AzureAIAgentTarget

Rappresenta un target che specifica un agente AI Azure.

Name	Type	Description	Obbligatorio	Predefinito
nome	string	Identificatore univoco dell'agente di intelligenza artificiale Azure.	Sì
tool_descriptions	matrice di ToolDescription	Parametri utilizzati per controllare il comportamento di campionamento dell'agente durante la generazione del testo.	No
type	enum	Il tipo di target, sempre azure_ai_agent. Valori possibili: azure_ai_agent	Sì
version	string	Versione dell'agente di intelligenza artificiale Azure.	No

AzureAIAgentTargetUpdate

Rappresenta un target che specifica un agente AI Azure.

Name	Type	Description	Obbligatorio	Predefinito
nome	string	Identificatore univoco dell'agente di intelligenza artificiale Azure.	No
tool_descriptions	matrice di ToolDescription	Parametri utilizzati per controllare il comportamento di campionamento dell'agente durante la generazione del testo.	No
type	enum	Il tipo di target, sempre azure_ai_agent. Valori possibili: azure_ai_agent	Sì
version	string	Versione dell'agente di intelligenza artificiale Azure.	No

AzureAIDataSourceConfig

Name	Type	Description	Obbligatorio	Predefinito
situazione	enum	Scenario dello schema dei dati. Valori possibili: red_team, responses, traces_preview, synthetic_data_gen_preview	Sì
schema	object	Schema JSON dell'oggetto complessivo per gli elementi dell'origine dati di esecuzione.	Sì
type	enum	Tipo di oggetto, che è sempre azure_ai_source. Valori possibili: azure_ai_source	Sì

AzureAIModelTarget

Rappresenta un target che specifica un modello Azure AI per operazioni che richiedono la selezione del modello.

Name	Type	Description	Obbligatorio	Predefinito
model	string	Identificatore univoco del modello di intelligenza artificiale Azure.	No
sampling_params	ModelSamplingParams	Rappresenta un set di parametri utilizzati per controllare il comportamento di campionamento di un modello linguistico durante la generazione di testo.	No
└ max_completion_tokens	integer	Numero massimo di token consentiti nel completamento.	Sì
└* seed	integer	Valore di inizializzazione casuale per la riproducibilità.	Sì
└* temperatura	Numero	Parametro di temperatura per il campionamento.	Sì
└top_p	Numero	Parametro top-p per il campionamento del nucleo.	Sì
type	enum	Il tipo di target, sempre azure_ai_model. Valori possibili: azure_ai_model	Sì

AzureAIModelTargetUpdate

Rappresenta un target che specifica un modello Azure AI per operazioni che richiedono la selezione del modello.

Name	Type	Description	Obbligatorio	Predefinito
model	string	Identificatore univoco del modello di intelligenza artificiale Azure.	No
sampling_params	ModelSamplingParamsUpdate	Rappresenta un set di parametri utilizzati per controllare il comportamento di campionamento di un modello linguistico durante la generazione di testo.	No
└ max_completion_tokens	integer	Numero massimo di token consentiti nel completamento.	No
└* seed	integer	Valore di inizializzazione casuale per la riproducibilità.	No
└* temperatura	Numero	Parametro di temperatura per il campionamento.	No
└top_p	Numero	Parametro top-p per il campionamento del nucleo.	No
type	enum	Il tipo di target, sempre azure_ai_model. Valori possibili: azure_ai_model	Sì

AzureAIResponsesEvalRunDataSource

Rappresenta un'origine dati per le esecuzioni di valutazione specifiche degli scenari di valutazione continua.

Name	Type	Description	Obbligatorio	Predefinito
event_configuration_id	string	Nome della configurazione dell'evento associato a questa esecuzione di valutazione.	Sì
item_generation_params	ResponseRetrievalItemGenerationParams	Rappresenta i parametri per la generazione di elementi di recupero della risposta.	Sì
└data_mapping	object	Mapping dai campi di origine al campo response_id, necessario per recuperare la cronologia delle chat.	Sì
└max_num_turns	integer	Numero massimo di turni di cronologia chat da valutare.	Sì
└─ sorgente	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Origine da cui viene letto il contenuto JSONL.	Sì
└─ Tipo	enum	Tipo di parametri di generazione di elementi, sempre response_retrieval. Valori possibili: response_retrieval	Sì
max_runs_hourly	integer	Numero massimo di esecuzioni di valutazione consentite all'ora.	Sì
type	enum	Tipo di origine dati, sempre azure_ai_responses. Valori possibili: azure_ai_responses	Sì

AzureIAIndiceDiRicerca

definizione dell'indice Azure AI Search

Name	Type	Description	Obbligatorio	Predefinito
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	enum	Tipo di indice Valori possibili: AzureSearch	Sì
version	string (sola lettura)	La versione della risorsa	Sì

AzureAISearchIndexUpdate

definizione dell'indice Azure AI Search

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	enum	Tipo di indice Valori possibili: AzureSearch	Sì

AzureAISearchQueryType

Tipi di query disponibili per lo strumento Azure AI Search.

Proprietà	Value
Descrizione	Tipi di query disponibili per lo strumento Azure AI Search.
Type	string
Valori	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

Le informazioni di definizione di input per uno strumento di ricerca Azure AI come usate per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
azure_ai_search	AzureAISearchToolResource	Set di risorse di indice usate dallo strumento azure_ai_search.	Sì
└++ indici	matrice di AISearchIndexResource	Indici associati all'agente. Può essere presente un massimo di 1 indice risorsa collegata all'agente. Vincoli: maxItems: 1	Sì
type	enum	Il tipo di oggetto, che è sempre 'azure_ai_search'. Valori possibili: azure_ai_search	Sì

AzureAISearchToolResource

Set di risorse di indice usate dallo strumento azure_ai_search.

Name	Type	Description	Obbligatorio	Predefinito
indici	matrice di AISearchIndexResource	Indici associati all'agente. Può essere presente un massimo di 1 indice risorsa collegata all'agente.	Sì

AzureFunctionBinding

Struttura per mantenere storage nome della coda e URI.

Name	Type	Description	Obbligatorio	Predefinito
storage_queue	AzureFunctionStorageQueue	Struttura per mantenere storage nome della coda e URI.	Sì
└queue_name	string	Nome di una coda di archiviazione della funzione Azure.	Sì
└queue_service_endpoint	string	URI per il servizio di accodamento Archiviazione di Azure che consente di modificare una coda.	Sì
type	enum	Tipo di associazione, che è sempre "storage_queue". Valori possibili: storage_queue	Sì

AzureFunctionDefinition

La definizione di funzione Azure.

Name	Type	Description	Obbligatorio	Predefinito
funzione	object	Definizione della funzione di Azure e dei relativi parametri.	Sì
└* descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
└> nome	string	Nome della funzione che deve essere chiamata.	Sì
└─ Parametri	object	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema.	Sì
input_binding	AzureFunctionBinding	Struttura per mantenere storage nome della coda e URI.	Sì
└storage_queue	AzureFunctionStorageQueue	Coda di archiviazione.	Sì
└─ Tipo	enum	Tipo di associazione, che è sempre "storage_queue". Valori possibili: storage_queue	Sì
output_binding	AzureFunctionBinding	Struttura per mantenere storage nome della coda e URI.	Sì
└storage_queue	AzureFunctionStorageQueue	Coda di archiviazione.	Sì
└─ Tipo	enum	Tipo di associazione, che è sempre "storage_queue". Valori possibili: storage_queue	Sì

AzureFunctionStorageQueue

Struttura per mantenere storage nome della coda e URI.

Name	Type	Description	Obbligatorio	Predefinito
queue_name	string	Nome di una coda di archiviazione della funzione Azure.	Sì
queue_service_endpoint	string	URI per il servizio di accodamento Archiviazione di Azure che consente di modificare una coda.	Sì

AzureFunctionTool

Le informazioni di definizione in input per uno strumento di funzione Azure, come usato per configurare un Agente.

Name	Type	Description	Obbligatorio	Predefinito
azure_function	AzureFunctionDefinition	La definizione di funzione Azure.	Sì
Funzione └*	object	Definizione della funzione di Azure e dei relativi parametri.	Sì
└* descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
└> nome	string	Nome della funzione che deve essere chiamata.	Sì
└─ Parametri	object	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema.	Sì
└input_binding	AzureFunctionBinding	Coda di archiviazione di input. Il trigger di archiviazione code esegue una funzione quando vengono aggiunti messaggi.	Sì
└output_binding	AzureFunctionBinding	Coda di archiviazione di output. La funzione scrive l'output in questa coda quando vengono elaborati gli elementi di input.	Sì
type	enum	Il tipo di oggetto, che è sempre 'browser_automation'. Valori possibili: azure_function	Sì

AzureOpenAIModelConfiguration

Azure configurazione del modello OpenAI. La versione dell'API verrebbe selezionata dal servizio per l'esecuzione di query sul modello.

Name	Type	Description	Obbligatorio	Predefinito
modelDeploymentName	string	Nome della distribuzione per il modello AOAI. Esempio: gpt-4o se in AIServices o in base alla connection_name/deployment_name connessione (ad esempio my-aoai-connection/gpt-4o).	Sì
type	enum	Valori possibili: AzureOpenAIModel	Sì

BaseCredentials

Una classe di base per le credenziali di connessione

Discriminare per BaseCredentials

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

Valore del tipo	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	Customcredential
SAS	SasCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Name	Type	Description	Obbligatorio	Predefinito
type	CredentialType (sola lettura)	Tipo di credenziale utilizzato dalla connessione	Sì

BingCustomSearchConfiguration

Una bing configurazione di ricerca personalizzata.

Name	Type	Description	Obbligatorio	Predefinito
count	integer	Numero di risultati della ricerca da restituire nella risposta dell'API Bing	No
freshness	string	Filtrare i risultati della ricerca in base a un intervallo di tempo specifico. Vedere i valori accettati qui.	No
instance_name	string	Nome dell'istanza di configurazione personalizzata assegnata alla configurazione.	Sì
Mercato	string	Il mercato da cui provengono i risultati.	No
project_connection_id	string	Project ID connessione per l'uso di base con ricerca Bing	Sì
set_lang	string	Lingua da usare per le stringhe dell'interfaccia utente quando si chiama l'API Bing.	No

BingCustomSearchPreviewTool

Informazioni sulla definizione di input per un Bing strumento di ricerca personalizzato usato per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
bing_custom_search_preview	BingCustomSearchToolParameters	Il bing parametri dello strumento di ricerca personalizzato.	Sì
└search_configurations	matrice di BingCustomSearchConfiguration	Le connessioni project collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	Sì
type	enum	Il tipo di oggetto, che è sempre 'bing_custom_search_preview'. Valori possibili: bing_custom_search_preview	Sì

BingCustomSearchToolParameters

Il bing parametri dello strumento di ricerca personalizzato.

Name	Type	Description	Obbligatorio	Predefinito
search_configurations	matrice di BingCustomSearchConfiguration	Le connessioni project collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento.	Sì

BingGroundingSearchConfiguration

Configurazione di ricerca per Bing grounding

Name	Type	Description	Obbligatorio	Predefinito
count	integer	Numero di risultati della ricerca da restituire nella risposta dell'API Bing	No
freshness	string	Filtrare i risultati della ricerca in base a un intervallo di tempo specifico. Vedere i valori accettati qui.	No
Mercato	string	Il mercato da cui provengono i risultati.	No
project_connection_id	string	Project ID connessione per l'uso di base con ricerca Bing	Sì
set_lang	string	Lingua da usare per le stringhe dell'interfaccia utente quando si chiama l'API Bing.	No

BingGroundingSearchToolParameters

Parametri dello strumento di ricerca a terra bing.

Name	Type	Description	Obbligatorio	Predefinito
search_configurations	matrice di BingGroundingSearchConfiguration	Configurazioni di ricerca associate a questo strumento. Può essere presente un massimo di 1 risorsa di configurazione di ricerca collegata allo strumento.	Sì

BingGroundingTool

Informazioni sulla definizione di input per un bing strumento di ricerca a terra usato per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
bing_grounding	BingGroundingSearchToolParameters	Parametri dello strumento di ricerca a terra bing.	Sì
└search_configurations	matrice di BingGroundingSearchConfiguration	Configurazioni di ricerca associate a questo strumento. Può essere presente un massimo di 1 risorsa di configurazione di ricerca collegata allo strumento. Vincoli: maxItems: 1	Sì
type	enum	Tipo di oggetto, che è sempre "bing_grounding". Valori possibili: bing_grounding	Sì

BlobReference

Dettagli di riferimento BLOB.

Name	Type	Description	Obbligatorio	Predefinito
BLOBUri	string	Percorso URI BLOB per il caricamento dei dati da parte del client. Esempio: https://blob.windows.core.net/Container/Path	Sì
credential	SasCredential	Definizione delle credenziali di firma di accesso condiviso	Sì
└* sasUri	string (sola lettura)	URI di firma di accesso condiviso	Sì
└─ Tipo	enum	Tipo di credenziale Valori possibili: SAS	Sì
storageAccountArmId	string	ID ARM dell'account di archiviazione da usare.	Sì

BrowserAutomationPreviewTool

Le informazioni di input della definizione per uno strumento di automazione del browser, utilizzate per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
browser_automation_preview	BrowserAutomationToolParameters	Definizione dei parametri di input per il Browser Automation Tool.	Sì
Connessione └*	BrowserAutomationToolConnectionParameters	Parametri di connessione del progetto associati allo strumento di automazione browser.	Sì
type	enum	Il tipo di oggetto, che è sempre 'browser_automation_preview'. Valori possibili: browser_automation_preview	Sì

BrowserAutomationToolConnectionParameters

Definizione dei parametri di input per la connessione utilizzata dal Browser Automation Tool.

Name	Type	Description	Obbligatorio	Predefinito
project_connection_id	string	ID della connessione del progetto alla risorsa playwright Azure.	Sì

BrowserAutomationToolParameters

Definizione dei parametri di input per il Browser Automation Tool.

Name	Type	Description	Obbligatorio	Predefinito
connessione	BrowserAutomationToolConnectionParameters	Definizione dei parametri di input per la connessione utilizzata dal Browser Automation Tool.	Sì
└project_connection_id	string	ID della connessione del progetto alla risorsa playwright Azure.	Sì

CaptureStructuredOutputsTool

Uno strumento per l'acquisizione di output strutturati

Name	Type	Description	Obbligatorio	Predefinito
outputs	StructuredOutputDefinition	Output strutturato che può essere prodotto dall'agente.	Sì
└* descrizione	string	Descrizione dell'output da generare. Usato dal modello per determinare quando generare l'output.	Sì
└> nome	string	Nome dell'output strutturato.	Sì
└─ Schema	object	Schema JSON per l'output strutturato.	Sì
└─ rigoroso	booleano (nullable)	Indica se applicare la convalida rigorosa. Valore predefinito true.	Sì
type	enum	Tipo dello strumento. Sempre capture_structured_outputs. Valori possibili: capture_structured_outputs	Sì

ChartCoordinate

Coordinate per il grafico di analisi.

Name	Type	Description	Obbligatorio	Predefinito
size	integer	Dimensioni dell'elemento del grafico.	Sì
x	integer	Coordinata dell'asse X.	Sì
y	integer	Coordinata dell'asse Y.	Sì

ChatSummaryMemoryItem

Un elemento di memoria contenente un riepilogo estratto dalle conversazioni.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	string	Il contenuto della memoria.	Sì
kind	enum	Tipo di elemento di memoria. Valori possibili: chat_summary	Sì
memory_id	string	L'ID univoco dell'elemento di memoria.	Sì
scope	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì
updated_at	integer	L'ora dell'ultimo aggiornamento dell'elemento in memoria.	Sì

ClusterInsightResult

Approfondimenti dall'analisi dei cluster.

Name	Type	Description	Obbligatorio	Predefinito
clusters	matrice di InsightCluster	Elenco di cluster identificati nelle informazioni dettagliate.	Sì
Coordinate	object	Mapping facoltativo di ID a coordinate 2D usate dall'esperienza utente per la visualizzazione. Le chiavi della mappa sono identificatori di stringa (ad esempio, un ID cluster o un ID di esempio) e i valori sono le coordinate e le dimensioni visive per il rendering in un grafico 2D. Questa proprietà viene omessa a meno che il client non richieda coordinate (ad esempio, passando includeCoordinates=true come parametro di query). Esempio: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Le coordinate sono destinate solo alla visualizzazione lato client e non modificare i risultati delle informazioni dettagliate canoniche.	No
summary	InsightSummary	Riepilogo dell'analisi dei cluster di errori.	Sì
Metodo └*	string	Metodo usato per il clustering.	Sì
└> sampleCount	integer	Numero totale di campioni analizzati.	Sì
└* uniqueClusterCount	integer	Numero totale di cluster univoci.	Sì
└* uniqueSubclusterCount	integer	Numero totale di etichette di sottocluster univoche.	Sì
└─ utilizzo	ClusterTokenUsage	Utilizzo dei token durante l'esecuzione dell'analisi del clustering	Sì

ClusterTokenUsage

Utilizzo dei token per l'analisi dei cluster

Name	Type	Description	Obbligatorio	Predefinito
inputTokenUsage	integer	utilizzo dei token di input	Sì
outputTokenUsage	integer	utilizzo del token di output	Sì
totalTokenUsage	integer	utilizzo totale dei token	Sì

CodeBasedEvaluatorDefinition

Definizione dell'analizzatore basata su codice utilizzando il codice Python

Name	Type	Description	Obbligatorio	Predefinito
code_text	string	Testo del codice inline per l'analizzatore	Sì
data_schema	object	Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
init_parameters	object	Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
metrics	object	Elenco delle metriche di output prodotte da questo valutatore	No
type	enum	Valori possibili: code	Sì

CompletionMessageToolCallChunk

Dettagli della chiamata dello strumento all'interno di un messaggio.

Name	Type	Description	Obbligatorio	Predefinito
funzione	FunctionToolCall	Dettagli di una chiamata dello strumento di funzione.	No
└─ Argomenti	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON.	Sì
└> nome	string	Il nome della funzione da chiamare.	Sì
id	string	ID per la chiamata allo strumento.	Sì
type	enum	Tipo di chiamata allo strumento, che è sempre "funzione". Valori possibili: function	Sì

Connessione

Risposta dall'elenco e operazioni di get connections

Name	Type	Description	Obbligatorio	Predefinito
credentials	BaseCredentials (sola lettura)	Una classe di base per le credenziali di connessione	Sì
└─ Tipo	CredentialType (sola lettura)	Tipo di credenziale utilizzata dalla connessione	Sì
id	string (sola lettura)	Identificatore univoco per la connessione, generato dal servizio	Sì
isDefault	booleano (sola lettura)	Indica se la connessione è contrassegnata come connessione predefinita del tipo	Sì
metadata	oggetto (sola lettura)	Metadati della connessione	Sì
nome	string (sola lettura)	Nome descrittivo della connessione, fornito dall'utente.	Sì
target	string (sola lettura)	URL di connessione da usare per questo servizio	Sì
type	ConnectionType (sola lettura)	Tipo (o categoria) della connessione	Sì

ConnectionType

Tipo (o categoria) della connessione

Proprietà	Value
Descrizione	Tipo (o categoria) della connessione
Type	string
Valori	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Definizione dell'agente dell'app contenitore.

Name	Type	Description	Obbligatorio	Predefinito
container_app_resource_id	string	ID risorsa dell'app contenitore Azure che ospita questo agente. Non modificabile tra le versioni.	Sì
container_protocol_versions	matrice di ProtocolVersionRecord	Protocolli supportati dall'agente per la comunicazione in ingresso dei contenitori.	Sì
ingress_subdomain_suffix	string	Suffisso da applicare al sottodominio dell'app quando si invia l'ingresso all'agente. Può trattarsi di un'etichetta ,ad esempio "---current", di una revisione specifica (ad esempio, "--0000001" o vuota per usare l'endpoint predefinito per l'app contenitore.	Sì
kind	enum	Valori possibili: container_app	Sì
rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
└rai_policy_name	string	Nome del criterio RAI da applicare.	Sì

ContainerDetails

Informazioni dettagliate sul contenitore.

Name	Type	Description	Obbligatorio	Predefinito
health_state	string	Stato di integrità del contenitore.	Sì
provisioning_error	string	Errore di provisioning del contenitore, se presente.	No
provisioning_state	string	Stato di provisioning del contenitore.	Sì
replicas	matrice di ContainerReplica	Elenco di repliche nel contenitore.	Sì
state	string	Stato del contenitore.	Sì
updated_on	string	Ora dell'ultimo aggiornamento del contenitore.	Sì

ContainerLogKind

Tipo di log da trasmettere da un contenitore.

Proprietà	Value
Type	string
Valori	console system

ContainerReplica

Informazioni su una replica del contenitore.

Name	Type	Description	Obbligatorio	Predefinito
container_state	string	Stato del contenitore della replica.	Sì
nome	string	Nome della replica.	Sì
state	string	Stato della replica.	Sì

ContinuousEvaluationRuleAction

Azione della regola di valutazione per la valutazione continua.

Name	Type	Description	Obbligatorio	Predefinito
evalId	string	Id Eval a cui aggiungere esecuzioni di valutazione continue.	Sì
maxHourlyRuns	integer	Numero massimo di esecuzioni di valutazione consentite all'ora.	No
type	enum	Valori possibili: continuousEvaluation	Sì

Indice di Cosmos DB

Definizione dell'indice dell'archivio vettoriale CosmosDB

Name	Type	Description	Obbligatorio	Predefinito
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	enum	Tipo di indice Valori possibili: CosmosDBNoSqlVectorStore	Sì
version	string (sola lettura)	La versione della risorsa	Sì

CosmosDBIndexUpdate

Definizione dell'indice dell'archivio vettoriale CosmosDB

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	enum	Tipo di indice Valori possibili: CosmosDBNoSqlVectorStore	Sì

CreateAgentFromManifestRequest

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	string	ID manifesto da cui importare la versione dell'agente.	Sì
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome univoco che identifica l'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Sì
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Sì

CreateAgentRequest

Name	Type	Description	Obbligatorio	Predefinito
Definizione	AgentDefinition		Sì
└* tipo	AgentKind		Sì
└rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome univoco che identifica l'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Sì

CreateAgentVersionFromManifestRequest

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	string	ID manifesto da cui importare la versione dell'agente.	Sì
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Sì

CreateAgentVersionRequest

Name	Type	Description	Obbligatorio	Predefinito
Definizione	AgentDefinition		Sì
└* tipo	AgentKind		Sì
└rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No

CreaRichiestaValutazione

Name	Type	Description	Obbligatorio	Predefinito
configurazione_sorgente_dati	OpenAI.CreateEvalCustomDataSourceConfig o OpenAI.CreateEvalLogsDataSourceConfig o OpenAI.CreateEvalStoredCompletionsDataSourceConfig o AzureAIDataSourceConfig	Configurazione per l'origine dati utilizzata per le esecuzioni di valutazione. Determina lo schema dei dati usati nella valutazione.	Sì
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome della valutazione.	No
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
criteri_di_test	matrice di OpenAI.EvalGraderLabelModel o OpenAI.EvalGraderStringCheck o OpenAI.EvalGraderTextSimilarity o OpenAI.EvalGraderPython o OpenAI.EvalGraderScoreModel o EvalGraderAzureAIEvaluator	Elenco di classificatori per tutte le esecuzioni di valutazione in questo gruppo. I classificatori possono fare riferimento a variabili nell'origine dati usando la notazione con parentesi graffe doppie, ad esempio {{item.variable_name}}. Per fare riferimento all'output del modello, usare lo sample spazio dei nomi (ad esempio, {{sample.output_text}}).	Sì

CreateEvalRunRequest

Name	Type	Description	Obbligatorio	Predefinito
fonte_dati	OpenAI.CreateEvalJsonlRunDataSource o OpenAI.CreateEvalCompletionsRunDataSource o OpenAI.CreateEvalResponsesRunDataSource o EvalRunDataSource	Dettagli sull'origine dati dell'esecuzione.	Sì
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string	Nome della corsa.	No
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

CredentialType

Tipo di credenziale utilizzato dalla connessione

Proprietà	Value
Descrizione	Tipo di credenziale utilizzato dalla connessione
Type	string
Valori	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Grilletto basato su Cron.

Name	Type	Description	Obbligatorio	Predefinito
endTime	string	Ora di fine per la pianificazione cron in formato ISO 8601.	No
expression	string	Espressione Cron che definisce la frequenza di pianificazione.	Sì
startTime	string	Ora di inizio per il programma cron in formato ISO 8601.	No
timeZone	string	Fuso orario per la pianificazione cron.	No	UTC
type	enum	Valori possibili: Cron	Sì

Customcredential

Definizione delle credenziali personalizzate

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di credenziale Valori possibili: CustomKeys	Sì

Questo oggetto accetta anche proprietà aggiuntive di tipo: string

DailyRecurrenceSchedule

Pianificazione giornaliera delle ricorrenze.

Name	Type	Description	Obbligatorio	Predefinito
hours	matrice di numeri interi	Ore per la pianificazione della ricorrenza.	Sì
type	enum	Tipo di ricorrenza giornaliera. Valori possibili: Daily	Sì

DataSourceConfig

Classe di base per l'esecuzione di origini dati con supporto discriminatorio.

Discriminare per DataSourceConfig

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

Valore del tipo	Schema

Name	Type	Description	Obbligatorio	Predefinito
schema	object	Schema JSON dell'oggetto complessivo per gli elementi dell'origine dati di esecuzione.	Sì
type	string	Discriminare del tipo di origine dati.	Sì

DatasetType

Enumerazione per determinare il tipo di dati.

Proprietà	Value
Descrizione	Enumerazione per determinare il tipo di dati.
Type	string
Valori	uri_file uri_folder

DatasetVersion

Definizione di DatasetVersion

Discriminare per DatasetVersion

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

Valore del tipo	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Type	Description	Obbligatorio	Predefinito
Connectionname	string	Nome connessione account Archiviazione di Azure. Obbligatorio se startPendingUploadVersion non è stato chiamato prima di creare il set di dati	No
dataUri	string	URI dei dati (esempio) Vincoli: minLength: 1, modello: [a-zA-Z0-9_]	Sì
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
Isreference	booleano (sola lettura)	Indica se il set di dati contiene un riferimento all'archiviazione o se il set di dati gestisce l'archiviazione stessa. Se true, i dati sottostanti non verranno eliminati quando viene eliminata la versione del set di dati	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	DatasetType	Enumerazione per determinare il tipo di dati.	Sì
version	string (sola lettura)	La versione della risorsa	Sì

DatasetVersionUpdate

Definizione di DatasetVersion

Discriminare per DatasetVersionUpdate

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

Valore del tipo	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	DatasetType	Enumerazione per determinare il tipo di dati.	Sì

Dayofweek

Giorni della settimana per la pianificazione della ricorrenza.

Proprietà	Value
Descrizione	Giorni della settimana per la pianificazione della ricorrenza.
Type	string
Valori	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Un oggetto agente eliminato

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean	Indica se l'agente è stato eliminato correttamente.	Sì
nome	string	Nome dell'agente.	Sì
object	enum	Tipo dell'oggetto. Sempre 'agent.deleted'. Valori possibili: agent.deleted	Sì

DeleteAgentVersionResponse

Un oggetto versione dell'agente eliminato

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean	Indica se l'agente è stato eliminato correttamente.	Sì
nome	string	Nome dell'agente.	Sì
object	enum	Tipo dell'oggetto. Sempre 'agent.version.deleted'. Valori possibili: agent.version.deleted	Sì
version	string	Identificatore della versione dell'agente.	Sì

DeleteEvalResponse

Oggetto di valutazione eliminato

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean	Indica se l'eval è stato eliminato correttamente.	Sì
eval_id	string	id dell'eval.	Sì
object	enum	Tipo dell'oggetto. Sempre 'eval.deleted'. Valori possibili: eval.deleted	Sì

DeleteEvalRunResponse

Oggetto di esecuzione della valutazione eliminato.

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean	Indica se l'eval è stato eliminato correttamente.	No
object	enum	Tipo dell'oggetto. Sempre 'eval.deleted'. Valori possibili: eval.deleted	No
run_id	string	id dell'eval.	No

DeleteMemoryStoreResponse

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean	Indica se l'archivio memoria è stato eliminato correttamente.	Sì
nome	string	Nome dell'archivio di memoria.	Sì
object	enum	Tipo dell'oggetto. Sempre 'memory_store.deleted'. Valori possibili: memory_store.deleted	Sì

DeleteResponseResult

Risultato di un'operazione di eliminazione della risposta.

Name	Type	Description	Obbligatorio	Predefinito
cancellato	enum	Restituisce sempre true Valori possibili: True	Sì
id	string	ID operazione.	Sì
object	enum	Restituisce sempre 'response'. Valori possibili: response	Sì

Deployment

Definizione della distribuzione del modello

Discriminare per la distribuzione

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

Valore del tipo	Schema
ModelDeployment	ModelDeployment

Name	Type	Description	Obbligatorio	Predefinito
nome	string (sola lettura)	Nome della distribuzione	Sì
type	Deploymenttype		Sì

Deploymenttype

Proprietà	Value
Type	string
Valori	ModelDeployment

EntraIDCredentials

Entra ID definizione di credenziali

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di credenziale Valori possibili: AAD	Sì

Eval

Un oggetto Eval con una configurazione dell'origine dati e criteri di test. Un Eval rappresenta un'attività da eseguire per l'integrazione LLM. Come:

• Migliorare la qualità del chatbot
• Scopri in che modo il mio chatbot gestisce il supporto clienti
• Controllare se o4-mini è meglio nel mio caso d'uso rispetto a gpt-4o

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Il timestamp Unix (in secondi) relativo alla creazione dell'eval.	Sì
creato_da	string	nome della persona che ha creato l'esecuzione.	No
configurazione_sorgente_dati	OpenAI.CreateEvalCustomDataSourceConfig o OpenAI.CreateEvalLogsDataSourceConfig o OpenAI.CreateEvalStoredCompletionsDataSourceConfig o AzureAIDataSourceConfig	Configurazione delle origini dati usate nelle esecuzioni della valutazione.	Sì
id	string	Identificatore univoco per la valutazione.	Sì
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	Sì
modified_at	integer		No
nome	string	Nome della valutazione.	Sì
object	enum	Tipo dell'oggetto. Valori possibili: eval	Sì
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
criteri_di_test	matrice di OpenAI.EvalGraderLabelModel o OpenAI.EvalGraderStringCheck o OpenAI.EvalGraderTextSimilarity o OpenAI.EvalGraderPython o OpenAI.EvalGraderScoreModel o EvalGraderAzureAIEvaluator	Elenco dei criteri di test.	Sì

EvalCsvFileIdSource

Rappresenta un riferimento a un file CSV caricato utilizzato come origine per i dati di valutazione.

Name	Type	Description	Obbligatorio	Predefinito
id	string	Identificatore del file CSV caricato.	Sì
type	enum	Tipo di origine, sempre file_id. Valori possibili: file_id	Sì

EvalCsvRunDataSource

Rappresenta un'origine dati CSV per le esecuzioni di valutazione.

Name	Type	Description	Obbligatorio	Predefinito
source	EvalCsvFileIdSource	Rappresenta un riferimento a un file CSV caricato utilizzato come origine per i dati di valutazione.	Sì
└* id	string	Identificatore del file CSV caricato.	Sì
└─ Tipo	enum	Tipo di origine, sempre file_id. Valori possibili: file_id	Sì
type	enum	Tipo di origine dati, sempre csv. Valori possibili: csv	Sì

EvalGraderAzureAIEvaluator

Name	Type	Description	Obbligatorio	Predefinito
mappatura dei dati	object	Modello da utilizzare per la valutazione. Deve supportare output strutturati.	No
evaluator_name	string	Nome dell'analizzatore.	Sì
evaluator_version	string	Versione dell'analizzatore. Versione più recente se non specificata.	No
initialization_parameters	object	Parametri di inizializzazione per la valutazione. Deve supportare output strutturati.	No
nome	string	Nome del grader.	Sì
type	enum	Tipo di oggetto, che è sempre azure_ai_evaluator. Valori possibili: azure_ai_evaluator	Sì

EvalResult

Risultato della valutazione.

Name	Type	Description	Obbligatorio	Predefinito
nome	string	nome del controllo	Sì
Passato	boolean	indica se il controllo è stato superato o non è riuscito	Sì
Punteggio	Numero	Punteggio	Sì
type	string	tipo di controllo	Sì

EvalRun

Schema che rappresenta un ciclo di valutazione.

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Timestamp Unix (in secondi) quando è stata creata l'esecuzione della valutazione.	Sì
creato_da	string	nome della persona che ha creato l'esecuzione.	No
fonte_dati	OpenAI.CreateEvalJsonlRunDataSource o OpenAI.CreateEvalCompletionsRunDataSource o OpenAI.CreateEvalResponsesRunDataSource o EvalRunDataSource	Informazioni sull'origine dati dell'esecuzione.	Sì
error	OpenAI.EvalApiError	Oggetto che rappresenta una risposta di errore dall'API Eval.	Sì
eval_id	string	Identificatore della valutazione associata.	Sì
id	string	Identificatore univoco per l'esecuzione della valutazione.	Sì
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	Sì
model	string	Modello valutato, se applicabile.	Sì
modified_at	integer		No
nome	string	Nome della sessione di valutazione.	Sì
object	enum	Tipo dell'oggetto . Sempre "eval.run". Valori possibili: eval.run	Sì
utilizzo_per_modello	matrice di OpenAI.EvalRunPerModelUsage	Statistiche di utilizzo per ogni modello durante l'esecuzione della valutazione.	Sì
risultati_per_criteri_di_test	matrice di OpenAI.EvalRunPerTestingCriteriaResults	Risultati in base ai criteri di test applicati durante l'esecuzione della valutazione.	Sì
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
report_url	string	URL del report renderizzato dell'esecuzione della valutazione nella dashboard dell'interfaccia utente.	Sì
conteggio_risultati	OpenAI.EvalRunResultCounts		Sì
└* non riuscito	OpenAI.integer		Sì
└* non riuscito	OpenAI.integer		Sì
└> superato	OpenAI.integer		Sì
└─ totale	OpenAI.integer		Sì
Stato	string	Stato dell'esecuzione della valutazione.	Sì

EvalRunDataSource

Classe di base per l'esecuzione di origini dati con supporto discriminatorio.

Discriminare per EvalRunDataSource

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

Valore del tipo	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	TargetCompletionEvalRunDataSource
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

Name	Type	Description	Obbligatorio	Predefinito
type	string	Discriminare del tipo di origine dati.	Sì

EvalRunOutputItem

Un elemento di output di un'esecuzione di valutazione rappresentato da uno schema.

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Timestamp Unix (in secondi) quando è stata creata l'esecuzione della valutazione.	Sì
elemento_fonte_dati	object	Dettagli dell'elemento di origine dei dati di input.	Sì
datasource_item_id (identificativo_elemento_fonte_dati)	OpenAI.integer		Sì
eval_id	string	Identificatore del gruppo di valutazione.	Sì
id	string	Identificatore univoco per l'elemento di output del ciclo di valutazione.	Sì
object	enum	Tipo dell'oggetto . Sempre "eval.run.output_item". Valori possibili: eval.run.output_item	Sì
results	matrice di EvalRunOutputItemResult	Elenco dei risultati del grader per questo elemento di output.	Sì
run_id	string	Identificatore dell'esecuzione di valutazione associata a questo elemento dell'output.	Sì
campione	OpenAI.EvalRunOutputItemSample		Sì
└─ Errore	OpenAI.EvalApiError	Oggetto che rappresenta una risposta di errore dall'API Eval.	Sì
└─ motivo_fine	string		Sì
└ Input	matrice di EvalRunOutputItemSampleInput		Sì
└ max_completion_tokens	OpenAI.integer		Sì
└─ Modello	string		Sì
└─ uscita	matrice di EvalRunOutputItemSampleOutputOutput		Sì
└* seed	OpenAI.integer		Sì
└* temperatura	OpenAI.numeric		Sì
└top_p	OpenAI.numeric		Sì
└─ utilizzo	OpenAI.EvalRunOutputItemSampleUsage		Sì
Stato	string	Stato dell'esecuzione della valutazione.	Sì

EvalRunOutputItemResult

Risultato di un singolo gradore per un elemento di output dell'esecuzione della valutazione.

Name	Type	Description	Obbligatorio	Predefinito
label	string	Etichetta associata alla metrica dei criteri di test (ad esempio, "pass", "fail", "good", "bad").	No
metric	string	Nome della metrica ,ad esempio "fluenza", "f1_score").	No
nome	string	Nome del grader.	Sì
Passato	boolean	Indica se il grader ha considerato l'output un passaggio.	Sì
properties	object	Dettagli aggiuntivi sulla metrica dei criteri di test.	No
reason	string	Motivo della metrica dei criteri di test.	No
campione	oggetto (nullable)	Dati facoltativi di esempio o intermedi prodotti dal grader.	No
Punteggio	OpenAI.numeric		Sì
threshold	Numero	Soglia utilizzata per determinare il superamento/esito negativo di questo criterio di test, se è numerico.	No
type	string	Tipo di grader (ad esempio, "string-check-grader").	No

Questo oggetto accetta anche proprietà aggiuntive.

EvalRunOutputItemSampleInput

Messaggio nell'esecuzione della valutazione.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	string		Sì
Ruolo	string		Sì
tool_calls	matrice di CompletionMessageToolCallChunk	Chiamate agli strumenti effettuate all'interno del messaggio, se presenti.	Sì

EvalRunOutputItemSampleOutputOutput

Messaggio nell'esecuzione della valutazione.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	string		No
Ruolo	string		No
tool_calls	matrice di CompletionMessageToolCallChunk	Chiamate agli strumenti effettuate all'interno del messaggio, se presenti.	Sì

EvalRunResultCompareItem

Confronto metrico per un trattamento rispetto al basale.

Name	Type	Description	Obbligatorio	Predefinito
deltaEstimate	Numero	Differenza stimata tra il trattamento e la baseline.	Sì
pValue	Numero	Valore P per l'effetto di trattamento.	Sì
trattamentoEffect	TreatmentEffectType	Tipo di effetto del trattamento.	Sì
treatmentRunId	string	ID di esecuzione del trattamento.	Sì
treatmentRunSummary	EvalRunResultSummary	Statistiche di riepilogo di una metrica in un'esecuzione di valutazione.	Sì
└* media	Numero	Valore medio della metrica nell'esecuzione della valutazione.	Sì
└* runId	string	ID esecuzione della valutazione.	Sì
└> sampleCount	integer	Numero di campioni nell'esecuzione della valutazione.	Sì
└++ standardDeviation	Numero	Deviazione standard della metrica nell'esecuzione della valutazione.	Sì

EvalRunResultComparison

I risultati del confronto per il trattamento vengono eseguiti rispetto al basale.

Name	Type	Description	Obbligatorio	Predefinito
baselineRunSummary	EvalRunResultSummary	Statistiche di riepilogo di una metrica in un'esecuzione di valutazione.	Sì
└* media	Numero	Valore medio della metrica nell'esecuzione della valutazione.	Sì
└* runId	string	ID esecuzione della valutazione.	Sì
└> sampleCount	integer	Numero di campioni nell'esecuzione della valutazione.	Sì
└++ standardDeviation	Numero	Deviazione standard della metrica nell'esecuzione della valutazione.	Sì
compareItems	matrice di EvalRunResultCompareItem	Elenco dei risultati di confronto per ogni esecuzione del trattamento.	Sì
Analizzatore	string	Nome dell'analizzatore per questi criteri di test.	Sì
metric	string	Metrica valutata.	Sì
testingCriteria	string	Nome dei criteri di test.	Sì

EvalRunResultSummary

Statistiche di riepilogo di una metrica in un'esecuzione di valutazione.

Name	Type	Description	Obbligatorio	Predefinito
average	Numero	Valore medio della metrica nell'esecuzione della valutazione.	Sì
runId	string	ID esecuzione della valutazione.	Sì
sampleCount	integer	Numero di campioni nell'esecuzione della valutazione.	Sì
standardDeviation	Numero	Deviazione standard della metrica nell'esecuzione della valutazione.	Sì

EvaluationComparisonInsightRequest

Richiesta di confronto della valutazione

Name	Type	Description	Obbligatorio	Predefinito
baselineRunId	string	ID esecuzione previsto per il confronto.	Sì
evalId	string	Identificatore per la valutazione.	Sì
treatmentRunIds	matrice di valori string	Elenco degli ID di esecuzione del trattamento per il confronto.	Sì
type	enum	Tipo di richiesta. Valori possibili: EvaluationComparison	Sì

EvaluationComparisonInsightResult

Approfondimenti dal confronto delle valutazioni.

Name	Type	Description	Obbligatorio	Predefinito
Confronti	matrice di EvalRunResultComparison	Risultati di confronto per ogni trattamento eseguito rispetto alla linea di base.	Sì
method	string	Metodo statistico utilizzato per il confronto.	Sì
type	enum	Tipo di risultato di informazioni dettagliate. Valori possibili: EvaluationComparison	Sì

EvaluationResultSample

Un campione del risultato della valutazione.

Name	Type	Description	Obbligatorio	Predefinito
correlationInfo	object	Informazioni sulla correlazione per l'esempio di analisi.	Sì
evaluationResult	EvalResult	Risultato della valutazione.	Sì
└> nome	string	nome del controllo	Sì
└> superato	boolean	indica se il controllo è stato superato o non è riuscito	Sì
└* punteggio	Numero	Punteggio	Sì
└─ Tipo	string	tipo di controllo	Sì
features	object	Funzionalità che consentono di filtrare ulteriormente i dati nell'esperienza utente.	Sì
id	string	Identificatore univoco per l'esempio di analisi.	Sì
type	enum	Tipo di esempio di risultato della valutazione Valori possibili: EvaluationResultSample	Sì

Regola di valutazione

Modello di regole di valutazione.

Name	Type	Description	Obbligatorio	Predefinito
action	EvaluationRuleAction	Modello di azione di valutazione.	Sì
└─ Tipo	EvaluationRuleActionType	Tipo di azione di valutazione.	Sì
descrizione	string	Descrizione per la regola di valutazione.	No
displayName	string	Nome visualizzato per la regola di valutazione.	No
enabled	boolean	Indica se la regola di valutazione è abilitata. Il valore predefinito è vero.	Sì
eventType	EvaluationRuleEventType	Tipo di evento della regola di valutazione.	Sì
filter	EvaluationRuleFilter	Modello di filtro di valutazione.	No
└* agentName	string	Filtrare in base al nome dell'agente.	Sì
id	string (sola lettura)	Identificatore univoco per la regola di valutazione.	Sì
dati di sistema	oggetto (sola lettura)	Metadati di sistema per la regola di valutazione.	Sì

EvaluationRuleAction

Modello di azione di valutazione.

Discriminare per EvaluationRuleAction

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

Valore del tipo	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Name	Type	Description	Obbligatorio	Predefinito
type	EvaluationRuleActionType	Tipo di azione di valutazione.	Sì

EvaluationRuleActionType

Tipo di azione di valutazione.

Proprietà	Value
Descrizione	Tipo di azione di valutazione.
Type	string
Valori	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Tipo di evento della regola di valutazione.

Proprietà	Value
Descrizione	Tipo di evento della regola di valutazione.
Type	string
Valori	responseCompleted manual

EvaluationRuleFilter

Modello di filtro di valutazione.

Name	Type	Description	Obbligatorio	Predefinito
nomeagente	string	Filtrare in base al nome dell'agente.	Sì

EvaluationRunClusterInsightRequest

Approfondimenti sull'insieme dei risultati della valutazione

Name	Type	Description	Obbligatorio	Predefinito
evalId	string	ID di valutazione per le informazioni dettagliate.	Sì
modelConfiguration	InsightModelConfiguration	Configurazione del modello utilizzato nella generazione dell'insight.	No
└* modelDeploymentName	string	Distribuzione del modello da valutare. Accetta solo il nome della distribuzione o con il nome della connessione come {connectionName}/<modelDeploymentName>.	Sì
runIds	matrice di valori string	Elenco degli ID di esecuzione della valutazione per le informazioni dettagliate.	Sì
type	enum	Tipo di richiesta di informazioni dettagliate. Valori possibili: EvaluationRunClusterInsight	Sì

EvaluationRunClusterInsightResult

Le informazioni dettagliate della valutazione eseguono l'analisi dei cluster.

Name	Type	Description	Obbligatorio	Predefinito
clusterInsight	ClusterInsightResult	Approfondimenti dall'analisi dei cluster.	Sì
type	enum	Tipo di risultato di informazioni dettagliate. Valori possibili: EvaluationRunClusterInsight	Sì

EvaluationScheduleTask

Attività di valutazione per la pianificazione.

Name	Type	Description	Obbligatorio	Predefinito
configuration	object	Configurazione per l'attività.	No
evalId	string	Identificatore del gruppo di valutazione.	Sì
evalRun	object	Payload dell'esecuzione della valutazione.	Sì
type	enum	Valori possibili: Evaluation	Sì

EvaluationTaxonomy

Definizione della tassonomia di valutazione

Name	Type	Description	Obbligatorio	Predefinito
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
nome	string (sola lettura)	nome della risorsa.	Sì
properties	object	Proprietà aggiuntive per la tassonomia di valutazione.	No
tassonomiaCategorie	matrice di TassonomiaCategory	Elenco delle categorie di tassonomia.	No
tassonomiaInput	EvaluationTaxonomyInput	Configurazione di input per la tassonomia di valutazione.	Sì
└─ Tipo	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì
version	string (sola lettura)	La versione della risorsa	Sì

EvaluationTaxonomyCreateOrUpdate

Definizione della tassonomia di valutazione

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
properties	object	Proprietà aggiuntive per la tassonomia di valutazione.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
tassonomiaCategorie	matrice di TassonomiaCategory	Elenco delle categorie di tassonomia.	No
tassonomiaInput	EvaluationTaxonomyInput	Configurazione di input per la tassonomia di valutazione.	Sì
└─ Tipo	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì

EvaluationTaxonomyInput

Configurazione di input per la tassonomia di valutazione.

Discriminante per EvaluationTaxonomyInput

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

Valore del tipo	Schema
agent	AgentTaxonomyInput

Name	Type	Description	Obbligatorio	Predefinito
type	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì

EvaluationTaxonomyInputType

Tipo di input della tassonomia di valutazione.

Proprietà	Value
Descrizione	Tipo di input della tassonomia di valutazione.
Type	string
Valori	agent policy

EvaluationTaxonomyInputUpdate

Configurazione di input per la tassonomia di valutazione.

Discriminante per EvaluationTaxonomyInputUpdate

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

Valore del tipo	Schema
agent	AgentTaxonomyInputUpdate

Name	Type	Description	Obbligatorio	Predefinito
type	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì

EvaluationTaxonomyUpdate

Definizione della tassonomia di valutazione

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
properties	object	Proprietà aggiuntive per la tassonomia di valutazione.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
tassonomiaCategorie	matrice di TassonomiaCategory	Elenco delle categorie di tassonomia.	No
tassonomiaInput	EvaluationTaxonomyInputUpdate	Configurazione di input per la tassonomia di valutazione.	No
└─ Tipo	EvaluationTaxonomyInputType	Tipo di input della tassonomia di valutazione.	Sì

AnalizzatoreCategory

La categoria del valutatore

Proprietà	Value
Descrizione	La categoria del valutatore
Type	string
Valori	quality safety agents

AnalizzatoreDefinition

Configurazione dell'analizzatore di base con discriminatore

Discriminante per l'analizzatoreDefinition

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

Valore del tipo	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Type	Description	Obbligatorio	Predefinito
data_schema	object	Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
init_parameters	object	Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
metrics	object	Elenco delle metriche di output prodotte da questo valutatore	No
type	AnalizzatoreDefinitionType	Il tipo di definizione del valutatore	Sì

AnalizzatoreDefinitionType

Il tipo di definizione del valutatore

Proprietà	Value
Descrizione	Il tipo di definizione del valutatore
Type	string
Valori	prompt code prompt_and_code service openai_graders

AnalizzatoreMetrico

Metrica del valutatore

Name	Type	Description	Obbligatorio	Predefinito
desirable_direction	AnalizzatoreMetricDirection	La direzione della metrica che indica se un valore più alto è migliore, un valore più basso è migliore o neutro	No
is_primary	boolean	Indica se questa metrica è primaria quando sono presenti più metriche.	No
max_value	Numero	Valore massimo per la metrica. Se non specificato, si presuppone che non sia associato.	No
min_value	Numero	Valore minimo per la metrica	No
type	AnalizzatoreMetricType	Il tipo di valutatore	No

AnalizzatoreMetricDirection

La direzione della metrica che indica se un valore più alto è migliore, un valore più basso è migliore o neutro

Proprietà	Value
Descrizione	La direzione della metrica che indica se un valore più alto è migliore, un valore più basso è migliore o neutro
Type	string
Valori	increase decrease neutral

AnalizzatoreMetricType

Il tipo di valutatore

Proprietà	Value
Descrizione	Il tipo di valutatore
Type	string
Valori	ordinal continuous boolean

AnalizzatoreType

Il tipo di valutatore

Proprietà	Value
Descrizione	Il tipo di valutatore
Type	string
Valori	builtin custom

AnalizzatoreVersion

Definizione del valutatore

Name	Type	Description	Obbligatorio	Predefinito
categories	matrice di analizzatoriCategory	Le categorie del valutatore	Sì
creato_il	string (sola lettura)	Data/ora di creazione del valutatore	Sì
creato_da	string (sola lettura)	Creatore del valutatore	Sì
Definizione	AnalizzatoreDefinition	Configurazione dell'analizzatore di base con discriminatore	Sì
└data_schema	object	Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
└init_parameters	object	Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
└* Metriche	object	Elenco delle metriche di output prodotte da questo valutatore	No
└─ Tipo	AnalizzatoreDefinitionType	Il tipo di definizione del valutatore	Sì
display_name	string	Nome visualizzato per l'analizzatore. Aiuta facilmente a trovare il valutatore in AI Foundry. Non è necessario che sia univoco.	No
evaluator_type	AnalizzatoreType	Il tipo di valutatore	Sì
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
metadata	object	Metadati relativi all'analizzatore	No
modified_at	string (sola lettura)	Data/ora dell'ultima modifica del valutatore	Sì
nome	string (sola lettura)	nome della risorsa.	Sì
version	string (sola lettura)	La versione della risorsa	Sì

EvaluatorVersionCreate

Definizione del valutatore

Name	Type	Description	Obbligatorio	Predefinito
categories	matrice di analizzatoriCategory	Le categorie del valutatore	Sì
Definizione	AnalizzatoreDefinition	Configurazione dell'analizzatore di base con discriminatore	Sì
└data_schema	object	Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
└init_parameters	object	Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
└* Metriche	object	Elenco delle metriche di output prodotte da questo valutatore	No
└─ Tipo	AnalizzatoreDefinitionType	Il tipo di definizione del valutatore	Sì
descrizione	string	Testo della descrizione dell'asset.	No
display_name	string	Nome visualizzato per l'analizzatore. Aiuta facilmente a trovare il valutatore in AI Foundry. Non è necessario che sia univoco.	No
evaluator_type	AnalizzatoreType	Il tipo di valutatore	Sì
metadata	object	Metadati relativi all'analizzatore	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No

EvaluatorVersionUpdate

Definizione del valutatore

Name	Type	Description	Obbligatorio	Predefinito
categories	matrice di analizzatoriCategory	Le categorie del valutatore	No
descrizione	string	Testo della descrizione dell'asset.	No
display_name	string	Nome visualizzato per l'analizzatore. Aiuta facilmente a trovare il valutatore in AI Foundry. Non è necessario che sia univoco.	No
metadata	object	Metadati relativi all'analizzatore	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No

FabricDataAgentToolParameters

Parametri dello strumento agente dati fabric.

Name	Type	Description	Obbligatorio	Predefinito
project_connections	matrice di ToolProjectConnection	Le connessioni project collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento.	No

FileDatasetVersion

Definizione di FileDatasetVersion

Name	Type	Description	Obbligatorio	Predefinito
Connectionname	string	Nome connessione account Archiviazione di Azure. Obbligatorio se startPendingUploadVersion non è stato chiamato prima di creare il set di dati	No
dataUri	string	URI dei dati (esempio) Vincoli: minLength: 1, modello: [a-zA-Z0-9_]	Sì
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
Isreference	booleano (sola lettura)	Indica se il set di dati contiene un riferimento all'archiviazione o se il set di dati gestisce l'archiviazione stessa. Se true, i dati sottostanti non verranno eliminati quando viene eliminata la versione del set di dati	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	enum	Tipo di set di dati Valori possibili: uri_file	Sì
version	string (sola lettura)	La versione della risorsa	Sì

FileDatasetVersionUpdate

Definizione di FileDatasetVersion

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	enum	Tipo di set di dati Valori possibili: uri_file	Sì

FolderDatasetVersion

Definizione di FileDatasetVersion

Name	Type	Description	Obbligatorio	Predefinito
Connectionname	string	Nome connessione account Archiviazione di Azure. Obbligatorio se startPendingUploadVersion non è stato chiamato prima di creare il set di dati	No
dataUri	string	URI dei dati (esempio) Vincoli: minLength: 1, modello: [a-zA-Z0-9_]	Sì
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
Isreference	booleano (sola lettura)	Indica se il set di dati contiene un riferimento all'archiviazione o se il set di dati gestisce l'archiviazione stessa. Se true, i dati sottostanti non verranno eliminati quando viene eliminata la versione del set di dati	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	enum	Tipo di set di dati Valori possibili: uri_folder	Sì
version	string (sola lettura)	La versione della risorsa	Sì

FolderDatasetVersionUpdate

Definizione di FileDatasetVersion

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	enum	Tipo di set di dati Valori possibili: uri_folder	Sì

FunctionToolCall

Dettagli di una chiamata dello strumento di funzione.

Name	Type	Description	Obbligatorio	Predefinito
arguments	string	Argomenti con cui chiamare la funzione, come generato dal modello in formato JSON.	Sì
nome	string	Il nome della funzione da chiamare.	Sì

HostedAgentDefinition

Definizione dell'agente ospitato.

Name	Type	Description	Obbligatorio	Predefinito
container_protocol_versions	matrice di ProtocolVersionRecord	Protocolli supportati dall'agente per la comunicazione in ingresso dei contenitori.	Sì
cpu	string	Configurazione della CPU per l'agente ospitato.	Sì
environment_variables	object	Variabili di ambiente da impostare nel contenitore dell'agente ospitato.	No
image	string	ID immagine per l'agente, applicabile agli agenti ospitati basati su immagini.	No
kind	enum	Valori possibili: hosted	Sì
memory	string	Configurazione della memoria per l'agente ospitato.	Sì
rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
└rai_policy_name	string	Nome del criterio RAI da applicare.	Sì
Strumenti	matrice di OpenAI.Tool	Una serie di strumenti che il modello dell'agente ospitato può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .	No

HourlyRecurrenceSchedule

Pianificazione di ricorrenza oraria.

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

HumanEvaluationPreviewRuleAction

Azione della regola di valutazione per la valutazione umana.

Name	Type	Description	Obbligatorio	Predefinito
templateId	AssetId	Identificatore di un asset salvato.	Sì
type	enum	Valori possibili: humanEvaluationPreview	Sì

Indice

Definizione della risorsa indice

Discriminare per l'indice

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

Valore del tipo	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Type	Description	Obbligatorio	Predefinito
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	IndexType		Sì
version	string (sola lettura)	La versione della risorsa	Sì

IndexType

Proprietà	Value
Type	string
Valori	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Definizione della risorsa indice

Discriminare per IndexUpdate

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

Valore del tipo	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	IndexType		Sì

Intuzione

Corpo della risposta per le informazioni dettagliate del cluster.

Name	Type	Description	Obbligatorio	Predefinito
displayName	string	Nome visualizzato descrittivo per le informazioni dettagliate.	Sì
id	string (sola lettura)	Identificatore univoco per il report di informazioni dettagliate.	Sì
metadata	InsightsMetadata (sola lettura)	Metadati relativi alle informazioni dettagliate.	Sì
└* completedAt	string	Timestamp al termine delle informazioni dettagliate.	No
└> createdAt	string	Timestamp al momento della creazione delle informazioni dettagliate.	Sì
request	InsightRequest	La richiesta del report di approfondimento.	Sì
└─ Tipo	InsightType	Tipo di richiesta.	Sì
result	InsightResult (sola lettura)	Il risultato degli approfondimenti.	No
└─ Tipo	InsightType	Tipo di risultato di informazioni dettagliate.	Sì
state	Azure. Core.Foundations.OperationState (sola lettura)	Enumerazione che descrive gli stati di funzionamento consentiti.	Sì

InsightCluster

Un cluster di campioni di analisi.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione del cluster di analisi.	Sì
id	string	ID del cluster di analisi.	Sì
label	string	Etichetta per il cluster	Sì
Campioni	matrice di InsightSample	Elenco di esempi che appartengono a questo cluster. Vuoto se gli esempi fanno parte di sottocluster.	No
subCluster	matrice di InsightCluster	Elenco di sottocluster all'interno del cluster. Vuoto se non esiste alcun sottocluster.	No
Suggerimento	string	Suggerimento per il cluster	Sì
suggestionTitle	string	Titolo del suggerimento per il cluster	Sì
weight	integer	Peso del cluster di analisi. Indica il numero di campioni nel cluster.	Sì

InsightModelConfiguration

Configurazione del modello utilizzato nella generazione dell'insight.

Name	Type	Description	Obbligatorio	Predefinito
modelDeploymentName	string	Distribuzione del modello da valutare. Accetta solo il nome della distribuzione o con il nome della connessione come {connectionName}/<modelDeploymentName>.	Sì

InsightRequest

La richiesta del report di approfondimento.

Discriminare per InsightRequest

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

Valore del tipo	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Name	Type	Description	Obbligatorio	Predefinito
type	InsightType	La richiesta degli approfondimenti.	Sì

InsightResult

Il risultato degli approfondimenti.

Discriminare per InsightResult

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

Valore del tipo	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Type	Description	Obbligatorio	Predefinito
type	InsightType	La richiesta degli approfondimenti.	Sì

InsightSample

Un campione dell'analisi.

Discriminare per InsightSample

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

Valore del tipo	Schema
EvaluationResultSample	EvaluationResultSample

Name	Type	Description	Obbligatorio	Predefinito
correlationInfo	object	Informazioni sulla correlazione per l'esempio di analisi.	Sì
features	object	Funzionalità che consentono di filtrare ulteriormente i dati nell'esperienza utente.	Sì
id	string	Identificatore univoco per l'esempio di analisi.	Sì
type	SampleType	Il tipo di campione utilizzato nell'analisi.	Sì

InsightScheduleTask

Attività di approfondimento per la pianificazione.

Name	Type	Description	Obbligatorio	Predefinito
configuration	object	Configurazione per l'attività.	No
intuzione	Informazioni dettagliate	Corpo della risposta per le informazioni dettagliate del cluster.	Sì
└\ displayName	string	Nome visualizzato descrittivo per le informazioni dettagliate.	Sì
└* id	string (sola lettura)	Identificatore univoco per il report di informazioni dettagliate.	Sì
└─ metadati	InsightsMetadata (sola lettura)	Metadati relativi al report informazioni dettagliate.	Sì
└* richiesta	InsightRequest	Richiedere l'analisi delle informazioni dettagliate.	Sì
└* risultato	InsightResult (sola lettura)	Risultato del report informazioni dettagliate.	No
└* stato	Azure. Core.Foundations.OperationState (sola lettura)	Stato corrente delle informazioni dettagliate.	Sì
type	enum	Valori possibili: Insight	Sì

InsightSummary

Riepilogo dell'analisi dei cluster di errori.

Name	Type	Description	Obbligatorio	Predefinito
method	string	Metodo usato per il clustering.	Sì
sampleCount	integer	Numero totale di campioni analizzati.	Sì
uniqueClusterCount	integer	Numero totale di cluster univoci.	Sì
uniqueSubclusterCount	integer	Numero totale di etichette di sottocluster univoche.	Sì
uso	ClusterTokenUsage	Utilizzo dei token per l'analisi dei cluster	Sì
└\ inputTokenUsage	integer	utilizzo dei token di input	Sì
└\ outputTokenUsage	integer	utilizzo del token di output	Sì
└> totalTokenUsage	integer	utilizzo totale dei token	Sì

InsightType

La richiesta degli approfondimenti.

Proprietà	Value
Descrizione	La richiesta degli approfondimenti.
Type	string
Valori	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadati relativi alle informazioni dettagliate.

Name	Type	Description	Obbligatorio	Predefinito
completedAt	string	Timestamp al termine delle informazioni dettagliate.	No
createdAt	string	Timestamp al momento della creazione delle informazioni dettagliate.	Sì

ItemGenerationParams

Rappresenta il set di parametri utilizzati per controllare le operazioni di generazione degli elementi.

Discriminare per ItemGenerationParams

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

Valore del tipo	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Name	Type	Description	Obbligatorio	Predefinito
type	ItemGenerationParamsType	Tipi di parametri per la generazione di elementi red team.	Sì

ItemGenerationParamsType

Tipi di parametri per la generazione di elementi red team.

Proprietà	Value
Descrizione	Tipi di parametri per la generazione di elementi red team.
Type	string
Valori	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Definizione di indice Azure AI Search gestita

Name	Type	Description	Obbligatorio	Predefinito
id	string (sola lettura)	Asset ID, un identificatore univoco per l'asset	No
nome	string (sola lettura)	nome della risorsa.	Sì
type	enum	Tipo di indice Valori possibili: ManagedAzureSearch	Sì
version	string (sola lettura)	La versione della risorsa	Sì

ManagedAzureAISearchIndexUpdate

Definizione di indice Azure AI Search gestita

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Testo della descrizione dell'asset.	No
tags	object	Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati.	No
type	enum	Tipo di indice Valori possibili: ManagedAzureSearch	Sì

MemoryItem

Un singolo elemento di memoria memorizzato nell'archivio di memoria, contenente contenuto e metadati.

Discriminare per MemoryItem

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

Valore del tipo	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Type	Description	Obbligatorio	Predefinito
contenuto	string	Il contenuto della memoria.	Sì
kind	MemoryItemKind	Tipo di elemento di memoria.	Sì
memory_id	string	L'ID univoco dell'elemento di memoria.	Sì
scope	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì
updated_at	integer	L'ora dell'ultimo aggiornamento dell'elemento in memoria.	Sì

MemoryItemKind

Tipo di elemento di memoria.

Proprietà	Value
Descrizione	Tipo di elemento di memoria.
Type	string
Valori	user_profile chat_summary

MemoryOperation

Rappresenta una singola operazione di memoria (creazione, aggiornamento o eliminazione) eseguita su un elemento di memoria.

Name	Type	Description	Obbligatorio	Predefinito
kind	MemoryOperationKind	Tipo di operazione di memoria.	Sì
memory_item	MemoryItem	Un singolo elemento di memoria memorizzato nell'archivio di memoria, contenente contenuto e metadati.	Sì
└> contenuto	string	Il contenuto della memoria.	Sì
└* tipo	MemoryItemKind	Tipo di elemento di memoria.	Sì
└memory_id	string	L'ID univoco dell'elemento di memoria.	Sì
Ambito └*	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì
└updated_at	integer	L'ora dell'ultimo aggiornamento dell'elemento in memoria.	Sì

MemoryOperationKind

Tipo di operazione di memoria.

Proprietà	Value
Descrizione	Tipo di operazione di memoria.
Type	string
Valori	create update delete

MemorySearchItem

Elemento di memoria recuperato dalla ricerca in memoria.

Name	Type	Description	Obbligatorio	Predefinito
memory_item	MemoryItem	Un singolo elemento di memoria memorizzato nell'archivio di memoria, contenente contenuto e metadati.	Sì
└> contenuto	string	Il contenuto della memoria.	Sì
└* tipo	MemoryItemKind	Tipo di elemento di memoria.	Sì
└memory_id	string	L'ID univoco dell'elemento di memoria.	Sì
Ambito └*	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì
└updated_at	integer	L'ora dell'ultimo aggiornamento dell'elemento in memoria.	Sì

MemorySearchOptions

Opzioni di ricerca in memoria.

Name	Type	Description	Obbligatorio	Predefinito
max_memories	integer	Numero massimo di elementi di memoria da restituire.	No

MemorySearchPreviewTool

Uno strumento per integrare i ricordi nell'agente.

Name	Type	Description	Obbligatorio	Predefinito
memory_store_name	string	Nome dell'archivio di memoria da utilizzare.	Sì
scope	string	Lo spazio dei nomi utilizzato per raggruppare e isolare i ricordi, ad esempio un ID utente. Limita le memorie che possono essere recuperate o aggiornate. Usare una variabile {{$userId}} speciale per definire l'ambito delle memorie per l'utente attualmente connesso.	Sì
search_options	MemorySearchOptions	Opzioni di ricerca in memoria.	No
└max_memories	integer	Numero massimo di elementi di memoria da restituire.	No
type	enum	Tipo dello strumento. Sempre memory_search_preview. Valori possibili: memory_search_preview	Sì
update_delay	integer	Tempo di attesa prima di aggiornare le memorie dopo inattività (secondi). Impostazione predefinita: 300.	No	300

MemorySearchToolCallItemParam

Name	Type	Description	Obbligatorio	Predefinito
results	matrice di MemorySearchItem	Risultati restituiti dalla ricerca di memoria.	No
type	enum	Valori possibili: memory_search_call	Sì

MemorySearchToolCallItemResource

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
results	matrice di MemorySearchItem	Risultati restituiti dalla ricerca di memoria.	No
Stato	enum	Stato della chiamata allo strumento di ricerca della memoria. Uno di in_progress, searching completed, incompleteo failed, Valori possibili: in_progress, searchingcompleted, , incomplete,failed	Sì
type	enum	Valori possibili: memory_search_call	Sì

MemoryStoreDefaultDefinition

Implementazione dell'archivio di memoria predefinito.

Name	Type	Description	Obbligatorio	Predefinito
chat_model	string	Nome o identificatore della distribuzione del modello di completamento della chat usata per l'elaborazione della memoria.	Sì
embedding_model	string	Nome o identificatore della distribuzione del modello di incorporamento utilizzata per l'elaborazione della memoria.	Sì
kind	enum	Tipo di archivio di memoria. Valori possibili: default	Sì
options	MemoryStoreDefaultOptions	Configurazioni predefinite dell'archivio di memoria.	No
└chat_summary_enabled	boolean	Indica se abilitare l'estrazione di riepilogo della chat e storage. Il valore predefinito è vero.	Sì	True
└user_profile_details	string	Categorie o tipi specifici di informazioni del profilo utente da estrarre e archiviare.	No
└user_profile_enabled	boolean	Indica se abilitare l'estrazione e l'storage dei profili utente. Il valore predefinito è vero.	Sì	True

MemoryStoreDefaultOptions

Configurazioni predefinite dell'archivio di memoria.

Name	Type	Description	Obbligatorio	Predefinito
chat_summary_enabled	boolean	Indica se abilitare l'estrazione di riepilogo della chat e storage. Il valore predefinito è vero.	Sì	True
user_profile_details	string	Categorie o tipi specifici di informazioni del profilo utente da estrarre e archiviare.	No
user_profile_enabled	boolean	Indica se abilitare l'estrazione e l'storage dei profili utente. Il valore predefinito è vero.	Sì	True

MemoryStoreDefinition

Definizione di base per le configurazioni dell'archivio di memoria.

Discriminare per MemoryStoreDefinition

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

Valore del tipo	Schema
default	MemoryStoreDefaultDefinition

Name	Type	Description	Obbligatorio	Predefinito
kind	MemoryStoreKind	Tipo di implementazione dell'archivio memoria da utilizzare.	Sì

MemoryStoreDeleteScopeResponse

Risposta per l'eliminazione di ricordi da un oscilloscopio.

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean	Indica se l'operazione di eliminazione ha avuto esito positivo.	Sì
nome	string	Nome dell'archivio di memoria.	Sì
object	enum	Tipo dell'oggetto. Sempre 'memory_store.scope.deleted'. Valori possibili: memory_store.scope.deleted	Sì
scope	string	Ambito da cui sono stati eliminati i ricordi.	Sì

MemoryStoreKind

Tipo di implementazione dell'archivio memoria da utilizzare.

Proprietà	Value
Descrizione	Tipo di implementazione dell'archivio memoria da utilizzare.
Type	string
Valori	default

MemoryStoreObject

Un archivio di memoria in grado di memorizzare e recuperare le memorie degli utenti.

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Timestamp Unix (secondi) quando è stato creato l'archivio di memoria.	Sì
Definizione	MemoryStoreDefinition	Definizione di base per le configurazioni dell'archivio di memoria.	Sì
└* tipo	MemoryStoreKind	Tipo di archivio di memoria.	Sì
descrizione	string	Descrizione leggibile dell'archivio memoria. Vincoli: maxLength: 512	No
id	string	Identificatore univoco dell'archivio di memoria.	Sì
metadata	object	Metadati arbitrari chiave-valore da associare all'archivio di memoria.	No
nome	string	Nome dell'archivio di memoria. Vincoli: maxLength: 256	Sì
object	enum	Tipo di oggetto, che è sempre "memory_store". Valori possibili: memory_store	Sì
updated_at	integer	Timestamp Unix (secondi) dell'ultimo aggiornamento dell'archivio di memoria.	Sì

MemoryStoreOperationUsage

Statistiche di utilizzo di un'operazione di archiviazione della memoria.

Name	Type	Description	Obbligatorio	Predefinito
embedding_tokens	integer	Numero di token di incorporamento.	Sì
input_tokens	OpenAI.integer		Sì
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sì
└cached_tokens	OpenAI.integer		Sì
output_tokens	OpenAI.integer		Sì
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Sì
└─ token_di_ragionamento	OpenAI.integer		Sì
total_tokens	OpenAI.integer		Sì

MemoryStoreSearchResponse

Risposta di ricerca in memoria.

Name	Type	Description	Obbligatorio	Predefinito
Ricordi	matrice di MemorySearchItem	Elementi di memoria correlati trovati durante l'operazione di ricerca.	Sì
search_id	string	ID univoco di questa richiesta di ricerca. Usare questo valore come previous_search_id nelle richieste successive per eseguire ricerche incrementali.	Sì
uso	MemoryStoreOperationUsage	Statistiche di utilizzo di un'operazione di archiviazione della memoria.	Sì
└embedding_tokens	integer	Numero di token di incorporamento.	Sì
└ input_tokens	OpenAI.integer	Numero di token di input.	Sì
└input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Dettaglio dei token di input.	Sì
└output_tokens	OpenAI.integer	Numero di token in uscita.	Sì
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Dettaglio dei token di output.	Sì
└total_tokens	OpenAI.integer	Numero totale di token usati.	Sì

MemoryStoreUpdateCompletedResult

Risultato dell'aggiornamento della memoria.

Name	Type	Description	Obbligatorio	Predefinito
memory_operations	matrice di MemoryOperation	Elenco di singole operazioni di memoria eseguite durante l'aggiornamento.	Sì
uso	MemoryStoreOperationUsage	Statistiche di utilizzo di un'operazione di archiviazione della memoria.	Sì
└embedding_tokens	integer	Numero di token di incorporamento.	Sì
└ input_tokens	OpenAI.integer	Numero di token di input.	Sì
└input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Dettaglio dei token di input.	Sì
└output_tokens	OpenAI.integer	Numero di token in uscita.	Sì
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Dettaglio dei token di output.	Sì
└total_tokens	OpenAI.integer	Numero totale di token usati.	Sì

MemoryStoreUpdateResponse

Fornisce lo stato di un'operazione di aggiornamento dell'archivio di memoria.

Name	Type	Description	Obbligatorio	Predefinito
error	OpenAI.Error		No
└* additionalInfo	object		No
└─ codice	stringa (nullabile)		Sì
└* debugInfo	object		No
└* dettagli	matrice di OpenAI.Error		No
└* messaggio	string		Sì
└* param	stringa (nullabile)		No
└─ Tipo	string		No
result	MemoryStoreUpdateCompletedResult	Risultato dell'aggiornamento della memoria.	No
└memory_operations	matrice di MemoryOperation	Elenco di singole operazioni di memoria eseguite durante l'aggiornamento.	Sì
└─ utilizzo	MemoryStoreOperationUsage	Statistiche di utilizzo associate all'operazione di aggiornamento della memoria.	Sì
Stato	MemoryStoreUpdateStatus	Stato di un'operazione di aggiornamento dell'archivio di memoria.	Sì
superseded_by	string	Il update_id l'operazione è stata sostituita da quando lo stato è "sostituito".	No
update_id	string	ID univoco di questa richiesta di aggiornamento. Usare questo valore come previous_update_id nelle richieste successive per eseguire aggiornamenti incrementali.	Sì

MemoryStoreUpdateStatus

Stato di un'operazione di aggiornamento dell'archivio di memoria.

Proprietà	Value
Type	string
Valori	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

Le informazioni di definizione di input per uno strumento Microsoft Fabric come utilizzate per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
fabric_dataagent_preview	FabricDataAgentToolParameters	Parametri dello strumento agente dati fabric.	Sì
└project_connections	matrice di ToolProjectConnection	Le connessioni project collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	No
type	enum	Il tipo di oggetto, che è sempre 'fabric_dataagent_preview'. Valori possibili: fabric_dataagent_preview	Sì

Distribuzione del Modello

Definizione della distribuzione del modello

Name	Type	Description	Obbligatorio	Predefinito
capabilities	oggetto (sola lettura)	Funzionalità del modello distribuito	Sì
Connectionname	string (sola lettura)	Il nome della connessione da cui proviene la distribuzione	No
modelName	string (sola lettura)	Publisher nome specifico del modello distribuito	Sì
modelPublisher	string (sola lettura)	Nome dell'editore del modello distribuito	Sì
versioneDelModello	string (sola lettura)	Publisher versione specifica del modello distribuito	Sì
nome	string (sola lettura)	Nome della distribuzione	Sì
sku	Sku (sola lettura)	Informazioni sullo SKU	Sì
└* capacità	integer	Capacità sku	Sì
Famiglia └*	string	Famiglia sku	Sì
└> nome	string	Nome SKU	Sì
└* dimensioni	string	Dimensioni sku	Sì
Livello └*	string	Livello SKU	Sì
type	enum	Tipo di distribuzione Valori possibili: ModelDeployment	Sì

ModelSamplingParams

Rappresenta un set di parametri utilizzati per controllare il comportamento di campionamento di un modello linguistico durante la generazione di testo.

Name	Type	Description	Obbligatorio	Predefinito
max_completion_tokens	integer	Numero massimo di token consentiti nel completamento.	Sì
seed	integer	Valore di inizializzazione casuale per la riproducibilità.	Sì
Temperatura	Numero	Parametro di temperatura per il campionamento.	Sì
top_p	Numero	Parametro top-p per il campionamento del nucleo.	Sì

ModelSamplingParamsUpdate

Rappresenta un set di parametri utilizzati per controllare il comportamento di campionamento di un modello linguistico durante la generazione di testo.

Name	Type	Description	Obbligatorio	Predefinito
max_completion_tokens	integer	Numero massimo di token consentiti nel completamento.	No
seed	integer	Valore di inizializzazione casuale per la riproducibilità.	No
Temperatura	Numero	Parametro di temperatura per il campionamento.	No
top_p	Numero	Parametro top-p per il campionamento del nucleo.	No

MonthlyRecurrenceSchedule

Pianificazione della ricorrenza mensile.

Name	Type	Description	Obbligatorio	Predefinito
daysOfMonth	matrice di numeri interi	Giorni del mese per la pianificazione della ricorrenza.	Sì
type	enum	Tipo di ricorrenza mensile. Valori possibili: Monthly	Sì

NoAuthenticationCredentials

Credenziali che non richiedono l'autenticazione

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di credenziale Valori possibili: None	Sì

OAuthConsentRequestOutputItem

Richiedere al servizio per consentire all'utente di eseguire il consenso OAuth.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
consent_link	string	Collegamento che l'utente può usare per eseguire il consenso OAuth.	Sì
id	string		Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
etichetta del server	string	Etichetta del server per la richiesta di consenso OAuth.	Sì
type	enum	Valori possibili: oauth_consent_request	Sì

OneTimeTrigger

Attivazione una tantum.

Name	Type	Description	Obbligatorio	Predefinito
timeZone	string	Fuso orario per l'attivazione una tantum.	No	UTC
triggerAt	string	Data e ora del trigger una tantum in formato ISO 8601.	Sì
type	enum	Valori possibili: OneTime	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

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

Valori di stato segnalati per le chiamate degli strumenti apply_patch.

Proprietà	Value
Type	string
Valori	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

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ì

OpenAI.ApplyPatchCreateFileOperationParam

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ì

OpenAI.ApplyPatchDeleteFileOperation

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ì

OpenAI.ApplyPatchDeleteFileOperationParam

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ì

OpenAI.ApplyPatchFileOperation

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

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

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ì

OpenAI.ApplyPatchUpdateFileOperation

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ì

OpenAI.ApplyPatchUpdateFileOperationParam

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ì

OpenAI.PosizioneApprossimativa

Name	Type	Description	Obbligatorio	Predefinito
Città	stringa (nullabile)		No
paese	stringa (nullabile)		No
region	stringa (nullabile)		No
timezone	stringa (nullabile)		No
type	enum	Tipo di approssimazione della posizione. Sempre approximate. Valori possibili: approximate	Sì

OpenAI.ChatCompletionTool

Strumento di funzione che può essere usato per generare una risposta.

Name	Type	Description	Obbligatorio	Predefinito
funzione	OpenAI.FunctionObject		Sì
type	enum	Tipo dello strumento. Attualmente è supportato solo function. Valori possibili: function	Sì

OpenAI.ChatModel

Proprietà	Value
Type	string
Valori	gpt-5.2 gpt-5.2-2025-12-11 gpt-5.2-chat-latest gpt-5.2-pro gpt-5.2-pro-2025-12-11 gpt-5.1 gpt-5.1-2025-11-13 gpt-5.1-codex gpt-5.1-mini gpt-5.1-chat-latest gpt-5 gpt-5-mini gpt-5-nano gpt-5-2025-08-07 gpt-5-mini-2025-08-07 gpt-5-nano-2025-08-07 gpt-5-chat-latest gpt-4.1 gpt-4.1-mini gpt-4.1-nano gpt-4.1-2025-04-14 gpt-4.1-mini-2025-04-14 gpt-4.1-nano-2025-04-14 o4-mini o4-mini-2025-04-16 o3 o3-2025-04-16 o3-mini o3-mini-2025-01-31 o1 o1-2024-12-17 o1-preview o1-preview-2024-09-12 o1-mini o1-mini-2024-09-12 gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-08-06 gpt-4o-2024-05-13 gpt-4o-audio-preview gpt-4o-audio-preview-2024-10-01 gpt-4o-audio-preview-2024-12-17 gpt-4o-audio-preview-2025-06-03 gpt-4o-mini-audio-preview gpt-4o-mini-audio-preview-2024-12-17 gpt-4o-search-preview gpt-4o-mini-search-preview gpt-4o-search-preview-2025-03-11 gpt-4o-mini-search-preview-2025-03-11 chatgpt-4o-latest codex-mini-latest gpt-4o-mini gpt-4o-mini-2024-07-18 gpt-4-turbo gpt-4-turbo-2024-04-09 gpt-4-0125-preview gpt-4-turbo-preview gpt-4-1106-preview gpt-4-vision-preview gpt-4 gpt-4-0314 gpt-4-0613 gpt-4-32k gpt-4-32k-0314 gpt-4-32k-0613 gpt-3.5-turbo gpt-3.5-turbo-16k gpt-3.5-turbo-0301 gpt-3.5-turbo-0613 gpt-3.5-turbo-1106 gpt-3.5-turbo-0125 gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Proprietà	Value
Type	string
Valori	left right wheel back forward

OpenAI.ClickParam

Azione di fare clic.

Name	Type	Description	Obbligatorio	Predefinito
pulsante	OpenAI.ClickButtonType		Sì
type	enum	Specifica il tipo di evento. Per un'azione di clic, questa proprietà è sempre click. Valori possibili: click	Sì
x	OpenAI.integer		Sì
y	OpenAI.integer		Sì

OpenAI.CodeInterpreterContainerAuto

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.	No
limite_di_memoria	OpenAI.ContainerMemoryLimit (nullabile)		No
type	enum	Sempre auto. Valori possibili: auto	Sì

OpenAI.CodeInterpreterOutputImage

Output dell'immagine dell'interprete di codice.

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

OpenAI.CodeInterpreterOutputLogs

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ì

OpenAI.CodeInterpreterTool

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

Name	Type	Description	Obbligatorio	Predefinito
container	string o OpenAI.CodeInterpreterContainerAuto	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 . Se non viene specificato, il servizio presuppone l'auto.	No
type	enum	Tipo dello strumento dell'interprete di codice. Sempre code_interpreter. Valori possibili: code_interpreter	Sì

OpenAI.CompactResource

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Timestamp Unix (in secondi) quando è stata creata la conversazione compattata.	Sì
id	string	Identificatore univoco per la risposta compattata.	Sì
object	enum	Tipo dell'oggetto. Sempre response.compaction. Valori possibili: response.compaction	Sì
output	matrice di OpenAI.OutputItem	Elenco compattato di elementi di output. Si tratta di un elenco di tutti i messaggi utente, seguiti da un singolo elemento di compattazione.	Sì
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.	Sì
└ input_tokens	OpenAI.integer	Numero di token di input.	Sì
└input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Dettaglio dei token di input.	Sì
└output_tokens	OpenAI.integer	Numero di token in uscita.	Sì
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Dettaglio dei token di output.	Sì
└total_tokens	OpenAI.integer	Numero totale di token usati.	Sì

OpenAI.CompactResponseMethodPublicBody

Name	Type	Description	Obbligatorio	Predefinito
input	stringa o matrice di OpenAI.InputItem		No
instructions	stringa (nullabile)		No
model	OpenAI.ModelIdsCompaction	ID modello usato per generare la risposta, ad esempio gpt-5 o o3. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, caratteristiche delle prestazioni e punti di prezzo. Fare riferimento alla guida del modello per esplorare e confrontare i modelli disponibili.	Sì
previous_response_id	stringa (nullabile)		No

OpenAI.ComparisonFilter

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, negt, gte, , ltlte	Sì
value	string o OpenAI.numeric o boolean o matrice di OpenAI.ComparisonFilterValueItems	Valore da confrontare con la chiave dell'attributo; supporta tipi stringa, numero o boolean.	Sì

OpenAI.ComparisonFilterValueItems

Tipo: string o OpenAI.numeric

OpenAI.CompoundFilter

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.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.Screenshot
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ComputerActionType		Sì

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	Predefinito
codice	stringa (nullabile)		No
id	string	ID del controllo di sicurezza in sospeso.	Sì
message	stringa (nullabile)		No

OpenAI.ComputerEnvironment

Proprietà	Value
Type	string
Valori	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Screenshot di un computer.

Name	Type	Description	Obbligatorio	Predefinito
ID del file	stringa (nullabile)		Sì
image_url	string		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ì

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	string	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ì

OpenAI.ComputerUsePreviewTool

Strumento che controlla un computer virtuale.

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

OpenAI.ContainerFileCitationBody

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	OpenAI.integer		Sì
ID del file	string	L'ID del fascicolo.	Sì
filename	string	Nome file del file contenitore citato.	Sì
start_index	OpenAI.integer		Sì
type	enum	Tipo di citazione del file contenitore. Sempre container_file_citation. Valori possibili: container_file_citation	Sì

OpenAI.ContainerMemoryLimit

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

OpenAI.ConversationItem

Un singolo elemento all'interno di una conversazione. Il set di tipi possibili è uguale al output tipo di un oggetto Response.

Discriminare per OpenAI.ConversationItem

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

Valore del tipo	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ConversationItemType		Sì

OpenAI.ConversationItemApplyPatchToolCall

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ì

OpenAI.ConversationItemApplyPatchToolCallOutput

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 (nullabile)		No
Stato	OpenAI.ApplyPatchCallOutputStatus		Sì
type	enum	Tipo dell'elemento. Sempre apply_patch_call_output. Valori possibili: apply_patch_call_output	Sì

OpenAI.ConversationItemCodeInterpreterToolCall

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa (nullabile)		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		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ì

OpenAI.ConversationItemComputerToolCall

Chiamata di uno strumento a uno strumento per l'uso del computer. Per altre informazioni, vedere la guida all'uso del computer .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		Sì
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ì

OpenAI.ConversationItemComputerToolCallOutputResource

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	ID dell'output della chiamata dello strumento computer.	No
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ì

OpenAI.ConversationItemCustomToolCall

Chiamata a uno strumento personalizzato creato dal modello.

Name	Type	Description	Obbligatorio	Predefinito
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ì
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre custom_tool_call. Valori possibili: custom_tool_call	Sì

OpenAI.ConversationItemCustomToolCallOutput

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

Name	Type	Description	Obbligatorio	Predefinito
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.ConversationItemFileSearchToolCall

Risultati di una chiamata allo strumento di ricerca file. Per altre informazioni, vedere la guida alla ricerca di file .

Name	Type	Description	Obbligatorio	Predefinito
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		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.ConversationItemFunctionShellCall

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	OpenAI.integer (nullabile)		Sì
└timeout_ms	OpenAI.integer (nullabile)		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
id	string	ID univoco della chiamata dello strumento shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
Stato	OpenAI.LocalShellCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre shell_call. Valori possibili: shell_call	Sì

OpenAI.ConversationItemFunctionShellCallOutput

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	OpenAI.integer (nullabile)		Sì
output	matrice di OpenAI.FunctionShellCallOutputContent	Matrice di contenuti di output delle chiamate shell	Sì
type	enum	Tipo dell'output delle chiamate della shell. Sempre shell_call_output. Valori possibili: shell_call_output	Sì

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string	ID univoco dell'output della chiamata dello strumento di funzione. Popolato quando questo elemento viene restituito tramite l'API.	No
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.ConversationItemFunctionToolCallResource

Name	Type	Description	Obbligatorio	Predefinito
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	ID univoco della chiamata dello strumento di funzione.	No
nome	string	Nome della funzione da eseguire.	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 chiamata dello strumento di funzione. Sempre function_call. Valori possibili: function_call	Sì

OpenAI.ConversationItemImageGenToolCall

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa (nullabile)		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.ConversationItemList

Elenco di elementi di conversazione.

Name	Type	Description	Obbligatorio	Predefinito
data	matrice di OpenAI.ConversationItem	Elenco di elementi della conversazione.	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.ConversationItemLocalShellToolCall

Chiamata dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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.ConversationItemLocalShellToolCallOutput

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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	enum	Valori possibili: in_progress, completed, incomplete	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.ConversationItemMcpApprovalRequest

Richiesta di approvazione umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio	Predefinito
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.ConversationItemMcpApprovalResponseResource

Risposta a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio	Predefinito
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 (nullabile)		No
type	enum	Tipo dell'elemento. Sempre mcp_approval_response. Valori possibili: mcp_approval_response	Sì

OpenAI.ConversationItemMcpListTools

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
error	stringa (nullabile)		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.ConversationItemMcpToolCall

Chiamata di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
approval_request_id	stringa (nullabile)		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	stringa (nullabile)		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa (nullabile)		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.ConversationItemMessage

Messaggio da o verso il modello.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.MessageContent	Contenuto del messaggio	Sì
id	string	ID univoco del messaggio.	Sì
Ruolo	OpenAI.MessageRole		Sì
Stato	OpenAI.MessageStatus		Sì
type	enum	Tipo del messaggio. Sempre impostato su message. Valori possibili: message	Sì

OpenAI.ConversationItemReasoningItem

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	Predefinito
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa (nullabile)		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	matrice di OpenAI.Summary	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre reasoning. Valori possibili: reasoning	Sì

OpenAI.ConversationItemType

Proprietà	Value
Type	string
Valori	message function_call function_call_output file_search_call web_search_call image_generation_call computer_call computer_call_output reasoning 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 custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Risultati di una chiamata allo strumento di ricerca Web. Per altre informazioni, vedere la guida alla ricerca Web .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include informazioni dettagliate sul modo in cui il modello ha usato il Web (ricerca, open_page, ricerca).	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.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.

Tipo: string o OpenAI.ConversationParam-2

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.

OpenAI.ConversationParam-2

Conversazione a cui appartiene questa risposta.

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

OpenAI.ConversationReference

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

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Ora in cui è stata creata la conversazione, misurata in secondi dall'epoca Unix.	Sì
id	string	ID univoco della conversazione.	Sì
metadata	OpenAI.Metadata	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	Sì
object	enum	Tipo di oggetto, che è sempre conversation. Valori possibili: conversation	Sì

OpenAI.CreateChatCompletionRequestResponseFormat

Oggetto che specifica il formato che il modello deve restituire. L'impostazione su { "type": "json_schema", "json_schema": {...} } abilita gli output strutturati che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere la Guida agli output strutturati. L'impostazione su { "type": "json_object" } abilita la modalità JSON precedente, 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.CreateChatCompletionRequestResponseFormat

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

Valore del tipo	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Sì

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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

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

Proprietà	Value
Type	string
Valori	text json_schema json_object

OpenAI.CreateConversationBody

Name	Type	Description	Obbligatorio	Predefinito
items	matrice di OpenAI.InputItem		No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No

OpenAI.CreateEvalCompletionsRunDataSource

Oggetto CompletionsRunDataSource che descrive una configurazione di campionamento del modello.

Name	Type	Description	Obbligatorio	Predefinito
messaggi di input	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate o OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Utilizzato durante il campionamento da un modello. Determina la struttura dei messaggi passati nel modello. Può essere un riferimento a una traiettoria predefinita (ad esempio, item.input_trajectory) o a un modello con riferimenti variabili allo spazio dei item nomi.	No
model	string	Nome del modello da usare per la generazione di completamenti (ad esempio"o3-mini").	No
sampling_params	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalStoredCompletionsSource	Determina il popolamento dello item spazio dei nomi nell'origine dati di questa esecuzione.	Sì
type	enum	Tipo di origine dati di esecuzione. Sempre completions. Valori possibili: completions	Sì

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Type	Description	Obbligatorio	Predefinito
template	matrice di OpenAI.EasyInputMessage o OpenAI.EvalItem		Sì
type	enum	Valori possibili: template	Sì

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Type	Description	Obbligatorio	Predefinito
max_completion_tokens	OpenAI.integer		No
sforzo di ragionamento	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
formato_risposta	OpenAI.ResponseFormatText o OpenAI.ResponseFormatJsonSchema o OpenAI.ResponseFormatJsonObject		No
seed	OpenAI.integer		No	42
Temperatura	OpenAI.numeric		No	1
Strumenti	matrice di OpenAI.ChatCompletionTool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalCustomDataSourceConfig

Oggetto CustomDataSourceConfig che definisce lo schema per l'origine dati utilizzata per le esecuzioni di valutazione. Questo schema viene usato per definire la forma dei dati che saranno:

• Usato per definire i criteri di test e
• Quali dati sono necessari durante la creazione di un'esecuzione

Name	Type	Description	Obbligatorio	Predefinito
includi_schema_esempio	boolean	Indica se l'eval dovrebbe attendersi che tu popoli lo spazio dei nomi di esempio (cioè, generando risposte dalla tua fonte di dati).	No
schema_elemento	object	Schema JSON per ogni riga nell'origine dati.	Sì
type	enum	Tipo di origine dati. Sempre custom. Valori possibili: custom	Sì

OpenAI.CreateEvalJsonlRunDataSource

Oggetto JsonlRunDataSource con che specifica un file JSONL che corrisponde all'eval

Name	Type	Description	Obbligatorio	Predefinito
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Determina il popolamento dello item spazio dei nomi nell'origine dati.	Sì
type	enum	Tipo di origine dati. Sempre jsonl. Valori possibili: jsonl	Sì

OpenAI.CreateEvalLogsDataSourceConfig

Configurazione dell'origine dati che specifica la proprietà dei metadati della query di log. Si tratta in genere di metadati come usecase=chatbot o prompt-version=v2e così via.

Name	Type	Description	Obbligatorio	Predefinito
metadata	object	Filtri di metadati per l'origine dati dei log.	No
type	enum	Tipo di origine dati. Sempre logs. Valori possibili: logs	Sì

OpenAI.CreateEvalResponsesRunDataSource

Oggetto ResponsesRunDataSource che descrive una configurazione di campionamento del modello.

Name	Type	Description	Obbligatorio	Predefinito
messaggi di input	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate o OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Utilizzato durante il campionamento da un modello. Determina la struttura dei messaggi passati nel modello. Può essere un riferimento a una traiettoria predefinita (ad esempio, item.input_trajectory) o a un modello con riferimenti variabili allo spazio dei item nomi.	No
model	string	Nome del modello da usare per la generazione di completamenti (ad esempio"o3-mini").	No
sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalResponsesSource	Determina il popolamento dello item spazio dei nomi nell'origine dati di questa esecuzione.	Sì
type	enum	Tipo di origine dati di esecuzione. Sempre responses. Valori possibili: responses	Sì

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

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

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Type	Description	Obbligatorio	Predefinito
template	matrice di oggetti o OpenAI.EvalItem		Sì
type	enum	Valori possibili: template	Sì

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Type	Description	Obbligatorio	Predefinito
max_completion_tokens	OpenAI.integer		No
sforzo di ragionamento	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
seed	OpenAI.integer		No	42
Temperatura	OpenAI.numeric		No	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
Strumenti	matrice di OpenAI.Tool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

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

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Deprecato a favore di LogsDataSourceConfig.

Name	Type	Description	Obbligatorio	Predefinito
metadata	object	Filtri di metadati per l'origine dati di completamento archiviati.	No
type	enum	Tipo di origine dati. Sempre stored_completions. Valori possibili: stored_completions	Sì

OpenAI.CreateFineTuningJobRequest

Modelli validi:

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

Name	Type	Description	Obbligatorio	Predefinito
iperparametri	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└batch_size	string o OpenAI.integer		No	auto
└learning_rate_multiplier	string o OpenAI.numeric		No
└n_epochs	string o OpenAI.integer		No	auto
integrazioni	matrice di OpenAI.CreateFineTuningJobRequestIntegrations	Elenco di integrazioni da abilitare per il processo di ottimizzazione.	No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
method	OpenAI.FineTuneMethod	Metodo utilizzato per l'ottimizzazione.	No
model	string (vedere modelli validi di seguito)	Nome del modello da ottimizzare. È possibile selezionare una delle c0.	Sì
seed	OpenAI.integer (nullabile)		No
Suffisso	stringa (nullabile)	Stringa di un massimo di 64 caratteri che verrà aggiunta al nome del modello ottimizzato. Ad esempio, un suffix valore di "custom-model-name" produce un nome di modello come ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. Vincoli: minLength: 1, maxLength: 64	No
file di allenamento	string	ID di un file caricato che contiene i dati di training. Per informazioni su come caricare un file, vedere Caricare un file. Il set di dati deve essere formattato come file JSONL. Inoltre, è necessario caricare il file con lo scopo fine-tune. Il contenuto del file deve variare a seconda che il modello usi la chat, il formato dei completamenti o se il metodo di ottimizzazione usa il formato preferenza . Consulta la guida fine-tuning per maggiori dettagli.	Sì
file_di_validazione	stringa (nullabile)	ID di un file caricato che contiene i dati di convalida. Se si specifica questo file, i dati vengono usati per generare la convalida metriche periodicamente durante l'ottimizzazione. Queste metriche possono essere visualizzate in file dei risultati di ottimizzazione. Gli stessi dati non devono essere presenti sia nei file di training che in quello di convalida. Il set di dati deve essere formattato come file JSONL. È necessario caricare il file con lo scopo fine-tune. Consulta la guida fine-tuning per maggiori dettagli.	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Type	Description	Obbligatorio	Predefinito
dimensione del batch	string o OpenAI.integer		No
moltiplicatore_tasso_apprendimento	string o OpenAI.numeric		No
numero di epoche	string o OpenAI.integer		No

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Valori possibili: wandb	Sì
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Sì

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Type	Description	Obbligatorio	Predefinito
entità	stringa (nullabile)		No
nome	stringa (nullabile)		No
project	string		Sì
tags	matrice di valori string		No

OpenAI.CreateResponseStreamingResponse

Tipo: OpenAI.ResponseAudioDeltaEvent o OpenAI.ResponseAudioTranscriptDeltaEvent o OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent o OpenAI.ResponseCodeInterpreterCallInProgressEvent o OpenAI.ResponseCodeInterpreterCallInterpretingEvent o OpenAI.ResponseContentPartAddedEvent o OpenAI.ResponseCreatedEvent o OpenAI.ResponseErrorEvent o OpenAI.ResponseErrorEvent o OpenAI.ResponseErrorEvent o OpenAI.ResponseFileSearchCallInProgressEvent o OpenAI.ResponseFileSearchSearchingEvent o OpenAI.ResponseFunctionCallArgumentsDeltaEvent o OpenAI.ResponseInProgressEvent o OpenAI.ResponseFailedEvent o OpenAI.ResponseIncompleteEvent o OpenAI.ResponseOutputItemAddedEvent o OpenAI.ResponseReasoningSummaryPartAddedEvent o OpenAI.ResponseReasoningSummaryTextDeltaEvent o OpenAI.ResponseReasoningTextDeltaEvent o OpenAI.ResponseRefusalDeltaEvent o OpenAI.ResponseTextDeltaEvent o OpenAI.ResponseWebSearchCallInProgressEvent o OpenAI.ResponseWebSearchCallSearchingEvent o OpenAI.ResponseImageGenCallGeneratingEvent o OpenAI.ResponseImageGenCallInProgressEvent o OpenAI.ResponseImageGenCallPartialImageEvent o OpenAI.ResponseMCPCallArgumentsDeltaEvent o OpenAI.ResponseMCPCallFailedEvent o OpenAI.ResponseMCPCallInProgressEvent o OpenAI.ResponseMCPListToolsFailedEvent o OpenAI.ResponseMCPListToolsInProgressEvent o OpenAI.ResponseOutputTextAnnotationAddedEvent o OpenAI.ResponseQueuedEvent o OpenAI.ResponseCustomToolCallInputDeltaEvent o OpenAI.ResponseAudioDoneEvent o OpenAI.ResponseAudioDoneEvent o OpenAI.ResponseAudioTranscriptDoneEvent o OpenAI.ResponseCodeInterpreterCallCodeDoneEvent o OpenAI.ResponseCodeInterpreterCallCompletedEvent o OpenAI.ResponseCompletedEvent o OpenAI.ResponseContentPartDoneEvent o OpenAI.ResponseFileSearchCallCompletedEvent o OpenAI.ResponseFunctionCallArgumentsDoneEvent o OpenAI.ResponseOutputItemDoneEvent o OpenAI.ResponseOutputItemDoneEvent o OpenAI.ResponseFileSearchCallCompletedEvent o OpenAI.ResponseFunctionCallArgumentsDoneEvent o OpenAI.ResponseOutputItemDoneEvent o OpenAI.ResponseReasoningSummaryPartDoneEvent o OpenAI.ResponseReasoningSummaryTextDoneEvent o OpenAI.ResponseReasoningTextDoneEvent o OpenAI.ResponseRefusalDoneEvent o OpenAI.ResponseRefusalDoneEvent o OpenAI.Response ResponseTextDoneEvent o OpenAI.ResponseWebSearchCallCompletedEvent o OpenAI.ResponseImageGenCallCompletedEvent o OpenAI.ResponseMCPCallArgumentsDoneEvent o OpenAI.ResponseMCPCallCompletedEvent o OpenAI.ResponseMCPListToolsCompletedEvent o OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

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ì

OpenAI.CustomTextFormatParam

Testo in formato libero senza vincoli.

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

OpenAI.CustomToolParam

Strumento personalizzato che elabora l'input usando un formato specificato. Altre informazioni sugli strumenti personalizzati

Name	Type	Description	Obbligatorio	Predefinito
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ì

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

Name	Type	Description	Obbligatorio	Predefinito
cancellato	boolean		Sì
id	string		Sì
object	enum	Valori possibili: conversation.deleted	Sì

OpenAI.DetailEnum

Proprietà	Value
Type	string
Valori	low high auto

OpenAI.DoubleClickAction

Azione con doppio clic.

Name	Type	Description	Obbligatorio	Predefinito
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ì
x	OpenAI.integer		Sì
y	OpenAI.integer		Sì

OpenAI.Drag

Azione di trascinamento.

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

OpenAI.DragPoint

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

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

OpenAI.EasyInputMessage

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	Predefinito
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ì
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.Error

Name	Type	Description	Obbligatorio	Predefinito
informazioni aggiuntive	object		No
codice	stringa (nullabile)		Sì
debugInfo	object		No
details	matrice di OpenAI.Error		No
message	string		Sì
param	stringa (nullabile)		No
type	string		No

OpenAI.EvalApiError

Oggetto che rappresenta una risposta di errore dall'API Eval.

Name	Type	Description	Obbligatorio	Predefinito
codice	string	Codice di errore.	Sì
message	string	Messaggio di errore.	Sì

OpenAI.EvalGraderLabelModel

Name	Type	Description	Obbligatorio	Predefinito
input	matrice di OpenAI.EvalItem		Sì
labels	matrice di valori string	Etichette da assegnare a ogni elemento della valutazione.	Sì
model	string	Modello da utilizzare per la valutazione. Deve supportare output strutturati.	Sì
nome	string	Nome del grader.	Sì
etichette_di_passaggio	matrice di valori string	Le etichette che indicano un risultato positivo. Deve essere un sottoinsieme di etichette.	Sì
type	enum	Tipo di oggetto, che è sempre label_model. Valori possibili: label_model	Sì

OpenAI.EvalGraderPython

Name	Type	Description	Obbligatorio	Predefinito
image_tag	string	Tag immagine da usare per lo script Python.	No
nome	string	Nome del grader.	Sì
soglia di superamento	OpenAI.numeric		No
source	string	Codice sorgente dello script Python.	Sì
type	enum	Tipo di oggetto, che è sempre python. Valori possibili: python	Sì

OpenAI.EvalGraderScoreModel

Name	Type	Description	Obbligatorio	Predefinito
input	matrice di OpenAI.EvalItem	Messaggi di input valutati dal classificatore. Supporta blocchi di testo, testo di output, immagine di input e contenuto audio di input e può includere stringhe modello.	Sì
model	string	Modello da utilizzare per la valutazione.	Sì
nome	string	Nome del grader.	Sì
soglia di superamento	OpenAI.numeric		No
range	matrice di OpenAI.numeric	La gamma del punteggio. Di default è [0, 1].	No
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		No
└max_completions_tokens	OpenAI.integer (nullabile)		No
└reasoning_effort	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
└* seed	OpenAI.integer (nullabile)		No
└* temperatura	OpenAI.numeric (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
type	enum	Tipo di oggetto, che è sempre score_model. Valori possibili: score_model	Sì

OpenAI.EvalGraderScoreModelSamplingParams

Name	Type	Description	Obbligatorio	Predefinito
max_completions_tokens	OpenAI.integer (nullabile)		No
sforzo di ragionamento	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
seed	OpenAI.integer (nullabile)		No
Temperatura	OpenAI.numeric (nullabile)		No
top_p	OpenAI.numeric (nullabile)		No	1

OpenAI.EvalGraderStringCheck

Name	Type	Description	Obbligatorio	Predefinito
input	string	Il testo di input. Ciò può includere stringhe di modello.	Sì
nome	string	Nome del grader.	Sì
operazione	enum	Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike. Valori possibili: eq, ne, like, ilike	Sì
riferimento	string	Testo di riferimento. Ciò può includere stringhe di modello.	Sì
type	enum	Tipo di oggetto, che è sempre string_check. Valori possibili: string_check	Sì

OpenAI.EvalGraderTextSimilarity

Name	Type	Description	Obbligatorio	Predefinito
metrica di valutazione	enum	Metrica di valutazione da usare. Uno di cosine, fuzzy_match, bleu, , gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valori possibili: cosine, fuzzy_matchbleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l	Sì
input	string	Il testo in valutazione.	Sì
nome	string	Nome del grader.	Sì
soglia di superamento	OpenAI.numeric		Sì
riferimento	string	Testo che viene valutato.	Sì
type	enum	Tipo di grader. Valori possibili: text_similarity	Sì

OpenAI.EvalItem

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	Predefinito
contenuto	OpenAI.EvalItemContent	Input per il modello: può contenere stringhe di modello. Supporta testo, testo di output, immagini di input e audio di input, come singolo elemento o matrice di elementi.	Sì
Ruolo	enum	Ruolo dell'inserimento del messaggio. Uno di user, assistant, system, o developer. Valori possibili: user, assistant, system, developer	Sì
type	enum	Tipo di input del messaggio. Sempre message. Valori possibili: message	No

OpenAI.EvalItemContent

Input per il modello: può contenere stringhe di modello. Supporta testo, testo di output, immagini di input e audio di input, come singolo elemento o matrice di elementi.

Tipo: OpenAI.EvalItemContentItem o OpenAI.EvalItemContentArray

Input per il modello: può contenere stringhe di modello. Supporta testo, testo di output, immagini di input e audio di input, come singolo elemento o matrice di elementi.

OpenAI.EvalItemContentArray

Elenco di input, ognuno dei quali può essere un testo di input, testo di output, immagine di input o oggetto audio di input.

Matrice di: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Un singolo elemento di contenuto: testo di input, testo di output, immagine di input o audio di input.

Tipo: OpenAI.EvalItemContentText o OpenAI.EvalItemContentItemObject

Un singolo elemento di contenuto: testo di input, testo di output, immagine di input o audio di input.

OpenAI.EvalItemContentItemObject

Un singolo elemento di contenuto: testo di input, testo di output, immagine di input o audio di input.

Discriminare per OpenAI.EvalItemContentItemObject

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

Valore del tipo	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.EvalItemContentItemObjectType		Sì

OpenAI.EvalItemContentItemObjectInputTextContent

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ì

OpenAI.EvalItemContentItemObjectType

Proprietà	Value
Type	string
Valori	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Output di testo del modello.

Name	Type	Description	Obbligatorio	Predefinito
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ì

OpenAI.EvalItemContentText

Input di testo per il modello.

Tipo: string

OpenAI.EvalItemInputImage

Blocco di input immagine usato nelle matrici di contenuto EvalItem.

Name	Type	Description	Obbligatorio	Predefinito
Dettaglio	string	Livello di dettaglio dell'immagine da inviare al modello. Uno tra high, low e auto. Di default è auto.	No
image_url	string	URL dell'input dell'immagine.	Sì
type	enum	Tipo di input dell'immagine. Sempre input_image. Valori possibili: input_image	Sì

OpenAI.EvalJsonlFileContentSource

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.EvalJsonlFileContentSourceContentContent	Contenuto del file jsonl.	Sì
type	enum	Tipo di origine JSONL. Sempre file_content. Valori possibili: file_content	Sì

OpenAI.EvalJsonlFileContentSourceContentContent

Name	Type	Description	Obbligatorio	Predefinito
oggetto	object		Sì
campione	object		No

OpenAI.EvalJsonlFileIdSource

Name	Type	Description	Obbligatorio	Predefinito
id	string	Identificatore del file.	Sì
type	enum	Tipo di origine JSONL. Sempre file_id. Valori possibili: file_id	Sì

OpenAI.EvalResponsesSource

Oggetto EvalResponsesSource che descrive una configurazione dell'origine dati di esecuzione.

Name	Type	Description	Obbligatorio	Predefinito
creato_dopo	OpenAI.integer (nullabile)		No
creato_prima	OpenAI.integer (nullabile)		No
instructions_search	stringa (nullabile)		No
metadata	oggetto (nullable)		No
model	stringa (nullabile)		No
sforzo di ragionamento	OpenAI.ReasoningEffort (nullabile)	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
Temperatura	OpenAI.numeric (nullabile)		No
Strumenti	matrice di valori string		No
top_p	OpenAI.numeric (nullabile)		No
type	enum	Tipo di origine dati di esecuzione. Sempre responses. Valori possibili: responses	Sì
users	matrice di valori string		No

OpenAI.EvalRunOutputItemSample

Name	Type	Description	Obbligatorio	Predefinito
error	OpenAI.EvalApiError	Oggetto che rappresenta una risposta di errore dall'API Eval.	Sì
finish_reason	string		Sì
input	matrice di EvalRunOutputItemSampleInput		Sì
max_completion_tokens	OpenAI.integer		Sì
model	string		Sì
output	matrice di EvalRunOutputItemSampleOutputOutput		Sì
seed	OpenAI.integer		Sì
Temperatura	OpenAI.numeric		Sì
top_p	OpenAI.numeric		Sì
uso	OpenAI.EvalRunOutputItemSampleUsage		Sì

OpenAI.EvalRunOutputItemSampleUsage

Name	Type	Description	Obbligatorio	Predefinito
cached_tokens	OpenAI.integer		Sì
completion_tokens	OpenAI.integer		Sì
prompt_tokens	OpenAI.integer		Sì
total_tokens	OpenAI.integer		Sì

OpenAI.EvalRunPerModelUsage

Name	Type	Description	Obbligatorio	Predefinito
cached_tokens	OpenAI.integer		Sì
completion_tokens	OpenAI.integer		Sì
invocation_count	OpenAI.integer		Sì
nome_modello	string		Sì
prompt_tokens	OpenAI.integer		Sì
total_tokens	OpenAI.integer		Sì

OpenAI.EvalRunPerTestingCriteriaResults

Name	Type	Description	Obbligatorio	Predefinito
fallito	OpenAI.integer		Sì
Passato	OpenAI.integer		Sì
criteri_di_test	string		Sì

OpenAI.EvalRunResultCounts

Name	Type	Description	Obbligatorio	Predefinito
errore	OpenAI.integer		Sì
fallito	OpenAI.integer		Sì
Passato	OpenAI.integer		Sì
Totale	OpenAI.integer		Sì

OpenAI.EvalStoredCompletionsSource

Una configurazione StoredCompletionsRunDataSource che descrive un set di filtri

Name	Type	Description	Obbligatorio	Predefinito
creato_dopo	OpenAI.integer (nullabile)		No
creato_prima	OpenAI.integer (nullabile)		No
limit	OpenAI.integer (nullabile)		No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
model	stringa (nullabile)		No
type	enum	Tipo di origine. Sempre stored_completions. Valori possibili: stored_completions	Sì

OpenAI.FileCitationBody

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	OpenAI.integer		Sì
type	enum	Tipo di citazione del file. Sempre file_citation. Valori possibili: file_citation	Sì

OpenAI.FilePath

Percorso di un file.

Name	Type	Description	Obbligatorio	Predefinito
ID del file	string	L'ID del fascicolo.	Sì
index	OpenAI.integer		Sì
type	enum	Tipo del percorso del file. Sempre file_path. Valori possibili: file_path	Sì

OpenAI.FileSearchTool

Strumento che cerca il contenuto pertinente dai file caricati.

Name	Type	Description	Obbligatorio	Predefinito
Filtri	OpenAI.Filters (nullabili)		No
max_num_risultati	OpenAI.integer		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	OpenAI.numeric	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ì
vector_store_ids	matrice di valori string	ID degli archivi vettoriali da cercare.	Sì

OpenAI.FileSearchToolCallResults

Name	Type	Description	Obbligatorio	Predefinito
attributes	OpenAI.VectorStoreFileAttributes (nullabile)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima lunghezza di 512 caratteri, booleani o numeri.	No
ID del file	string		No
filename	string		No
Punteggio	Numero		No
text	string		No

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter o OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Iperparametri usati per il processo di ottimizzazione del dpo.

Name	Type	Description	Obbligatorio	Predefinito
dimensione del batch	string o OpenAI.integer	Numero di esempi in ogni batch. Una dimensione batch maggiore indica che i parametri del modello vengono aggiornati meno frequentemente, ma con varianza inferiore.	No
beta	string o OpenAI.numeric	Valore beta per il metodo DPO. Un valore beta più alto aumenterà il peso della penalità tra il criterio e il modello di riferimento.	No
moltiplicatore_tasso_apprendimento	string o OpenAI.numeric	Fattore di ridimensionamento per la frequenza di apprendimento. Una frequenza di apprendimento più piccola può essere utile per evitare l'overfitting.	No
numero di epoche	string o OpenAI.integer	Numero di periodi per cui eseguire il training del modello. Un periodo fa riferimento a un ciclo completo attraverso il set di dati di training.	No

OpenAI.FineTuneDPOMethod

Configurazione per il metodo di ottimizzazione del dpo.

Name	Type	Description	Obbligatorio	Predefinito
iperparametri	OpenAI.FineTuneDPOHyperparameters	Iperparametri usati per il processo di ottimizzazione del dpo.	No

OpenAI.FineTuneMethod

Metodo utilizzato per l'ottimizzazione.

Name	Type	Description	Obbligatorio	Predefinito
Dpo	OpenAI.FineTuneDPOMethod	Configurazione per il metodo di ottimizzazione del dpo.	No
Rinforzo	OpenAI.FineTuneReinforcementMethod	Configurazione per il metodo di ottimizzazione per rinforzo.	No
vigilato	OpenAI.FineTuneSupervisedMethod	Configurazione per il metodo di ottimizzazione con supervisione.	No
type	enum	Tipo di metodo. supervisedÈ , dpoo reinforcement. Valori possibili: supervised, dpo, reinforcement	Sì

OpenAI.FineTuneReinforcementHyperparameters

Iperparametri usati per il processo di ottimizzazione dell'ottimizzazione per rinforzo.

Name	Type	Description	Obbligatorio	Predefinito
dimensione del batch	string o OpenAI.integer	Numero di esempi in ogni batch. Una dimensione batch maggiore indica che i parametri del modello vengono aggiornati meno frequentemente, ma con varianza inferiore.	No
compute_multiplier	string o OpenAI.numeric	Moltiplicatore per la quantità di calcolo usata per esplorare lo spazio di ricerca durante il training.	No
eval_interval	string o OpenAI.integer	Numero di passaggi di addestramento tra le valutazioni.	No
eval_samples	string o OpenAI.integer	Numero di campioni di valutazione da generare per ogni passaggio di training.	No
moltiplicatore_tasso_apprendimento	string o OpenAI.numeric	Fattore di ridimensionamento per la frequenza di apprendimento. Una frequenza di apprendimento più piccola può essere utile per evitare l'overfitting.	No
numero di epoche	string o OpenAI.integer	Numero di periodi per cui eseguire il training del modello. Un periodo fa riferimento a un ciclo completo attraverso il set di dati di training.	No
sforzo di ragionamento	enum	Livello di sforzo di ragionamento. Valori possibili: default, low, medium, high	No

OpenAI.FineTuneReinforcementMethod

Configurazione per il metodo di ottimizzazione per rinforzo.

Name	Type	Description	Obbligatorio	Predefinito
Selezionatore	OpenAI.GraderStringCheck o OpenAI.GraderTextSimilarity o OpenAI.GraderPython o OpenAI.GraderScoreModel o OpenAI.GraderMulti	Grader utilizzato per il processo di ottimizzazione.	Sì
iperparametri	OpenAI.FineTuneReinforcementHyperparameters	Iperparametri usati per il processo di ottimizzazione dell'ottimizzazione per rinforzo.	No

OpenAI.FineTuneSupervisedHyperparameters

Iperparametri usati per il processo di ottimizzazione.

Name	Type	Description	Obbligatorio	Predefinito
dimensione del batch	string o OpenAI.integer	Numero di esempi in ogni batch. Una dimensione batch maggiore indica che i parametri del modello vengono aggiornati meno frequentemente, ma con varianza inferiore.	No
moltiplicatore_tasso_apprendimento	string o OpenAI.numeric	Fattore di ridimensionamento per la frequenza di apprendimento. Una frequenza di apprendimento più piccola può essere utile per evitare l'overfitting.	No
numero di epoche	string o OpenAI.integer	Numero di periodi per cui eseguire il training del modello. Un periodo fa riferimento a un ciclo completo attraverso il set di dati di training.	No

OpenAI.FineTuneSupervisedMethod

Configurazione per il metodo di ottimizzazione con supervisione.

Name	Type	Description	Obbligatorio	Predefinito
iperparametri	OpenAI.FineTuneSupervisedHyperparameters	Iperparametri usati per il processo di ottimizzazione.	No

OpenAI.FineTuningIntegration

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di integrazione abilitata per il processo di ottimizzazione Valori possibili: wandb	Sì
wandb	OpenAI.FineTuningIntegrationWandb		Sì
└─ Entità	stringa (nullabile)		No
└> nome	stringa (nullabile)		No
└─ progetto	string		Sì
└* tag	matrice di valori string		No

OpenAI.FineTuningIntegrationWandb

Name	Type	Description	Obbligatorio	Predefinito
entità	stringa (nullabile)		No
nome	stringa (nullabile)		No
project	string		Sì
tags	matrice di valori string		No

OpenAI.FineTuningJob

L'oggetto fine_tuning.job rappresenta un processo di ottimizzazione che è stato creato tramite l'API.

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Timestamp Unix (in secondi) per il momento in cui è stato creato il processo di ottimizzazione.	Sì
error	OpenAI.FineTuningJobError (nullabile)		Sì
└─ codice	string		Sì
└* messaggio	string		Sì
└* param	stringa (nullabile)		Sì
completamento stimato	integer		No
modello ottimizzato	stringa (nullabile)		Sì
terminato_il	integer		Sì
iperparametri	OpenAI.FineTuningJobHyperparameters		Sì
└batch_size	string o OpenAI.integer		No	auto
└learning_rate_multiplier	string o OpenAI.numeric		No
└n_epochs	string o OpenAI.integer		No	auto
id	string	Identificatore dell'oggetto a cui è possibile fare riferimento negli endpoint API.	Sì
integrazioni	matrice di OpenAI.FineTuningIntegration		No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
method	OpenAI.FineTuneMethod	Metodo utilizzato per l'ottimizzazione.	No
model	string	Modello di base ottimizzato.	Sì
object	enum	Tipo di oggetto, che è sempre "fine_tuning.job". Valori possibili: fine_tuning.job	Sì
organization_id	string	Organizzazione proprietaria del processo di ottimizzazione.	Sì
file_di_risultato	matrice di valori string	ID file di risultati compilati per il processo di ottimizzazione. È possibile recuperare i risultati con l'API Files.	Sì
seed	OpenAI.integer		Sì
Stato	enum	Stato corrente del processo di ottimizzazione, che può essere validating_files, queuedrunningsucceededfailedo .cancelled Valori possibili: validating_files, queuedrunning, succeeded, , failedcancelled	Sì
trained_tokens	OpenAI.integer (nullabile)		Sì
file di allenamento	string	ID file utilizzato per il training. È possibile recuperare i dati di training con l'API Files.	Sì
file_di_validazione	stringa (nullabile)		Sì

OpenAI.FineTuningJobCheckpoint

L'oggetto fine_tuning.job.checkpoint rappresenta un checkpoint del modello per un processo di ottimizzazione pronto per l'uso.

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Il timestamp Unix (in secondi) indica quando il checkpoint è stato creato.	Sì
punto_di_controllo_modello_ottimizzato	string	Nome del modello di checkpoint ottimizzato creato.	Sì
id_lavoro_affinamento	string	Nome del processo di ottimizzazione da cui è stato creato il checkpoint.	Sì
id	string	Identificatore del checkpoint, a cui è possibile fare riferimento negli endpoint API.	Sì
metrics	OpenAI.FineTuningJobCheckpointMetrics		Sì
└full_valid_loss	OpenAI.numeric		No
└full_valid_mean_token_accuracy	OpenAI.numeric		No
└* passaggio	OpenAI.numeric		No
└train_loss	OpenAI.numeric		No
└train_mean_token_accuracy	OpenAI.numeric		No
└valid_loss	OpenAI.numeric		No
└valid_mean_token_accuracy	OpenAI.numeric		No
object	enum	Tipo di oggetto, che è sempre "fine_tuning.job.checkpoint". Valori possibili: fine_tuning.job.checkpoint	Sì
numero_passaggio	OpenAI.integer		Sì

OpenAI.FineTuningJobCheckpointMetrics

Name	Type	Description	Obbligatorio	Predefinito
full_valid_loss	OpenAI.numeric		No
full_valid_mean_token_accuracy	OpenAI.numeric		No
passo	OpenAI.numeric		No
train_loss	OpenAI.numeric		No
train_mean_token_accuracy	OpenAI.numeric		No
valid_loss	OpenAI.numeric		No
valid_mean_token_accuracy	OpenAI.numeric		No

OpenAI.FineTuningJobError

Name	Type	Description	Obbligatorio	Predefinito
codice	string		Sì
message	string		Sì
param	stringa (nullabile)		Sì

OpenAI.FineTuningJobEvent

Oggetto evento processo di ottimizzazione

Name	Type	Description	Obbligatorio	Predefinito
creato_il	integer	Timestamp Unix (in secondi) per il momento in cui è stato creato il processo di ottimizzazione.	Sì
data	OpenAI.FineTuningJobEventData		No
id	string	Identificatore dell'oggetto.	Sì
level	enum	Livello di log dell'evento. Valori possibili: info, warn, error	Sì
message	string	Messaggio dell'evento.	Sì
object	enum	Tipo di oggetto, che è sempre "fine_tuning.job.event". Valori possibili: fine_tuning.job.event	Sì
type	enum	Il tipo di evento. Valori possibili: message, metrics	No

OpenAI.FineTuningJobEventData

Tipo: oggetto

OpenAI.FineTuningJobHyperparameters

Name	Type	Description	Obbligatorio	Predefinito
dimensione del batch	string o OpenAI.integer		No
moltiplicatore_tasso_apprendimento	string o OpenAI.numeric		No
numero di epoche	string o OpenAI.integer		No

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

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa (nullabile)		No
file_url	string	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ì

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Un'immagine come input per il modello. Informazioni sugli input delle immagini.

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

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

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ì

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

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
nome	string	Nome della funzione che deve essere chiamata. Devono essere dalla a-z, dalla A-Z, da 0 a 9, oppure contenere sottolineamenti e trattini, con una lunghezza massima di 64.	Sì
parameters	OpenAI.FunctionParameters	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema. Consulta la guide per esempi e il riferimento JSON Schema per la documentazione sul formato. Omettere parameters definisce una funzione con una lista di parametri vuota.	No
rigido	booleano (nullable)		No

OpenAI.FunctionParameters

I parametri che le funzioni accettano, descritti come un oggetto JSON Schema. Consulta la guide per esempi e il riferimento JSON Schema per la documentazione sul formato. Omettere parameters definisce una funzione con una lista di parametri vuota.

Tipo: oggetto

OpenAI.FunctionShellAction

Eseguire un comando shell.

Name	Type	Description	Obbligatorio	Predefinito
commands	matrice di valori string		Sì
max_output_length	OpenAI.integer (nullabile)		Sì
timeout_ms	OpenAI.integer (nullabile)		Sì

OpenAI.FunctionShellActionParam

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

Name	Type	Description	Obbligatorio	Predefinito
commands	matrice di valori string	Comandi della shell ordinati per l'esecuzione dell'ambiente di esecuzione.	Sì
max_output_length	OpenAI.integer (nullabile)		No
timeout_ms	OpenAI.integer (nullabile)		No

OpenAI.FunctionShellCallItemStatus

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

Proprietà	Value
Type	string
Valori	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

Contenuto di un output di chiamata dello strumento shell generato.

Name	Type	Description	Obbligatorio	Predefinito
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

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

Name	Type	Description	Obbligatorio	Predefinito
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

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

Name	Type	Description	Obbligatorio	Predefinito
exit_code	OpenAI.integer		Sì
type	enum	Tipo di risultato. Sempre exit. Valori possibili: exit	Sì

OpenAI.FunctionShellCallOutputExitOutcomeParam

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

Name	Type	Description	Obbligatorio	Predefinito
exit_code	OpenAI.integer		Sì
type	enum	Tipo di risultato. Sempre exit. Valori possibili: exit	Sì

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.

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

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ì

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

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ì

OpenAI.FunctionShellToolParam

Strumento che consente al modello di eseguire comandi della shell.

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

OpenAI.FunctionTool

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

Name	Type	Description	Obbligatorio	Predefinito
descrizione	stringa (nullabile)		No
nome	string	Il nome della funzione da chiamare.	Sì
parameters	oggetto (nullable)		Sì
rigido	booleano (nullable)		Sì
type	enum	Tipo di strumento funzionale. Sempre function. Valori possibili: function	Sì

OpenAI.GraderLabelModel

Oggetto LabelModelGrader che usa un modello per assegnare etichette a ogni elemento della valutazione.

Name	Type	Description	Obbligatorio	Predefinito
input	matrice di OpenAI.EvalItem		Sì
labels	matrice di valori string	Etichette da assegnare a ogni elemento della valutazione.	Sì
model	string	Modello da utilizzare per la valutazione. Deve supportare output strutturati.	Sì
nome	string	Nome del grader.	Sì
etichette_di_passaggio	matrice di valori string	Le etichette che indicano un risultato positivo. Deve essere un sottoinsieme di etichette.	Sì
type	enum	Tipo di oggetto, che è sempre label_model. Valori possibili: label_model	Sì

OpenAI.GraderMulti

Un oggetto MultiGrader combina l'output di più classificatori per produrre un singolo punteggio.

Name	Type	Description	Obbligatorio	Predefinito
calculate_output	string	Formula per calcolare l'output in base ai risultati del grader.	Sì
Livellatrici	OpenAI.GraderStringCheck o OpenAI.GraderTextSimilarity o OpenAI.GraderPython o OpenAI.GraderScoreModel o OpenAI.GraderLabelModel		Sì
nome	string	Nome del grader.	Sì
type	enum	Tipo di oggetto, che è sempre multi. Valori possibili: multi	Sì

OpenAI.GraderPython

Oggetto PythonGrader che esegue uno script Python nell'input.

Name	Type	Description	Obbligatorio	Predefinito
image_tag	string	Tag immagine da usare per lo script Python.	No
nome	string	Nome del grader.	Sì
source	string	Codice sorgente dello script Python.	Sì
type	enum	Tipo di oggetto, che è sempre python. Valori possibili: python	Sì

OpenAI.GraderScoreModel

Oggetto ScoreModelGrader che usa un modello per assegnare un punteggio all'input.

Name	Type	Description	Obbligatorio	Predefinito
input	matrice di OpenAI.EvalItem	Messaggi di input valutati dal classificatore. Supporta blocchi di testo, testo di output, immagine di input e contenuto audio di input e può includere stringhe modello.	Sì
model	string	Modello da utilizzare per la valutazione.	Sì
nome	string	Nome del grader.	Sì
range	matrice di OpenAI.numeric	La gamma del punteggio. Di default è [0, 1].	No
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		No
└max_completions_tokens	OpenAI.integer (nullabile)		No
└reasoning_effort	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
└* seed	OpenAI.integer (nullabile)		No
└* temperatura	OpenAI.numeric (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
type	enum	Tipo di oggetto, che è sempre score_model. Valori possibili: score_model	Sì

OpenAI.GraderStringCheck

Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata.

Name	Type	Description	Obbligatorio	Predefinito
input	string	Il testo di input. Ciò può includere stringhe di modello.	Sì
nome	string	Nome del grader.	Sì
operazione	enum	Operazione di controllo della stringa da eseguire. Uno di eq, ne, likeo ilike. Valori possibili: eq, ne, like, ilike	Sì
riferimento	string	Testo di riferimento. Ciò può includere stringhe di modello.	Sì
type	enum	Tipo di oggetto, che è sempre string_check. Valori possibili: string_check	Sì

OpenAI.GraderTextSimilarity

Oggetto TextSimilarityGrader che assegna un grado al testo in base alle metriche di somiglianza.

Name	Type	Description	Obbligatorio	Predefinito
metrica di valutazione	enum	Metrica di valutazione da usare. Uno di cosine, fuzzy_match, bleu, , gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valori possibili: cosine, fuzzy_matchbleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l	Sì
input	string	Il testo in valutazione.	Sì
nome	string	Nome del grader.	Sì
riferimento	string	Testo che viene valutato.	Sì
type	enum	Tipo di grader. Valori possibili: text_similarity	Sì

OpenAI.GrammarSyntax1

Proprietà	Value
Type	string
Valori	lark regex

OpenAI.HybridSearchOptions

Name	Type	Description	Obbligatorio	Predefinito
embedding_weight	OpenAI.numeric		Sì
text_weight	OpenAI.numeric		Sì

OpenAI.ImageDetail

Proprietà	Value
Type	string
Valori	low high auto

OpenAI.ImageGenTool

Strumento che genera immagini usando i modelli di immagine GPT.

Modelli validi:

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

Name	Type	Description	Obbligatorio	Predefinito
sfondo	enum	Tipo di sfondo per l'immagine generata. Uno di transparent, opaque, o auto. Impostazione predefinita: auto. Valori possibili: transparent, opaque, auto	No
fedeltà dell'input	OpenAI.InputFidelity (nullabile)	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. Non supportato per gpt-image-1-mini. Supporti high e low. Di default è low.	No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└ file_id	string		No
└ image_url	string		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
Compressione dell'output	OpenAI.integer		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
immagini parziali	OpenAI.integer		No
qualità	enum	Qualità dell'immagine generata. Uno di low, medium, high, , o auto. Impostazione predefinita: auto. Valori possibili: low, medium, high, auto	No
size	enum	Dimensioni dell'immagine generata. Uno di 1024x1024, 1024x1536, 1536x1024, o auto. Impostazione predefinita: auto. Valori possibili: 1024x1024, 1024x1536, 1536x1024, auto	No
type	enum	Tipo dello strumento di generazione di immagini. Sempre image_generation. Valori possibili: image_generation	Sì

OpenAI.ImageGenToolInputImageMask

Name	Type	Description	Obbligatorio	Predefinito
ID del file	string		No
image_url	string		No

OpenAI.IncludeEnum

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

• 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.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). | | Tipo | 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
memory_search_call.results |

OpenAI.InputAudio

Input audio per il modello.

Name	Type	Description	Obbligatorio	Predefinito
input_audio	OpenAI.InputAudioInputAudio		Sì
type	enum	Tipo dell'elemento di input. Sempre input_audio. Valori possibili: input_audio	Sì

OpenAI.InputAudioInputAudio

Name	Type	Description	Obbligatorio	Predefinito
data	string		Sì
format	enum	Valori possibili: mp3, wav	Sì

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

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa (nullabile)		No
file_url	string	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ì

OpenAI.InputContentInputImageContent

Un'immagine come input per il modello. Informazioni sugli input delle immagini.

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

OpenAI.InputContentInputTextContent

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ì

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. Non supportato per gpt-image-1-mini. Supporti high e low. Di default è low.

Proprietà	Value
Type	string
Valori	high low

OpenAI.InputFileContent

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa (nullabile)		No
file_url	string	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ì

OpenAI.InputFileContentParam

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
file_data	stringa (nullabile)		No
ID del file	stringa (nullabile)		No
file_url	string		No
filename	stringa (nullabile)		No
type	enum	Tipo dell'elemento di input. Sempre input_file. Valori possibili: input_file	Sì

OpenAI.InputImageContent

Un'immagine come input per il modello. Informazioni sugli input delle immagini.

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

OpenAI.InputImageContentParamAutoParam

Un'immagine come input per il modello. Informazioni sugli input delle immagini

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

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

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.InputItemType		Sì

OpenAI.InputItemApplyPatchToolCallItemParam

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 (nullabile)		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ì

OpenAI.InputItemApplyPatchToolCallOutputItemParam

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 (nullabile)		No
output	stringa (nullabile)		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ì

OpenAI.InputItemCodeInterpreterToolCall

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa (nullabile)		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		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ì

OpenAI.InputItemCompactionSummaryItemParam

Elemento di compattazione generato dall'APIv1/responses/compact.

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

OpenAI.InputItemComputerCallOutputItemParam

Output di una chiamata allo strumento del computer.

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

OpenAI.InputItemComputerToolCall

Chiamata di uno strumento a uno strumento per l'uso del computer. Per altre informazioni, vedere la guida all'uso del computer .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		Sì
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ì

OpenAI.InputItemCustomToolCall

Chiamata a uno strumento personalizzato creato dal modello.

Name	Type	Description	Obbligatorio	Predefinito
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ì
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre custom_tool_call. Valori possibili: custom_tool_call	Sì

OpenAI.InputItemCustomToolCallOutput

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

Name	Type	Description	Obbligatorio	Predefinito
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

Risultati di una chiamata allo strumento di ricerca file. Per altre informazioni, vedere la guida alla ricerca di file .

Name	Type	Description	Obbligatorio	Predefinito
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		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

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 (nullabile)		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 (nullabile)		No
type	enum	Tipo di output della chiamata dello strumento di funzione. Sempre function_call_output. Valori possibili: function_call_output	Sì

OpenAI.InputItemFunctionShellCallItemParam

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	OpenAI.integer (nullabile)		No
└timeout_ms	OpenAI.integer (nullabile)		No
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa (nullabile)		No
Stato	OpenAI.FunctionShellCallItemStatus (nullabile)	Valori di stato segnalati per le chiamate degli strumenti della shell.	No
type	enum	Tipo dell'elemento. Sempre shell_call. Valori possibili: shell_call	Sì

OpenAI.InputItemFunctionShellCallOutputItemParam

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 (nullabile)		No
max_output_length	OpenAI.integer (nullabile)		No
output	matrice di OpenAI.FunctionShellCallOutputContentParam	Blocchi acquisiti di output stdout e stderr, insieme ai risultati associati.	Sì
type	enum	Tipo dell'elemento. Sempre shell_call_output. Valori possibili: shell_call_output	Sì

OpenAI.InputItemFunctionToolCall

Chiamata di uno strumento per eseguire una funzione. Per altre informazioni, vedere la guida alla chiamata di funzione .

Name	Type	Description	Obbligatorio	Predefinito
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	ID univoco della chiamata dello strumento di funzione.	No
nome	string	Nome della funzione da eseguire.	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 chiamata dello strumento di funzione. Sempre function_call. Valori possibili: function_call	Sì

OpenAI.InputItemImageGenToolCall

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa (nullabile)		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 dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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	enum	Valori possibili: in_progress, completed, incomplete	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 umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio	Predefinito
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 a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio	Predefinito
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 (nullabile)		No
reason	stringa (nullabile)		No
type	enum	Tipo dell'elemento. Sempre mcp_approval_response. Valori possibili: mcp_approval_response	Sì

OpenAI.InputItemMcpListTools

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
error	stringa (nullabile)		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 di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
approval_request_id	stringa (nullabile)		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	stringa (nullabile)		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa (nullabile)		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 output del modello.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
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

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	Predefinito
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa (nullabile)		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	matrice di OpenAI.Summary	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre reasoning. Valori possibili: reasoning	Sì

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

OpenAI.InputItemWebSearchToolCall

Risultati di una chiamata allo strumento di ricerca Web. Per altre informazioni, vedere la guida alla ricerca Web .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include informazioni dettagliate sul modo in cui il modello ha usato il Web (ricerca, open_page, ricerca).	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.InputMessage

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.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	OpenAI.InputMessageContentList	Elenco di uno o più elementi di input per il modello, contenente contenuto diverso types.	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ì

OpenAI.InputMessageContentList

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

Matrice di: OpenAI.InputContent

OpenAI.InputMessageResource

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

OpenAI.InputParam

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

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

Tipo: stringa o matrice di OpenAI.InputItem

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

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

OpenAI.InputTextContent

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ì

OpenAI.InputTextContentParam

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ì

OpenAI.Item

Elemento di contenuto usato per generare una risposta.

Discriminatorio per OpenAI.Item

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

Valore del tipo	Schema
memory_search_call	MemorySearchToolCallItemParam
message	OpenAI.InputMessage
output_message	OpenAI.ItemOutputMessage
file_search_call	OpenAI.ItemFileSearchToolCall
computer_call	OpenAI.ItemComputerToolCall
computer_call_output	OpenAI.ItemComputerCallOutputItemParam
web_search_call	OpenAI.ItemWebSearchToolCall
function_call	OpenAI.ItemFunctionToolCall
function_call_output	OpenAI.ItemFunctionCallOutputItemParam
reasoning	OpenAI.ItemReasoningItem
compaction	OpenAI.ItemCompactionSummaryItemParam
image_generation_call	OpenAI.ItemImageGenToolCall
code_interpreter_call	OpenAI.ItemCodeInterpreterToolCall
local_shell_call	OpenAI.ItemLocalShellToolCall
local_shell_call_output	OpenAI.ItemLocalShellToolCallOutput
shell_call	OpenAI.ItemFunctionShellCallItemParam
shell_call_output	OpenAI.ItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.ItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.ItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.ItemMcpListTools
mcp_approval_request	OpenAI.ItemMcpApprovalRequest
mcp_approval_response	OpenAI.ItemMcpApprovalResponse
mcp_call	OpenAI.ItemMcpToolCall
custom_tool_call_output	OpenAI.ItemCustomToolCallOutput
custom_tool_call	OpenAI.ItemCustomToolCall

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ItemType		Sì

OpenAI.ItemApplyPatchToolCallItemParam

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 (nullabile)		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ì

OpenAI.ItemApplyPatchToolCallOutputItemParam

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 (nullabile)		No
output	stringa (nullabile)		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ì

OpenAI.ItemCodeInterpreterToolCall

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa (nullabile)		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		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ì

OpenAI.ItemCompactionSummaryItemParam

Elemento di compattazione generato dall'APIv1/responses/compact.

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

OpenAI.ItemComputerCallOutputItemParam

Output di una chiamata allo strumento del computer.

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

OpenAI.ItemComputerToolCall

Chiamata di uno strumento a uno strumento per l'uso del computer. Per altre informazioni, vedere la guida all'uso del computer .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		Sì
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ì

OpenAI.ItemCustomToolCall

Chiamata a uno strumento personalizzato creato dal modello.

Name	Type	Description	Obbligatorio	Predefinito
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ì
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre custom_tool_call. Valori possibili: custom_tool_call	Sì

OpenAI.ItemCustomToolCallOutput

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

Name	Type	Description	Obbligatorio	Predefinito
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.ItemFileSearchToolCall

Risultati di una chiamata allo strumento di ricerca file. Per altre informazioni, vedere la guida alla ricerca di file .

Name	Type	Description	Obbligatorio	Predefinito
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		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.ItemFunctionCallOutputItemParam

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 (nullabile)		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 (nullabile)		No
type	enum	Tipo di output della chiamata dello strumento di funzione. Sempre function_call_output. Valori possibili: function_call_output	Sì

OpenAI.ItemFunctionShellCallItemParam

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	OpenAI.integer (nullabile)		No
└timeout_ms	OpenAI.integer (nullabile)		No
call_id	string	ID univoco della chiamata dello strumento shell generata dal modello. Vincoli: minLength: 1, maxLength: 64	Sì
id	stringa (nullabile)		No
Stato	OpenAI.FunctionShellCallItemStatus (nullabile)	Valori di stato segnalati per le chiamate degli strumenti della shell.	No
type	enum	Tipo dell'elemento. Sempre shell_call. Valori possibili: shell_call	Sì

OpenAI.ItemFunctionShellCallOutputItemParam

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 (nullabile)		No
max_output_length	OpenAI.integer (nullabile)		No
output	matrice di OpenAI.FunctionShellCallOutputContentParam	Blocchi acquisiti di output stdout e stderr, insieme ai risultati associati.	Sì
type	enum	Tipo dell'elemento. Sempre shell_call_output. Valori possibili: shell_call_output	Sì

OpenAI.ItemFunctionToolCall

Chiamata di uno strumento per eseguire una funzione. Per altre informazioni, vedere la guida alla chiamata di funzione .

Name	Type	Description	Obbligatorio	Predefinito
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	ID univoco della chiamata dello strumento di funzione.	No
nome	string	Nome della funzione da eseguire.	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 chiamata dello strumento di funzione. Sempre function_call. Valori possibili: function_call	Sì

OpenAI.ItemImageGenToolCall

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa (nullabile)		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.ItemLocalShellToolCall

Chiamata dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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.ItemLocalShellToolCallOutput

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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	enum	Valori possibili: in_progress, completed, incomplete	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.ItemMcpApprovalRequest

Richiesta di approvazione umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio	Predefinito
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.ItemMcpApprovalResponse

Risposta a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio	Predefinito
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 (nullabile)		No
reason	stringa (nullabile)		No
type	enum	Tipo dell'elemento. Sempre mcp_approval_response. Valori possibili: mcp_approval_response	Sì

OpenAI.ItemMcpListTools

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
error	stringa (nullabile)		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.ItemMcpToolCall

Chiamata di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
approval_request_id	stringa (nullabile)		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	stringa (nullabile)		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa (nullabile)		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.ItemOutputMessage

Messaggio di output del modello.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
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.ItemReasoningItem

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	Predefinito
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa (nullabile)		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	matrice di OpenAI.Summary	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre reasoning. Valori possibili: reasoning	Sì

OpenAI.ItemReferenceParam

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ì

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.InputMessageResource
output_message	OpenAI.ItemResourceOutputMessage
file_search_call	OpenAI.ItemResourceFileSearchToolCall
computer_call	OpenAI.ItemResourceComputerToolCall
computer_call_output	OpenAI.ItemResourceComputerToolCallOutputResource
web_search_call	OpenAI.ItemResourceWebSearchToolCall
function_call	OpenAI.ItemResourceFunctionToolCallResource
function_call_output	OpenAI.ItemResourceFunctionToolCallOutputResource
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

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ItemResourceType		Sì

OpenAI.ItemResourceApplyPatchToolCall

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ì

OpenAI.ItemResourceApplyPatchToolCallOutput

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 (nullabile)		No
Stato	OpenAI.ApplyPatchCallOutputStatus		Sì
type	enum	Tipo dell'elemento. Sempre apply_patch_call_output. Valori possibili: apply_patch_call_output	Sì

OpenAI.ItemResourceCodeInterpreterToolCall

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
codice	stringa (nullabile)		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		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ì

OpenAI.ItemResourceComputerToolCall

Chiamata di uno strumento a uno strumento per l'uso del computer. Per altre informazioni, vedere la guida all'uso del computer .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		Sì
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ì

OpenAI.ItemResourceComputerToolCallOutputResource

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	ID dell'output della chiamata dello strumento computer.	No
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ì

OpenAI.ItemResourceFileSearchToolCall

Risultati di una chiamata allo strumento di ricerca file. Per altre informazioni, vedere la guida alla ricerca di file .

Name	Type	Description	Obbligatorio	Predefinito
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		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 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	OpenAI.integer (nullabile)		Sì
└timeout_ms	OpenAI.integer (nullabile)		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
id	string	ID univoco della chiamata dello strumento shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
Stato	OpenAI.LocalShellCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre shell_call. Valori possibili: shell_call	Sì

OpenAI.ItemResourceFunctionShellCallOutput

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	OpenAI.integer (nullabile)		Sì
output	matrice di OpenAI.FunctionShellCallOutputContent	Matrice di contenuti di output delle chiamate shell	Sì
type	enum	Tipo dell'output delle chiamate della shell. Sempre shell_call_output. Valori possibili: shell_call_output	Sì

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Type	Description	Obbligatorio	Predefinito
call_id	string	ID univoco della chiamata dello strumento di funzione generata dal modello.	Sì
id	string	ID univoco dell'output della chiamata dello strumento di funzione. Popolato quando questo elemento viene restituito tramite l'API.	No
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.ItemResourceFunctionToolCallResource

Name	Type	Description	Obbligatorio	Predefinito
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	ID univoco della chiamata dello strumento di funzione.	No
nome	string	Nome della funzione da eseguire.	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 chiamata dello strumento di funzione. Sempre function_call. Valori possibili: function_call	Sì

OpenAI.ItemResourceImageGenToolCall

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio	Predefinito
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
result	stringa (nullabile)		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.ItemResourceLocalShellToolCall

Chiamata dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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

Output di una chiamata allo strumento shell locale.

Name	Type	Description	Obbligatorio	Predefinito
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	enum	Valori possibili: in_progress, completed, incomplete	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 umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio	Predefinito
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 a una richiesta di approvazione MCP.

Name	Type	Description	Obbligatorio	Predefinito
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 (nullabile)		No
type	enum	Tipo dell'elemento. Sempre mcp_approval_response. Valori possibili: mcp_approval_response	Sì

OpenAI.ItemResourceMcpListTools

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
error	stringa (nullabile)		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 di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
approval_request_id	stringa (nullabile)		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	stringa (nullabile)		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa (nullabile)		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 output del modello.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
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.ItemResourceType

Proprietà	Value
Type	string
Valori	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_output 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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemResourceWebSearchToolCall

Risultati di una chiamata allo strumento di ricerca Web. Per altre informazioni, vedere la guida alla ricerca Web .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include informazioni dettagliate sul modo in cui il modello ha usato il Web (ricerca, open_page, ricerca).	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.ItemType

Proprietà	Value
Type	string
Valori	message output_message file_search_call computer_call computer_call_output web_search_call function_call function_call_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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

Risultati di una chiamata allo strumento di ricerca Web. Per altre informazioni, vedere la guida alla ricerca Web .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include informazioni dettagliate sul modo in cui il modello ha usato il Web (ricerca, open_page, ricerca).	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

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ì

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Type	Description	Obbligatorio	Predefinito
data	matrice di OpenAI.FineTuningJobCheckpoint		Sì
first_id	stringa (nullabile)		No
ha_di_piu	boolean		Sì
last_id	stringa (nullabile)		No
object	enum	Valori possibili: list	Sì

OpenAI.ListFineTuningJobEventsResponse

Name	Type	Description	Obbligatorio	Predefinito
data	matrice di OpenAI.FineTuningJobEvent		Sì
ha_di_piu	boolean		Sì
object	enum	Valori possibili: list	Sì

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Type	Description	Obbligatorio	Predefinito
data	matrice di OpenAI.FineTuningJob		Sì
ha_di_piu	boolean		Sì
object	enum	Valori possibili: list	Sì

OpenAI.LocalShellCallStatus

Proprietà	Value
Type	string
Valori	in_progress completed incomplete

OpenAI.LocalShellExecAction

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	OpenAI.integer (nullabile)		No
type	enum	Tipo dell'azione della shell locale. Sempre exec. Valori possibili: exec	Sì
user	stringa (nullabile)		No
working_directory	stringa (nullabile)		No

OpenAI.LocalShellToolParam

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ì

OpenAI.LogProb

Probabilità del log di un token.

Name	Type	Description	Obbligatorio	Predefinito
bytes	matrice di OpenAI.integer		Sì
logprob	OpenAI.numeric		Sì
token	string		Sì
top_logprobs	matrice di OpenAI.TopLogProb		Sì

OpenAI.MCPListToolsTool

Strumento disponibile in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
annotations	OpenAI.MCPListToolsToolAnnotations (nullabile)		No
descrizione	stringa (nullabile)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Sì
nome	string	Nome dello strumento.	Sì

OpenAI.MCPListToolsToolAnnotations

Tipo: oggetto

OpenAI.MCPListToolsToolInputSchema

Tipo: oggetto

OpenAI.MCPTool

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

Name	Type	Description	Obbligatorio	Predefinito
strumenti consentiti	matrice di stringhe o OpenAI.MCPToolFilter		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 connettori qui. 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
headers	oggetto (nullable)		No
project_connection_id	string	ID di connessione nel project per il server MCP. La connessione memorizza l'autenticazione e altri dettagli di connessione necessari per connettersi al server MCP.	No
richiedere_approvazione	oggetto (vedere modelli validi di seguito)		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	string	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

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
summary_text	OpenAI.SummaryTextContent
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

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.MessageContentType		Sì

OpenAI.MessageContentInputFileContent

Un file di input per il modello.

Name	Type	Description	Obbligatorio	Predefinito
file_data	string	Contenuto del file da inviare al modello.	No
ID del file	stringa (nullabile)		No
file_url	string	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ì

OpenAI.MessageContentInputImageContent

Un'immagine come input per il modello. Informazioni sugli input delle immagini.

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

OpenAI.MessageContentInputTextContent

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ì

OpenAI.MessageContentOutputTextContent

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		No
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ì

OpenAI.MessageContentReasoningTextContent

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ì

OpenAI.MessageContentRefusalContent

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ì

OpenAI.MessageContentType

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

OpenAI.MessageRole

Proprietà	Value
Type	string
Valori	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Proprietà	Value
Type	string
Valori	in_progress completed incomplete

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

ID modello usato per generare la risposta, ad esempio gpt-5 o o3. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, caratteristiche delle prestazioni e punti di prezzo. Fare riferimento alla guida del modello per esplorare e confrontare i modelli disponibili.

Tipo: OpenAI.ModelIdsResponses o stringa

ID modello usato per generare la risposta, ad esempio gpt-5 o o3. OpenAI offre un'ampia gamma di modelli con diverse funzionalità, caratteristiche delle prestazioni e punti di prezzo. Fare riferimento alla guida del modello per esplorare e confrontare i modelli disponibili.

OpenAI.ModelIdsResponses

Proprietà	Value
Type	string
Valori	o1-pro o1-pro-2025-03-19 o3-pro o3-pro-2025-06-10 o3-deep-research o3-deep-research-2025-06-26 o4-mini-deep-research o4-mini-deep-research-2025-06-26 computer-use-preview computer-use-preview-2025-03-11 gpt-5-codex gpt-5-pro gpt-5-pro-2025-10-06 gpt-5.1-codex-max

OpenAI.ModelIdsShared

Tipo: string o OpenAI.ChatModel

OpenAI.Move

Azione di spostamento del mouse.

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Specifica il tipo di evento. Per un'azione di spostamento, questa proprietà è sempre impostato su move. Valori possibili: move	Sì
x	OpenAI.integer		Sì
y	OpenAI.integer		Sì

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

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		No
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ì

OpenAI.OutputContentReasoningTextContent

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ì

OpenAI.OutputContentRefusalContent

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ì

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
structured_outputs	StructuredOutputsOutputItem
workflow_action	WorkflowActionOutputItem
oauth_consent_request	OAuthConsentRequestOutputItem
memory_search_call	MemorySearchToolCallItemResource
output_message	OpenAI.OutputItemOutputMessage
file_search_call	OpenAI.OutputItemFileSearchToolCall
function_call	OpenAI.OutputItemFunctionToolCall
web_search_call	OpenAI.OutputItemWebSearchToolCall
computer_call	OpenAI.OutputItemComputerToolCall
reasoning	OpenAI.OutputItemReasoningItem
compaction	OpenAI.OutputItemCompactionBody
image_generation_call	OpenAI.OutputItemImageGenToolCall
code_interpreter_call	OpenAI.OutputItemCodeInterpreterToolCall
local_shell_call	OpenAI.OutputItemLocalShellToolCall
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
custom_tool_call	OpenAI.OutputItemCustomToolCall

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
type	OpenAI.OutputItemType		Sì

OpenAI.OutputItemApplyPatchToolCall

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

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
Stato	OpenAI.ApplyPatchCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre apply_patch_call. Valori possibili: apply_patch_call	Sì

OpenAI.OutputItemApplyPatchToolCallOutput

Output generato da una chiamata di applicazione dello strumento patch.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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 (nullabile)		No
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
Stato	OpenAI.ApplyPatchCallOutputStatus		Sì
type	enum	Tipo dell'elemento. Sempre apply_patch_call_output. Valori possibili: apply_patch_call_output	Sì

OpenAI.OutputItemCodeInterpreterToolCall

Chiamata dello strumento per eseguire il codice.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
codice	stringa (nullabile)		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		Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
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ì

OpenAI.OutputItemCompactionBody

Elemento di compattazione generato dall'APIv1/responses/compact.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
type	enum	Tipo dell'elemento. Sempre compaction. Valori possibili: compaction	Sì

OpenAI.OutputItemComputerToolCall

Chiamata di uno strumento a uno strumento per l'uso del computer. Per altre informazioni, vedere la guida all'uso del computer .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.ComputerAction		Sì
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	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	Sì
type	enum	Tipo di chiamata al computer. Sempre computer_call. Valori possibili: computer_call	Sì

OpenAI.OutputItemCustomToolCall

Chiamata a uno strumento personalizzato creato dal modello.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
type	enum	Tipo di chiamata allo strumento personalizzato. Sempre custom_tool_call. Valori possibili: custom_tool_call	Sì

OpenAI.OutputItemFileSearchToolCall

Risultati di una chiamata allo strumento di ricerca file. Per altre informazioni, vedere la guida alla ricerca di file .

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
results	matrice di OpenAI.FileSearchToolCallResults		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 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	OpenAI.integer (nullabile)		Sì
└timeout_ms	OpenAI.integer (nullabile)		Sì
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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
id	string	ID univoco della chiamata dello strumento shell. Viene popolato quando questo elemento è restituito tramite API.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
Stato	OpenAI.LocalShellCallStatus		Sì
type	enum	Tipo dell'elemento. Sempre shell_call. Valori possibili: shell_call	Sì

OpenAI.OutputItemFunctionShellCallOutput

Output di una chiamata dello strumento shell generata.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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	OpenAI.integer (nullabile)		Sì
output	matrice di OpenAI.FunctionShellCallOutputContent	Matrice di contenuti di output delle chiamate shell	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
type	enum	Tipo dell'output delle chiamate della shell. Sempre shell_call_output. Valori possibili: shell_call_output	Sì

OpenAI.OutputItemFunctionToolCall

Chiamata di uno strumento per eseguire una funzione. Per altre informazioni, vedere la guida alla chiamata di funzione .

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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	ID univoco della chiamata dello strumento di funzione.	No
nome	string	Nome della funzione da eseguire.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	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.OutputItemImageGenToolCall

Richiesta di generazione di immagini effettuata dal modello.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
id	string	ID univoco della chiamata di generazione dell'immagine.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
result	stringa (nullabile)		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 dello strumento per eseguire un comando nella shell locale.

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.LocalShellExecAction	Eseguire un comando shell nel server.	Sì
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
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.OutputItemMcpApprovalRequest

Richiesta di approvazione umana di una chiamata a uno strumento.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
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ì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
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.OutputItemMcpListTools

Elenco di strumenti disponibili in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
error	stringa (nullabile)		No
id	string	ID univoco dell'elenco.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
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 di uno strumento in un server MCP.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
approval_request_id	stringa (nullabile)		No
arguments	string	Stringa JSON degli argomenti passati allo strumento.	Sì
error	stringa (nullabile)		No
id	string	ID univoco della chiamata allo strumento.	Sì
nome	string	Nome dello strumento eseguito.	Sì
output	stringa (nullabile)		No
response_id	string	Risposta in base alla quale viene creato l'elemento.	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 output del modello.

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
contenuto	matrice di OpenAI.OutputMessageContent	Contenuto del messaggio di output.	Sì
id	string	ID univoco del messaggio di output.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	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

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	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
contenuto	matrice di OpenAI.ReasoningTextContent	Ragionamento del contenuto del testo.	No
encrypted_content	stringa (nullabile)		No
id	string	Identificatore univoco del contenuto di ragionamento.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	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
summary	matrice di OpenAI.Summary	Ragionamento del contenuto di riepilogo.	Sì
type	enum	Tipo dell'oggetto . Sempre reasoning. Valori possibili: reasoning	Sì

OpenAI.OutputItemType

Proprietà	Value
Type	string
Valori	output_message file_search_call function_call web_search_call computer_call reasoning compaction image_generation_call code_interpreter_call local_shell_call shell_call shell_call_output apply_patch_call apply_patch_call_output mcp_call mcp_list_tools mcp_approval_request custom_tool_call structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.OutputItemWebSearchToolCall

Risultati di una chiamata allo strumento di ricerca Web. Per altre informazioni, vedere la guida alla ricerca Web .

Name	Type	Description	Obbligatorio	Predefinito
action	OpenAI.WebSearchActionSearch o OpenAI.WebSearchActionOpenPage o OpenAI.WebSearchActionFind	Oggetto che descrive l'azione specifica eseguita in questa chiamata di ricerca Web. Include informazioni dettagliate sul modo in cui il modello ha usato il Web (ricerca, open_page, ricerca).	Sì
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
id	string	ID univoco della chiamata dello strumento di ricerca Web.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
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

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		No
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ì

OpenAI.OutputMessageContentRefusalContent

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ì

OpenAI.OutputMessageContentType

Proprietà	Value
Type	string
Valori	output_text refusal

OpenAI.Prompt

Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.

Name	Type	Description	Obbligatorio	Predefinito
id	string	Identificatore univoco del modello di richiesta da usare.	Sì
variables	OpenAI.ResponsePromptVariables (nullabili)	Mappa facoltativa di valori da sostituire con le variabili nella richiesta. I valori di sostituzione possono essere stringhe o altri Tipi di input di risposta come immagini o file.	No
version	stringa (nullabile)		No

OpenAI.RankerVersionType

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

OpenAI.OpzioniDiClassifica

Name	Type	Description	Obbligatorio	Predefinito
hybrid_search	OpenAI.HybridSearchOptions		No
└embedding_weight	OpenAI.numeric	Peso dell'incorporamento nella fusione di rango reciproca.	Sì
└text_weight	OpenAI.numeric	Peso del testo nella fusione di rango reciproco.	Sì
classificatore	OpenAI.RankerVersionType		No
soglia_punteggio	OpenAI.numeric		No

OpenAI.Reasoning

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

Name	Type	Description	Obbligatorio	Predefinito
effort	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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	enum	Valori possibili: auto, concise, detailed	No
summary	enum	Valori possibili: auto, concise, detailed	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
Type	string
Annullabile	Sì
Valori	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

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ì

OpenAI.Response

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference (nullabile)		Sì
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
sfondo	booleano (nullable)		No
completed_at	integer		No
conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└* id	string	ID univoco della conversazione a cui è stata associata la risposta.	Sì
creato_il	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
error	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└─ codice	OpenAI.ResponseErrorCode	Codice di errore per la risposta.	Sì
└* messaggio	string	Una descrizione leggibile dall'uomo dell'errore.	Sì
id	string	Identificatore univoco per questa risposta.	Sì
incomplete_details	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* motivo	enum	Valori possibili: max_output_tokens, content_filter	No
instructions	stringa o matrice di OpenAI.InputItem		Sì
max_output_tokens	OpenAI.integer (nullabile)		No
max_tool_calls	OpenAI.integer (nullabile)		No
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
model	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
chiamate_parallele_agli_strumenti	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
previous_response_id	stringa (nullabile)		No
prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
reasoning	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└* sforzo	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
└─ genera_sommario	enum	Valori possibili: auto, concise, detailed	No
└─ Riepilogo	enum	Valori possibili: auto, concise, detailed	No
safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
livello_servizio	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		No	1
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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
top_logprobs	OpenAI.integer (nullabile)		No
top_p	OpenAI.numeric (nullabile)		No	1
truncation	enum	Valori possibili: auto, disabled	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. Scopri di più.	No

OpenAI.ResponseAudioDeltaEvent

Generato quando è presente una risposta audio parziale.

Name	Type	Description	Obbligatorio	Predefinito
delta	string	Blocco di byte audio della risposta con codifica Base64.	Sì
sequence_number	OpenAI.integer		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	OpenAI.integer		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	Predefinito
delta	string	Trascrizione parziale della risposta audio.	Sì
sequence_number	OpenAI.integer		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	OpenAI.integer		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	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete del codice.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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ì
└agent_reference	AgentReference (nullabile)	Agente usato per questa risposta	Sì
└* sfondo	booleano (nullable)		No
└completed_at	intero (nullabile)		No
└* conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└created_at	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem (nullable)		Sì
└ max_output_tokens	OpenAI.integer (nullabile)		No
└max_tool_calls	OpenAI.integer (nullabile)		No
└─ metadati	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
└─ Modello	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa (nullabile)		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
└prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
└* ragionamento	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
└service_tier	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	OpenAI.integer (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
└─ troncamento	enum	Valori possibili: auto, disabled	No
└─ 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. Scopri di più.	No
sequence_number	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		Sì
item_id	string	ID dell'elemento di output a cui è stata aggiunta la parte di contenuto.	Sì
output_index	OpenAI.integer		Sì
part	OpenAI.OutputContent		Sì
└─ Tipo	OpenAI.OutputContentType		Sì
sequence_number	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		Sì
item_id	string	ID dell'elemento di output a cui è stata aggiunta la parte di contenuto.	Sì
output_index	OpenAI.integer		Sì
part	OpenAI.OutputContent		Sì
└─ Tipo	OpenAI.OutputContentType		Sì
sequence_number	OpenAI.integer		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ì
└agent_reference	AgentReference (nullabile)	Agente usato per questa risposta	Sì
└* sfondo	booleano (nullable)		No
└completed_at	intero (nullabile)		No
└* conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└created_at	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem (nullable)		Sì
└ max_output_tokens	OpenAI.integer (nullabile)		No
└max_tool_calls	OpenAI.integer (nullabile)		No
└─ metadati	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
└─ Modello	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa (nullabile)		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
└prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
└* ragionamento	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
└service_tier	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	OpenAI.integer (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
└─ troncamento	enum	Valori possibili: auto, disabled	No
└─ 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. Scopri di più.	No
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.created. Valori possibili: response.created	Sì

OpenAI.ResponseCustomToolCallInputDeltaEvent

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

Name	Type	Description	Obbligatorio	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Identificatore del tipo di evento. Valori possibili: response.custom_tool_call_input.delta	Sì

OpenAI.ResponseCustomToolCallInputDoneEvent

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

Name	Type	Description	Obbligatorio	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
codice	stringa (nullabile)		Sì
message	string	Messaggio di errore.	Sì
param	stringa (nullabile)		Sì
sequence_number	OpenAI.integer		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ì
└agent_reference	AgentReference (nullabile)	Agente usato per questa risposta	Sì
└* sfondo	booleano (nullable)		No
└completed_at	intero (nullabile)		No
└* conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└created_at	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem (nullable)		Sì
└ max_output_tokens	OpenAI.integer (nullabile)		No
└max_tool_calls	OpenAI.integer (nullabile)		No
└─ metadati	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
└─ Modello	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa (nullabile)		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
└prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
└* ragionamento	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
└service_tier	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	OpenAI.integer (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
└─ troncamento	enum	Valori possibili: auto, disabled	No
└─ 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. Scopri di più.	No
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	ID dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	ID dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	ID dell'elemento di output avviato dalla chiamata di ricerca file.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.file_search_call.searching. Valori possibili: response.file_search_call.searching	Sì

OpenAI.ResponseFormatJsonObject

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

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Scopri di più sugli output strutturati.

Name	Type	Description	Obbligatorio	Predefinito
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Sì
└* descrizione	string		No
└> nome	string		Sì
└─ Schema	OpenAI.ResponseFormatJsonSchemaSchema	Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.	No
└─ rigoroso	booleano (nullable)		No
type	enum	Tipo di formato di risposta definito. Sempre json_schema. Valori possibili: json_schema	Sì

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string		No
nome	string		Sì
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui.	No
rigido	booleano (nullable)		No

OpenAI.ResponseFormatJsonSchemaSchema

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

Tipo: oggetto

OpenAI.ResponseFormatText

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

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

Name	Type	Description	Obbligatorio	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Valori possibili: response.function_call_arguments.done	Sì

OpenAI.ResponseImageGenCallCompletedEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre «response.image_generation_call.completed». Valori possibili: response.image_generation_call.completed	Sì

OpenAI.ResponseImageGenCallGeneratingEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre "response.image_generation_call.generating". Valori possibili: response.image_generation_call.generating	Sì

OpenAI.ResponseImageGenCallInProgressEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre 'response.image_generation_call.in_progress'. Valori possibili: response.image_generation_call.in_progress	Sì

OpenAI.ResponseImageGenCallPartialImageEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione.	Sì
output_index	OpenAI.integer		Sì
partial_image_b64	string	Dati di immagine parziali codificati in Base64, adatti per il rendering come immagine.	Sì
partial_image_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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ì
└agent_reference	AgentReference (nullabile)	Agente usato per questa risposta	Sì
└* sfondo	booleano (nullable)		No
└completed_at	intero (nullabile)		No
└* conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└created_at	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem (nullable)		Sì
└ max_output_tokens	OpenAI.integer (nullabile)		No
└max_tool_calls	OpenAI.integer (nullabile)		No
└─ metadati	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
└─ Modello	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa (nullabile)		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
└prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
└* ragionamento	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
└service_tier	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	OpenAI.integer (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
└─ troncamento	enum	Valori possibili: auto, disabled	No
└─ 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. Scopri di più.	No
sequence_number	OpenAI.integer		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ì
└agent_reference	AgentReference (nullabile)	Agente usato per questa risposta	Sì
└* sfondo	booleano (nullable)		No
└completed_at	intero (nullabile)		No
└* conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└created_at	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem (nullable)		Sì
└ max_output_tokens	OpenAI.integer (nullabile)		No
└max_tool_calls	OpenAI.integer (nullabile)		No
└─ metadati	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
└─ Modello	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa (nullabile)		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
└prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
└* ragionamento	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
└service_tier	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	OpenAI.integer (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
└─ troncamento	enum	Valori possibili: auto, disabled	No
└─ 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. Scopri di più.	No
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.incomplete. Valori possibili: response.incomplete	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	Predefinito
logprob	OpenAI.numeric		Sì
token	string	Un possibile token di testo.	Sì
top_logprobs	matrice di OpenAI.ResponseLogProbTopLogprobs	Probabilità di log dei primi 20 token più probabili.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Obbligatorio	Predefinito
logprob	OpenAI.numeric		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

Name	Type	Description	Obbligatorio	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre "response.mcp_call_arguments.delta". Valori possibili: response.mcp_call_arguments.delta	Sì

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

Name	Type	Description	Obbligatorio	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre 'response.mcp_call_arguments.done'. Valori possibili: response.mcp_call_arguments.done	Sì

OpenAI.ResponseMCPCallCompletedEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	ID dell'elemento di chiamata dello strumento MCP completato.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre "response.mcp_call.completed". Valori possibili: response.mcp_call.completed	Sì

OpenAI.ResponseMCPCallFailedEvent

Generato quando una chiamata allo strumento MCP non è riuscita.

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

OpenAI.ResponseMCPCallInProgressEvent

Generato quando è in corso una chiamata allo strumento MCP.

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre 'response.mcp_call.in_progress'. Valori possibili: response.mcp_call.in_progress	Sì

OpenAI.ResponseMCPListToolsCompletedEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	ID dell'elemento di chiamata dello strumento MCP che ha generato questo output.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre "response.mcp_list_tools.completed". Valori possibili: response.mcp_list_tools.completed	Sì

OpenAI.ResponseMCPListToolsFailedEvent

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

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

OpenAI.ResponseMCPListToolsInProgressEvent

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

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	ID dell'elemento di chiamata dello strumento MCP in fase di elaborazione.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
oggetto	OpenAI.OutputItem		Sì
└agent_reference	AgentReference	Agente che ha creato l'elemento.	No
└response_id	string	Risposta in base alla quale viene creato l'elemento.	No
└─ Tipo	OpenAI.OutputItemType		Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
oggetto	OpenAI.OutputItem		Sì
└agent_reference	AgentReference	Agente che ha creato l'elemento.	No
└response_id	string	Risposta in base alla quale viene creato l'elemento.	No
└─ Tipo	OpenAI.OutputItemType		Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.output_item.done. Valori possibili: response.output_item.done	Sì

OpenAI.ResponseOutputTextAnnotationAddedEvent

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

Name	Type	Description	Obbligatorio	Predefinito
Annotazione	OpenAI.Annotation	Annotazione applicabile a un intervallo di testo di output.	Sì
└─ Tipo	OpenAI.AnnotationType		Sì
annotation_index	OpenAI.integer		Sì
content_index	OpenAI.integer		Sì
item_id	string	Identificatore univoco dell'elemento a cui viene aggiunta l'annotazione.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre 'response.output_text.annotation.added'. Valori possibili: response.output_text.annotation.added	Sì

OpenAI.ResponsePromptVariables

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

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

Name	Type	Description	Obbligatorio	Predefinito
response	OpenAI.Response		Sì
└agent_reference	AgentReference (nullabile)	Agente usato per questa risposta	Sì
└* sfondo	booleano (nullable)		No
└completed_at	intero (nullabile)		No
└* conversazione	OpenAI.ConversationReference (nullabile)	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.	No
└created_at	integer	Timestamp Unix (in secondi) di quando è stata creata questa risposta.	Sì
└─ Errore	OpenAI.ResponseError (nullabile)	Oggetto di errore restituito quando il modello non riesce a generare una risposta.	Sì
└* id	string	Identificatore univoco per questa risposta.	Sì
└dettagli_incompleti	OpenAI.ResponseIncompleteDetails (nullabile)		Sì
└* istruzioni	stringa o matrice di OpenAI.InputItem (nullable)		Sì
└ max_output_tokens	OpenAI.integer (nullabile)		No
└max_tool_calls	OpenAI.integer (nullabile)		No
└─ metadati	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
└─ Modello	string	Il modello di distribuzione da utilizzare per la creazione di questa risposta.	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 (nullabile)		No
└parallel_tool_calls	boolean	Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.	Sì	True
└─previous_response_id	stringa (nullabile)		No
└* prompt	OpenAI.Prompt	Riferimento a un modello di richiesta e alle relative variabili. Scopri di più.	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. Scopri di più.	No
└prompt_cache_retention	enum	Valori possibili: in-memory, 24h	No
└* ragionamento	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└safety_identifier	string	Identificatore stabile usato per rilevare gli utenti dell'applicazione che potrebbero violare i criteri di utilizzo di OpenAI. Gli ID devono essere una stringa che identifica in modo univoco ogni utente. È consigliabile eseguire l'hashing del nome utente o dell'indirizzo di posta elettronica per evitare di inviare informazioni di identificazione. Scopri di più.	No
└service_tier	OpenAI.ServiceTier	Specifica il tipo di elaborazione utilizzato per gestire la richiesta. - Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni Project. Se non diversamente configurato, il Project userà 'default'. - Se impostato su "default", la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato. - Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. - Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .	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	OpenAI.numeric (nullabile)		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 di testo e output - 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 funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. - 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 chiamata di funzione. È anche possibile usare strumenti personalizzati per chiamare il proprio codice.	No
└ top_logprobs	OpenAI.integer (nullabile)		No
└top_p	OpenAI.numeric (nullabile)		No	1
└─ troncamento	enum	Valori possibili: auto, disabled	No
└─ 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. Scopri di più.	No
sequence_number	OpenAI.integer		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	Predefinito
item_id	string	L'ID dell'elemento a cui è associata questa parte di riepilogo.	Sì
output_index	OpenAI.integer		Sì
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Sì
└─ testo	string		Sì
└─ Tipo	enum	Valori possibili: summary_text	Sì
sequence_number	OpenAI.integer		Sì
summary_index	OpenAI.integer		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	Predefinito
item_id	string	L'ID dell'elemento a cui è associata questa parte di riepilogo.	Sì
output_index	OpenAI.integer		Sì
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Sì
└─ testo	string		Sì
└─ Tipo	enum	Valori possibili: summary_text	Sì
sequence_number	OpenAI.integer		Sì
summary_index	OpenAI.integer		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	Predefinito
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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
summary_index	OpenAI.integer		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	Predefinito
item_id	string	L'ID dell'elemento a cui è associato questo testo di riepilogo.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
summary_index	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		Sì
item_id	string	L'ID dell'elemento a cui è associato questo testo di ragionamento.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		Sì
item_id	string	ID dell'elemento di output in cui viene finalizzato il testo di rifiuto.	Sì
output_index	OpenAI.integer		Sì
refusal	string	Il testo di rifiuto completato.	Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.refusal.done. Valori possibili: response.refusal.done	Sì

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	Predefinito
content_index	OpenAI.integer		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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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	Predefinito
content_index	OpenAI.integer		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	OpenAI.integer		Sì
sequence_number	OpenAI.integer		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 di testo e output
• 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	Predefinito
input_tokens	OpenAI.integer		Sì
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Sì
└cached_tokens	OpenAI.integer		Sì
output_tokens	OpenAI.integer		Sì
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Sì
└─ token_di_ragionamento	OpenAI.integer		Sì
total_tokens	OpenAI.integer		Sì

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Obbligatorio	Predefinito
cached_tokens	OpenAI.integer		Sì

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Obbligatorio	Predefinito
reasoning_tokens	OpenAI.integer		Sì

OpenAI.ResponseWebSearchCallCompletedEvent

Generato quando viene completata una chiamata di ricerca Web.

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	ID univoco per l'elemento di output associato alla chiamata di ricerca Web.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.web_search_call.completed. Valori possibili: response.web_search_call.completed	Sì

OpenAI.ResponseWebSearchCallInProgressEvent

Generato quando viene avviata una chiamata di ricerca Web.

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	ID univoco per l'elemento di output associato alla chiamata di ricerca Web.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.web_search_call.in_progress. Valori possibili: response.web_search_call.in_progress	Sì

OpenAI.ResponseWebSearchCallSearchingEvent

Generato quando viene eseguita una chiamata di ricerca Web.

Name	Type	Description	Obbligatorio	Predefinito
item_id	string	ID univoco per l'elemento di output associato alla chiamata di ricerca Web.	Sì
output_index	OpenAI.integer		Sì
sequence_number	OpenAI.integer		Sì
type	enum	Tipo di evento. Sempre response.web_search_call.searching. Valori possibili: response.web_search_call.searching	Sì

OpenAI.Screenshot

Azione screenshot.

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

OpenAI.Scroll

Azione di scorrimento.

Name	Type	Description	Obbligatorio	Predefinito
scroll_x	OpenAI.integer		Sì
scroll_y	OpenAI.integer		Sì
type	enum	Specifica il tipo di evento. Per un'azione di scorrimento, questa proprietà è sempre impostato su scroll. Valori possibili: scroll	Sì
x	OpenAI.integer		Sì
y	OpenAI.integer		Sì

OpenAI.SearchContextSize

Proprietà	Value
Type	string
Valori	low medium high

OpenAI.ServiceTier

Specifica il tipo di elaborazione utilizzato per gestire la richiesta.

• Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni di Project. Se non diversamente configurato, il Project userà 'default'.
• Se impostato su 'default', la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato.
• Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente.
• Se non è impostato, il comportamento predefinito è "auto". Quando il service_tier parametro è impostato, il corpo della risposta includerà il service_tier valore in base alla modalità di elaborazione effettivamente usata per gestire la richiesta. Questo valore di risposta può essere diverso dal valore impostato nel parametro .

Proprietà	Value
Type	string
Annullabile	Sì
Valori	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

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ì

OpenAI.SpecificFunctionShellParam

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ì

OpenAI.Summary

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ì

OpenAI.SummaryTextContent

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ì

OpenAI.TextContent

Contenuto di testo.

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

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:* Impostazione per { "type": "json_object" } abilitare la modalità JSON precedente, 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

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

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

Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Scopri di più sugli output strutturati.

Name	Type	Description	Obbligatorio	Predefinito
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 (nullable)		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
bing_grounding	BingGroundingTool
fabric_dataagent_preview	MicrosoftFabricPreviewTool
sharepoint_grounding_preview	SharepointPreviewTool
azure_ai_search	AzureAISearchTool
openapi	OpenApiTool
bing_custom_search_preview	BingCustomSearchPreviewTool
browser_automation_preview	BrowserAutomationPreviewTool
azure_function	AzureFunctionTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2APreviewTool
memory_search_preview	MemorySearchPreviewTool
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

Name	Type	Description	Obbligatorio	Predefinito
type	OpenAI.ToolType		Sì

OpenAI.ToolChoiceAllowed

Vincola gli strumenti disponibili al modello a un set predefinito.

Name	Type	Description	Obbligatorio	Predefinito
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> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<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.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

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

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

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

Name	Type	Description	Obbligatorio	Predefinito
nome	stringa (nullabile)		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

Controlla quale (se presente) strumento 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
function	OpenAI.ToolChoiceFunction
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

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

OpenAI.ToolChoiceWebSearchPreview

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

Proprietà	Value
Type	string
Valori	function file_search computer_use_preview web_search mcp code_interpreter image_generation local_shell shell custom web_search_preview apply_patch a2a_preview bing_custom_search_preview browser_automation_preview fabric_dataagent_preview sharepoint_grounding_preview memory_search_preview azure_ai_search azure_function bing_grounding capture_structured_outputs openapi

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 predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello, ad esempio la ricerca Web o la ricerca di file. Altre informazioni sugli strumenti predefiniti.
• MCP Tools: integrazioni con sistemi di terze parti tramite server MCP personalizzati o connettori predefiniti, ad esempio Google Drive e SharePoint. Altre informazioni 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à di log principale di un token.

Name	Type	Description	Obbligatorio	Predefinito
bytes	matrice di OpenAI.integer		Sì
logprob	OpenAI.numeric		Sì
token	string		Sì

OpenAI.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 impostato su type. Valori possibili: type	Sì

OpenAI.UpdateConversationBody

Name	Type	Description	Obbligatorio	Predefinito
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	Sì

OpenAI.UrlCitationBody

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

Name	Type	Description	Obbligatorio	Predefinito
end_index	OpenAI.integer		Sì
start_index	OpenAI.integer		Sì
Titolo	string	Titolo della risorsa Web.	Sì
type	enum	Tipo di citazione URL. Sempre url_citation. Valori possibili: url_citation	Sì
url	string	URL della risorsa Web.	Sì

OpenAI.VectorStoreFileAttributes

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, valori booleani o numeri.

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
Type	string
Annullabile	Sì
Valori	low medium high

OpenAI.Wait

Azione di attesa.

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

OpenAI.WebSearchActionFind

Tipo di azione "find": cerca un criterio all'interno di una pagina caricata.

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

OpenAI.WebSearchActionOpenPage

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	string	URL aperto dal modello.	Sì

OpenAI.WebSearchActionSearch

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

Name	Type	Description	Obbligatorio	Predefinito
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	string		Sì

OpenAI.WebSearchApproximateLocation

Posizione approssimativa dell'utente.

Name	Type	Description	Obbligatorio	Predefinito
Città	stringa (nullabile)		No
paese	stringa (nullabile)		No
region	stringa (nullabile)		No
timezone	stringa (nullabile)		No
type	enum	Tipo di approssimazione della posizione. Sempre approximate. Valori possibili: approximate	No

OpenAI.WebSearchPreviewTool

Questo strumento cerca sul web risultati rilevanti da utilizzare in una risposta. Altre informazioni sullo strumento di ricerca web.

Name	Type	Description	Obbligatorio	Predefinito
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ì
posizione_utente	OpenAI.ApproximateLocation (nullabile)		No
└* città	stringa (nullabile)		No
└* paese	stringa (nullabile)		No
└* area geografica	stringa (nullabile)		No
└* fuso orario	stringa (nullabile)		No
└─ Tipo	enum	Tipo di approssimazione della posizione. Sempre approximate. Valori possibili: approximate	Sì

OpenAI.WebSearchTool

Cerca su Internet fonti relative al prompt. Altre informazioni sullo strumento di ricerca web.

Name	Type	Description	Obbligatorio	Predefinito
custom_search_configuration	WebSearchConfiguration	Configurazione di ricerca Web per bing ricerca personalizzata	No
└instance_name	string	Nome dell'istanza di configurazione personalizzata assegnata alla configurazione.	Sì
└project_connection_id	string	Project ID connessione per l'uso di base con ricerca personalizzata Bing	Sì
Filtri	OpenAI.WebSearchToolFilters (nullabile)		No
└allowed_domains	matrice di string (nullable)		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
type	enum	Tipo dello strumento di ricerca Web. Uno di web_search o web_search_2025_08_26. Valori possibili: web_search	Sì
posizione_utente	OpenAI.WebSearchApproximateLocation (nullabile)	Posizione approssimativa dell'utente.	No
└* città	stringa (nullabile)		No
└* paese	stringa (nullabile)		No
└* area geografica	stringa (nullabile)		No
└* fuso orario	stringa (nullabile)		No
└─ Tipo	enum	Tipo di approssimazione della posizione. Sempre approximate. Valori possibili: approximate	No

OpenAI.WebSearchToolFilters

Name	Type	Description	Obbligatorio	Predefinito
allowed_domains	matrice di valori string		No

OpenAI.integer

Tipo: integer

Formato: int64

OpenAI.numeric

Tipo: numero

Formato: double

OpenApiAnonymousAuthDetails

Dettagli di sicurezza per l'autenticazione anonima OpenApi

Name	Type	Description	Obbligatorio	Predefinito
type	enum	Tipo di oggetto, che è sempre "anonimo". Valori possibili: anonymous	Sì

OpenApiAuthDetails

dettagli di autenticazione per OpenApiFunctionDefinition

Discriminare per OpenApiAuthDetails

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

Valore del tipo	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Type	Description	Obbligatorio	Predefinito
type	OpenApiAuthType	Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono: - Anonimo (nessuna autenticazione necessaria) - Project Connessione (richiede project_connection_id all'endpoint, come configurazione in AI Foundry) - Managed_Identity (richiede destinatari per l'autenticazione basata sull'identità)	Sì

OpenApiAuthType

Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono:

• Anonimo (non è richiesta l'autenticazione)
• Project Connessione (richiede project_connection_id per raggiungere l'endpoint, come configurato in AI Foundry)
• Managed_Identity (richiede un pubblico per l'autenticazione basata sull'identità)

Proprietà	Value
Descrizione	Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono: - Anonimo (nessuna autenticazione necessaria) - Project Connessione (richiede project_connection_id all'endpoint, come configurazione in AI Foundry) - Managed_Identity (richiede destinatari per l'autenticazione basata sull'identità)
Type	string
Valori	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Informazioni sulla definizione di input per una funzione openapi.

Name	Type	Description	Obbligatorio	Predefinito
auth	OpenApiAuthDetails	dettagli di autenticazione per OpenApiFunctionDefinition	Sì
└─ Tipo	OpenApiAuthType	Il tipo di autenticazione deve essere anonimo/project_connection/managed_identity	Sì
default_params	matrice di valori string	Elenco dei parametri della specifica OpenAPI che useranno le impostazioni predefinite fornite dall'utente	No
descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
functions	matrice di oggetti	Elenco delle definizioni di funzione usate dallo strumento OpenApi	No
nome	string	Nome della funzione che deve essere chiamata.	Sì
spec	object	La forma della funzione openapi, descritta come oggetto Schema JSON.	Sì

OpenApiManagedAuthDetails

Dettagli di sicurezza per l'autenticazione managed_identity OpenApi

Name	Type	Description	Obbligatorio	Predefinito
security_scheme	OpenApiManagedSecurityScheme	Schema di sicurezza per l'autenticazione managed_identity OpenApi	Sì
Gruppo di destinatari └*	string	Ambito di autenticazione per managed_identity tipo di autenticazione	Sì
type	enum	Tipo di oggetto, che è sempre "managed_identity". Valori possibili: managed_identity	Sì

OpenApiManagedSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

Name	Type	Description	Obbligatorio	Predefinito
audience	string	Ambito di autenticazione per managed_identity tipo di autenticazione	Sì

OpenApiProjectConnectionAuthDetails

Dettagli di sicurezza per l'autenticazione della connessione project OpenApi

Name	Type	Description	Obbligatorio	Predefinito
security_scheme	OpenApiProjectConnectionSecurityScheme	Schema di sicurezza per l'autenticazione managed_identity OpenApi	Sì
└project_connection_id	string	Project ID connessione per Project tipo di autenticazione della connessione	Sì
type	enum	Tipo di oggetto, che è sempre "project_connection". Valori possibili: project_connection	Sì

OpenApiProjectConnectionSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

Name	Type	Description	Obbligatorio	Predefinito
project_connection_id	string	Project ID connessione per Project tipo di autenticazione della connessione	Sì

OpenApiTool

Informazioni sulla definizione di input per uno strumento OpenAPI usato per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
openapi	OpenApiFunctionDefinition	Informazioni sulla definizione di input per una funzione openapi.	Sì
└* Autenticazione	OpenApiAuthDetails	Aprire i dettagli di autenticazione dell'API	Sì
└default_params	matrice di valori string	Elenco dei parametri della specifica OpenAPI che useranno le impostazioni predefinite fornite dall'utente	No
└* descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
└* funzioni	matrice di oggetti (sola lettura)	Elenco delle definizioni di funzione usate dallo strumento OpenApi	No
└* descrizione	string	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
└> nome	string	Nome della funzione che deve essere chiamata.	Sì
└─ Parametri	object	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema.	Sì
└> nome	string	Nome della funzione che deve essere chiamata.	Sì
└* specifica	object	La forma della funzione openapi, descritta come oggetto Schema JSON.	Sì
type	enum	Il tipo di oggetto, che è sempre 'openapi'. Valori possibili: openapi	Sì

PageOrder

Proprietà	Value
Type	string
Valori	asc desc

PagedConnection

Raccolta di pagine di elementi Connection

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di connessione	Elementi connessione in questa pagina	Sì

PagedDatasetVersion

Raccolta di pagine di elementi DatasetVersion

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di DatasetVersion	Elementi DatasetVersion in questa pagina	Sì

PagedDeployment

Raccolta di pagine di elementi di distribuzione

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di distribuzione	Elementi di distribuzione in questa pagina	Sì

PagedEvaluationRule

Raccolta di elementi Paged di EvaluationRule

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di EvaluationRule	Elementi EvaluationRule in questa pagina	Sì

PagedEvaluationTaxonomy

Raccolta di pagine di elementi EvaluationTaxonomy

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di EvaluationTaxonomy	Elementi EvaluationTaxonomy in questa pagina	Sì

PagedEvaluatorVersion

Raccolta di pagine di elementi EvaluatorVersion

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di analizzatoriVersion	Elementi Di analizzatoreVersion in questa pagina	Sì

PagedIndex

Raccolta di pagine di elementi Index

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di indice	Elementi indice in questa pagina	Sì

PagedInsight

Raccolta di elementi Insight in pagine

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di informazioni dettagliate	Elementi di Informazioni dettagliate in questa pagina	Sì

PagedRedTeam

Raccolta di pagine di elementi RedTeam

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di RedTeam	Elementi RedTeam in questa pagina	Sì

PagedSchedule

Raccolta di pagine di elementi pianificati

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di pianificazione	Elementi pianificati in questa pagina	Sì

PagedScheduleRun

Raccolta di pagine di elementi ScheduleRun

Name	Type	Description	Obbligatorio	Predefinito
nextLink	string	Collegamento alla pagina successiva di elementi	No
value	matrice di ScheduleRun	Elementi ScheduleRun in questa pagina	Sì

PendingUploadRequest

Rappresenta una richiesta di caricamento in sospeso.

Name	Type	Description	Obbligatorio	Predefinito
Connectionname	string	Nome di connessione dell'account di archiviazione di Azure da usare per la generazione di un token di firma di accesso condiviso temporaneo	No
pendingUploadId	string	Se PendingUploadId non viene specificato, verrà usato un GUID casuale.	No
pendingUploadType	enum	BlobReference è l'unico tipo supportato. Valori possibili: BlobReference	Sì

PendingUploadResponse

Rappresenta la risposta per una richiesta di caricamento in sospeso

Name	Type	Description	Obbligatorio	Predefinito
blobReference	BlobReference	Dettagli di riferimento BLOB.	Sì
└* blobUri	string	Percorso URI BLOB per il caricamento dei dati da parte del client. Esempio: https://blob.windows.core.net/Container/Path	Sì
└* credenziali	SasCredential	Informazioni sulle credenziali per accedere all'account di archiviazione.	Sì
└\ storageAccountArmId	string	ID ARM dell'account di archiviazione da usare.	Sì
pendingUploadId	string	ID per questa richiesta di caricamento.	Sì
pendingUploadType	enum	BlobReference è l'unico tipo supportato Valori possibili: BlobReference	Sì
version	string	Versione della risorsa da creare se l'utente non ha specificato la versione durante la creazione iniziale del caricamento	No

PromptAgentDefinition

Definizione dell'agente di richiesta

Name	Type	Description	Obbligatorio	Predefinito
instructions	stringa (nullabile)	Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.	No
kind	enum	Valori possibili: prompt	Sì
model	string	Distribuzione del modello da utilizzare per l'agente.	Sì
rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
└rai_policy_name	string	Nome del criterio RAI da applicare.	Sì
reasoning	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└* sforzo	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono none, minimal, lowmedium, , highe 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, 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 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
└─ genera_sommario	enum	Valori possibili: auto, concise, detailed	No
└─ Riepilogo	enum	Valori possibili: auto, concise, detailed	No
structured_inputs	object	Set di input strutturati che possono partecipare alla sostituzione di modelli di prompt o alle associazioni di argomenti dello strumento.	No
Temperatura	Numero	Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico. In genere è consigliabile modificare questa impostazione o top_p non entrambe.	No	1
text	PromptAgentDefinitionTextOptions	Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati.	No
└* formato	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
tool_choice	string o 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.	No
Strumenti	matrice di OpenAI.Tool	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 .	No
top_p	Numero	Un'alternativa al campionamento con temperatura, denominata campionamento nucleo, dove il modello considera i risultati dei token con probabilità top_p massa. Quindi 0,1 significa solo i token che comprendono il 10% superiore della massa di probabilità% sono considerati. In genere è consigliabile modificare questa impostazione o temperature non entrambe.	No	1

PromptAgentDefinitionTextOptions

Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON 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

PromptBasedEvaluatorDefinition

Analizzatore basato su prompt

Name	Type	Description	Obbligatorio	Predefinito
data_schema	object	Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
init_parameters	object	Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio.	No
metrics	object	Elenco delle metriche di output prodotte da questo valutatore	No
prompt_text	string	Testo del prompt utilizzato per la valutazione	Sì
type	enum	Valori possibili: prompt	Sì

ProtocolVersionRecord

Mapping di record per un singolo protocollo e la relativa versione.

Name	Type	Description	Obbligatorio	Predefinito
protocol	AgentProtocol		Sì
version	string	Stringa di versione per il protocollo, ad esempio 'v0.1.1'.	Sì

RaiConfig

Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).

Name	Type	Description	Obbligatorio	Predefinito
rai_policy_name	string	Nome del criterio RAI da applicare.	Sì

RecurrenceSchedule

Modello di pianificazione delle ricorrenze.

Discriminare per RecurrenceSchedule

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

Valore del tipo	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Type	Description	Obbligatorio	Predefinito
type	RecurrenceType	Tipo di ricorrenza.	Sì

RecurrenceTrigger

Trigger basato sulla ricorrenza.

Name	Type	Description	Obbligatorio	Predefinito
endTime	string	Ora di fine per la pianificazione della ricorrenza in formato ISO 8601.	No
interval	integer	Intervallo per la pianificazione della ricorrenza.	Sì
schedule	RecurrenceSchedule	Modello di pianificazione delle ricorrenze.	Sì
└─ Tipo	RecurrenceType	Tipo di ricorrenza per la pianificazione della ricorrenza.	Sì
startTime	string	Ora di inizio per la pianificazione delle ricorrenze in formato ISO 8601.	No
timeZone	string	Fuso orario per la pianificazione della ricorrenza.	No	UTC
type	enum	Tipo di trigger. Valori possibili: Recurrence	Sì

RecurrenceType

Tipo di ricorrenza.

Proprietà	Value
Descrizione	Tipo di ricorrenza.
Type	string
Valori	Hourly Daily Weekly Monthly

RedTeam

Dettagli della squadra rossa.

Name	Type	Description	Obbligatorio	Predefinito
applicationScenario	string	Scenario dell'applicazione per l'operazione red team, per generare attacchi specifici dello scenario.	No
attackStrategies	matrice di AttackStrategy	Elenco di strategie di attacco o elenchi annidati di strategie di attacco.	No
displayName	string	Nome dell'esecuzione del red-team.	No
id	string (sola lettura)	Identificatore dell'esecuzione del team rosso.	Sì
numTurns	integer	Numero di round di simulazione.	No
properties	object	Proprietà della squadra rossa. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà.	No
riskCategories	matrice di RiskCategory	Elenco delle categorie di rischio per cui generare gli obiettivi di attacco.	No
simulationOnly	boolean	Solo simulazione o simulazione + valutazione. False predefinito, se true l'analisi restituisce il risultato della conversazione non di valutazione.	No	Falso
Stato	string (sola lettura)	Stato della squadra rossa. È impostato dal servizio ed è di sola lettura.	No
tags	object	Tag della squadra rossa. A differenza delle proprietà, i tag sono completamente modificabili.	No
target	TargetConfig	Classe astratta per la configurazione del target.	Sì
└─ Tipo	string	Tipo della configurazione del modello.	Sì

RedTeamEvalRunDataSource

Name	Type	Description	Obbligatorio	Predefinito
item_generation_params	ItemGenerationParams	Rappresenta il set di parametri utilizzati per controllare le operazioni di generazione degli elementi.	Sì
└─ Tipo	ItemGenerationParamsType	Tipo di parametri di generazione di elementi da usare.	Sì
target	Destinazione	Classe base per bersagli con supporto per discriminatore.	Sì
└─ Tipo	string	Tipo di destinazione.	Sì
type	enum	Tipo di origine dati. Sempre azure_ai_red_team. Valori possibili: azure_ai_red_team	Sì

RedTeamItemGenerationParams

Name	Type	Description	Obbligatorio	Predefinito
attack_strategies	matrice di AttackStrategy	Raccolta di strategie di attacco da usare.	Sì
num_turns	integer	Numero di turni consentiti nel gioco.	Sì	20
type	enum	Tipo di parametri di generazione di elementi. Valori possibili: red_team	Sì

RedTeamSeedPromptsItemGenerationParams

Rappresenta i parametri per la generazione di elementi di inizializzazione red team.

Name	Type	Description	Obbligatorio	Predefinito
attack_strategies	matrice di AttackStrategy	Raccolta di strategie di attacco da usare.	Sì
num_turns	integer	Numero di turni consentiti nel gioco.	Sì	20
source	OpenAI.EvalJsonlFileContentSource		Sì
└> contenuto	matrice di OpenAI.EvalJsonlFileContentSourceContentContent	Contenuto del file jsonl.	Sì
└─ Tipo	enum	Tipo di origine JSONL. Sempre file_content. Valori possibili: file_content	Sì
type	enum	Tipo di parametri di generazione di elementi, sempre red_team_seed_prompts. Valori possibili: red_team_seed_prompts	Sì

RedTeamTaxonomyItemGenerationParams

Rappresenta i parametri per la generazione dell'elemento tassonomia del team rosso.

Name	Type	Description	Obbligatorio	Predefinito
attack_strategies	matrice di AttackStrategy	Raccolta di strategie di attacco da usare.	Sì
num_turns	integer	Numero di turni consentiti nel gioco.	Sì	20
source	OpenAI.EvalJsonlFileContentSource		Sì
└> contenuto	matrice di OpenAI.EvalJsonlFileContentSourceContentContent	Contenuto del file jsonl.	Sì
└─ Tipo	enum	Tipo di origine JSONL. Sempre file_content. Valori possibili: file_content	Sì
type	enum	Tipo di parametri di generazione di elementi, sempre red_team_taxonomy. Valori possibili: red_team_taxonomy	Sì

ResponseRetrievalItemGenerationParams

Rappresenta i parametri per la generazione di elementi di recupero della risposta.

Name	Type	Description	Obbligatorio	Predefinito
mappatura dei dati	object	Mapping dai campi di origine al campo response_id, necessario per recuperare la cronologia delle chat.	Sì
max_num_turns	integer	Numero massimo di turni di cronologia chat da valutare.	Sì
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Origine da cui viene letto il contenuto JSONL.	Sì
type	enum	Tipo di parametri di generazione di elementi, sempre response_retrieval. Valori possibili: response_retrieval	Sì

RiskCategory

Categoria di rischio per l'obiettivo dell'attacco.

Proprietà	Value
Descrizione	Categoria di rischio per l'obiettivo dell'attacco.
Type	string
Valori	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SasCredentials

Definizione delle credenziali di firma di accesso condiviso

Name	Type	Description	Obbligatorio	Predefinito
SAS	string (sola lettura)	Token di firma di accesso condiviso	No
type	enum	Tipo di credenziale Valori possibili: SAS	Sì

SampleType

Il tipo di campione utilizzato nell'analisi.

Proprietà	Value
Descrizione	Il tipo di campione utilizzato nell'analisi.
Type	string
Valori	EvaluationResultSample

SasCredential

Definizione delle credenziali di firma di accesso condiviso

Name	Type	Description	Obbligatorio	Predefinito
sasUri	string (sola lettura)	URI di firma di accesso condiviso	Sì
type	enum	Tipo di credenziale Valori possibili: SAS	Sì

Schedule

Modello di pianificazione.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione della pianificazione.	No
displayName	string	Nome della pianificazione.	No
enabled	boolean	Stato abilitato della pianificazione.	Sì
id	string (sola lettura)	Identificatore della pianificazione.	Sì
properties	object	Proprietà della pianificazione. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà.	No
provisioningStatus	ScheduleProvisioningStatus (sola lettura)	Pianificare lo stato del provisioning.	No
dati di sistema	oggetto (sola lettura)	Metadati di sistema per la risorsa.	Sì
tags	object	Tag della pianificazione. A differenza delle proprietà, i tag sono completamente modificabili.	No
compito	ScheduleTask	Modello di attività di pianificazione.	Sì
Configurazione di └*	object	Configurazione per l'attività.	No
└─ Tipo	ScheduleTaskType	Tipo dell'attività.	Sì
trigger	Trigger	Modello base per il Trigger del programma.	Sì
└─ Tipo	TriggerType	Tipo di trigger.	Sì

ScheduleProvisioningStatus

Pianificare lo stato del provisioning.

Proprietà	Value
Descrizione	Pianificare lo stato del provisioning.
Type	string
Valori	Creating Updating Deleting Succeeded Failed

ScheduleRun

Pianificare il modello di esecuzione.

Name	Type	Description	Obbligatorio	Predefinito
error	string (sola lettura)	Informazioni sull'errore per l'esecuzione della pianificazione.	No
id	string (sola lettura)	Identificatore dell'esecuzione della pianificazione.	Sì
properties	oggetto (sola lettura)	Proprietà dell'esecuzione della pianificazione.	Sì
scheduleId	string	Identificatore della pianificazione.	Sì
esito positivo	booleano (sola lettura)	Attivare lo stato di esito positivo dell'esecuzione della pianificazione.	Sì
triggerTime	string	Ora di attivazione dell'esecuzione della pianificazione.	No

PianificaAttività

Modello di attività di pianificazione.

Discriminante per ScheduleTask

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

Valore del tipo	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Name	Type	Description	Obbligatorio	Predefinito
configuration	object	Configurazione per l'attività.	No
type	ScheduleTaskType	Tipo dell'attività.	Sì

ScheduleTaskType

Tipo dell'attività.

Proprietà	Value
Descrizione	Tipo dell'attività.
Type	string
Valori	Evaluation Insight

SharepointGroundingToolParameters

Parametri dello strumento di messa a terra di SharePoint.

Name	Type	Description	Obbligatorio	Predefinito
project_connections	matrice di ToolProjectConnection	Le connessioni project collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento.	No

SharepointPreviewTool

Informazioni sulla definizione di input per uno strumento di SharePoint usato per configurare un agente.

Name	Type	Description	Obbligatorio	Predefinito
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parametri dello strumento di messa a terra di SharePoint.	Sì
└project_connections	matrice di ToolProjectConnection	Le connessioni project collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	No
type	enum	Il tipo di oggetto, che è sempre 'sharepoint_grounding_preview'. Valori possibili: sharepoint_grounding_preview	Sì

Sku

Informazioni sullo SKU

Name	Type	Description	Obbligatorio	Predefinito
capacity	integer	Capacità sku	Sì
family	string	Famiglia sku	Sì
nome	string	Nome SKU	Sì
size	string	Dimensioni sku	Sì
tier	string	Livello SKU	Sì

StructuredInputDefinition

Input strutturato che può partecipare alle sostituzioni di modelli di prompt e all'associazione di argomenti dello strumento.

Name	Type	Description	Obbligatorio	Predefinito
default_value		Valore predefinito per l'input se non viene fornito alcun valore di runtime.	No
descrizione	string	Una descrizione leggibile dell'input.	No
required	boolean	Indica se la proprietà di input è necessaria quando viene richiamato l'agente.	No	Falso
schema	object	Lo schema JSON per l'input strutturato (facoltativo).	No

StructuredOutputDefinition

Output strutturato che può essere prodotto dall'agente.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione dell'output da generare. Usato dal modello per determinare quando generare l'output.	Sì
nome	string	Nome dell'output strutturato.	Sì
schema	object	Schema JSON per l'output strutturato.	Sì
rigido	booleano (nullable)	Indica se applicare la convalida rigorosa. Valore predefinito true.	Sì

StructuredOutputsOutputItem

Name	Type	Description	Obbligatorio	Predefinito
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
output		Output strutturato acquisito durante la risposta.	Sì
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
type	enum	Valori possibili: structured_outputs	Sì

SyntheticDataGenerationPreviewEvalRunDataSource

Rappresenta un'origine dati per le esecuzioni di valutazione che valuta in base ai dati sintetici generati a scopo di test.

Name	Type	Description	Obbligatorio	Predefinito
messaggi di input	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
Modello └─	matrice di oggetti o OpenAI.EvalItem		Sì
└─ Tipo	enum	Valori possibili: template	Sì
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Sì
└model_deployment_name	string	Nome della distribuzione del modello da usare per la generazione di dati sintetici.	Sì
└output_dataset_id	string (sola lettura)	Identificatore del set di dati di output in cui vengono archiviati i dati sintetici generati. I dati generati sono un file jsonl con ID colonne, query e test_description.	No
└output_dataset_name	string	Nome del set di dati di output in cui verranno archiviati i dati sintetici generati. Se non specificato, il servizio genera automaticamente il nome del set di dati.	No
└* prompt	string	Richiesta usata per la generazione di dati sintetici. Questa opzione è se la destinazione è di tipo 'azure_ai_agent' con istruzioni configurate nell'agente.	No
└samples_count	integer	Numero massimo di campioni di dati da generare.	Sì
└* origini	matrice di OpenAI.EvalJsonlFileIdSource	File di origine del contenuto dati di inizializzazione facoltativi per la generazione di dati.	Sì
└─ Tipo	enum	Tipo di parametri di generazione di elementi. Valori possibili: synthetic_data_gen_preview	Sì
target	Destinazione	Classe base per bersagli con supporto per discriminatore.	Sì
└─ Tipo	string	Tipo di destinazione.	Sì
type	enum	Tipo di origine dati, sempre azure_ai_synthetic_data_gen_preview. Valori possibili: azure_ai_synthetic_data_gen_preview	Sì

SyntheticDataGenerationPreviewItemGenerationParams

Name	Type	Description	Obbligatorio	Predefinito
model_deployment_name	string	Nome della distribuzione del modello da usare per la generazione di dati sintetici.	Sì
output_dataset_id	string (sola lettura)	Identificatore del set di dati di output in cui vengono archiviati i dati sintetici generati. I dati generati sono un file jsonl con ID colonne, query e test_description.	No
output_dataset_name	string	Nome del set di dati di output in cui verranno archiviati i dati sintetici generati. Se non specificato, il servizio genera automaticamente il nome del set di dati.	No
prompt	string	Richiesta usata per la generazione di dati sintetici. Questa opzione è se la destinazione è di tipo 'azure_ai_agent' con istruzioni configurate nell'agente.	No
samples_count	integer	Numero massimo di campioni di dati da generare.	Sì
Fonti	matrice di OpenAI.EvalJsonlFileIdSource	File di origine del contenuto dati di inizializzazione facoltativi per la generazione di dati.	Sì
type	enum	Tipo di parametri di generazione di elementi. Valori possibili: synthetic_data_gen_preview	Sì

Target

Classe base per bersagli con supporto per discriminatore.

Discriminare per target

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

Valore del tipo	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Name	Type	Description	Obbligatorio	Predefinito
type	string	Tipo di destinazione.	Sì

TargetCompletionEvalRunDataSource

Rappresenta un'origine dati per la configurazione di valutazione del completamento basata su destinazione.

Name	Type	Description	Obbligatorio	Predefinito
messaggi di input	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└item_reference	string		Sì
└─ Tipo	enum	Valori possibili: item_reference	Sì
source	OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource	Configurazione di origine per i dati inline o di file.	Sì
target	Destinazione	Classe base per bersagli con supporto per discriminatore.	Sì
└─ Tipo	string	Tipo di destinazione.	Sì
type	enum	Tipo di origine dati, sempre azure_ai_target_completions. Valori possibili: azure_ai_target_completions	Sì

TargetConfig

Classe astratta per la configurazione del target.

Discriminare per TargetConfig

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

Valore del tipo	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Type	Description	Obbligatorio	Predefinito
type	string	Tipo della configurazione del modello.	Sì

TargetUpdate

Classe base per bersagli con supporto per discriminatore.

Discriminare per TargetUpdate

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

Valore del tipo	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Name	Type	Description	Obbligatorio	Predefinito
type	string	Tipo di destinazione.	Sì

TassonomiaCategory

Definizione della categoria di tassonomia.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione della categoria tassonomia.	No
id	string	Identificatore univoco della categoria tassonomia.	Sì
nome	string	Nome della categoria tassonomia.	Sì
properties	object	Proprietà aggiuntive per la categoria tassonomia.	No
riskCategory	RiskCategory	Categoria di rischio per l'obiettivo dell'attacco.	Sì
Sottocategorie	matrice di TassonomiaSubCategory	Elenco delle sottocategorie tassonomia.	Sì

TassonomiaSubCategory

Definizione della sottocategoria della tassonomia.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Descrizione della sottocategoria tassonomia.	No
enabled	boolean	Elenco di elementi di tassonomia in questa sottocategoria.	Sì
id	string	Identificatore univoco della sottocategoria tassonomia.	Sì
nome	string	Nome della sottocategoria tassonomia.	Sì
properties	object	Proprietà aggiuntive per la sottocategoria tassonomia.	No

ToolDescription

Descrizione di uno strumento che può essere utilizzato da un agente.

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Breve descrizione dello scopo dello strumento.	No
nome	string	Nome dello strumento.	No

ToolProjectConnection

Una risorsa di connessione project.

Name	Type	Description	Obbligatorio	Predefinito
project_connection_id	string	Una connessione di progetto in uno ToolProjectConnectionList collegato a questo strumento.	Sì

TracesPreviewEvalRunDataSource

Rappresenta un'origine dati per le esecuzioni di valutazione che operano sulle tracce di Agent archiviate in Application Insights.

Name	Type	Description	Obbligatorio	Predefinito
agent_id	string	ID agente usato per filtrare le tracce per la valutazione.	No
agent_name	string	Nome dell'agente utilizzato per filtrare le tracce per la valutazione.	No
orario di fine	integer	Timestamp Unix (in secondi) che contrassegna la fine della finestra della query di traccia. L'impostazione predefinita è l'ora corrente.	No
ingestion_delay_seconds	integer	Ritardo da applicare per l'inserimento durante l'esecuzione di query sulle tracce.	No	300
lookback_hours	integer	Finestra di lookback (in ore) applicata durante il recupero di tracce da Application Insights. Per le valutazioni pianificate, questo viene dedotto dall'intervallo di ricorrenza.	No	168
max_traces	integer	Limite di campionamento applicato alle tracce recuperate per la valutazione.	No	1000
trace_ids	matrice di valori string	Raccolta di identificatori di traccia dell'agente da valutare.	No
type	enum	Tipo di origine dati, sempre azure_ai_traces_preview. Valori possibili: azure_ai_traces_preview	Sì

TreatmentEffectType

Tipo di effetto del trattamento.

Proprietà	Value
Descrizione	Tipo di effetto del trattamento.
Type	string
Valori	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

Modello base per il Trigger del programma.

Discriminante per trigger

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

Valore del tipo	Schema
Cron	CronTrigger
Recurrence	RicorrenzaTrigger
OneTime	OneTimeTrigger

Name	Type	Description	Obbligatorio	Predefinito
type	TriggerType	Tipo di trigger.	Sì

Tipo di Attivazione

Tipo di trigger.

Proprietà	Value
Descrizione	Tipo di trigger.
Type	string
Valori	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Type	Description	Obbligatorio	Predefinito
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	string	ID manifesto da cui importare la versione dell'agente.	Sì
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Sì

UpdateAgentRequest

Name	Type	Description	Obbligatorio	Predefinito
Definizione	AgentDefinition		Sì
└* tipo	AgentKind		Sì
└rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
descrizione	string	Una descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No

UpdateEvalParametersBody

Name	Type	Description	Obbligatorio	Predefinito
metadata	OpenAI.Metadata (nullabili)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'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.	No
nome	string		No
properties	object	Set di coppie chiave-valore non modificabili di 16 che possono essere collegate a un oggetto per l'archiviazione di informazioni aggiuntive. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

UserProfileMemoryItem

Un elemento di memoria contenente specificamente le informazioni del profilo utente estratte dalle conversazioni, come preferenze, interessi e dettagli personali.

Name	Type	Description	Obbligatorio	Predefinito
contenuto	string	Il contenuto della memoria.	Sì
kind	enum	Tipo di elemento di memoria. Valori possibili: user_profile	Sì
memory_id	string	L'ID univoco dell'elemento di memoria.	Sì
scope	string	Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente.	Sì
updated_at	integer	L'ora dell'ultimo aggiornamento dell'elemento in memoria.	Sì

WebSearchConfiguration

Configurazione di ricerca Web per bing ricerca personalizzata

Name	Type	Description	Obbligatorio	Predefinito
instance_name	string	Nome dell'istanza di configurazione personalizzata assegnata alla configurazione.	Sì
project_connection_id	string	Project ID connessione per l'uso di base con ricerca personalizzata Bing	Sì

WeeklyRecurrenceSchedule

Pianificazione della ricorrenza settimanale.

Name	Type	Description	Obbligatorio	Predefinito
giorniDiSettimana	matrice di DayOfWeek	Giorni della settimana per la pianificazione della ricorrenza.	Sì
type	enum	Tipo di ricorrenza settimanale. Valori possibili: Weekly	Sì

WorkflowActionOutputItem

Name	Type	Description	Obbligatorio	Predefinito
action_id	string	Identificatore univoco per l'azione.	Sì
agent_reference	AgentReference		No
└> nome	string	Nome dell'agente. Vincoli: maxLength: 256	Sì
└─ Tipo	enum	Valori possibili: agent_reference	Sì
└─ versione	string	Identificatore della versione dell'agente.	No
kind	string	Tipo di azione CSDL, ad esempio 'SetVariable', 'InvokeAzureAgent'.	Sì
parent_action_id	string	ID dell'azione padre se si tratta di un'azione nidificata.	No
previous_action_id	string	ID dell'azione precedente se questa azione segue un'altra azione.	No
response_id	string	Risposta in base alla quale viene creato l'elemento.	No
Stato	enum	Stato dell'azione ,ad esempio 'in_progress', 'completed', 'failed', 'cancelled'). Valori possibili: completed, failed, in_progress, cancelled	Sì
type	enum	Valori possibili: workflow_action	Sì

WorkflowAgentDefinition

Definizione dell'agente del flusso di lavoro.

Name	Type	Description	Obbligatorio	Predefinito
kind	enum	Valori possibili: workflow	Sì
rai_config	RaiConfig	Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI).	No
└rai_policy_name	string	Nome del criterio RAI da applicare.	Sì
flusso di lavoro	string	Definizione YAML CSDL del flusso di lavoro.	No

integer

Tipo: integer

Formato: int64