Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Versione API: 2025-11-15-preview
Agenti - Creare l'agente
POST {endpoint}/agents?api-version=2025-11-15-preview
Crea l'agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Sì | ||
| └* tipo | AgentKind | NO | ||
| └rai_config | RaiConfig | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| metadata | oggetto | 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 | corda | 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. |
Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - elencare gli agenti
GET {endpoint}/agents?api-version=2025-11-15-preview
Restituisce l'elenco di tutti gli agenti.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| tipo/gentile | query | NO | Filtra gli agenti per tipo. Se non viene fornito, tutti gli agenti vengono restituiti. | |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Ottenere l'agente
GET {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview
Recupera l'agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Agente di aggiornamento
POST {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview
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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Sì | ||
| └* tipo | AgentKind | NO | ||
| └rai_config | RaiConfig | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| metadata | oggetto | 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 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Eliminare l'agente
DELETE {endpoint}/agents/{agent_name}?api-version=2025-11-15-preview
Elimina un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DeleteAgentResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti : aggiornare l'agente dal manifesto
POST {endpoint}/agents/{agent_name}/import?api-version=2025-11-15-preview
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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente da aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| manifest_id | corda | ID manifesto da cui importare la versione dell'agente. | Sì | |
| metadata | oggetto | 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 | oggetto | Input al manifesto che genererà un agente completamente materializzato. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Elencare le operazioni del contenitore dell'agente
GET {endpoint}/agents/{agent_name}/operations?api-version=2025-11-15-preview
Elencare le operazioni del contenitore per un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Ottenere l'operazione del contenitore dell'agente
GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=2025-11-15-preview
Ottenere lo stato di un'operazione contenitore per un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| operation_id | path | Sì | corda | ID operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentContainerOperationObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse o ApiErrorResponse |
Agenti : creare la versione dell'agente
POST {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview
Creare una nuova versione dell'agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | 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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Sì | ||
| └* tipo | AgentKind | NO | ||
| └rai_config | RaiConfig | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| metadata | oggetto | 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 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentVersionObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Elencare le versioni degli agenti
GET {endpoint}/agents/{agent_name}/versions?api-version=2025-11-15-preview
Restituisce l'elenco delle versioni di un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente per cui recuperare le versioni. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Ottenere la versione dell'agente
GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview
Recupera una versione specifica di un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente da recuperare. |
| agent_version | path | Sì | corda | Versione dell'agente da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentVersionObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Eliminare la versione dell'agente
DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=2025-11-15-preview
Elimina una versione specifica di un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente da eliminare. |
| agent_version | path | Sì | corda | Versione dell'agente da eliminare |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DeleteAgentVersionResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti : ottenere il contenitore dell'agente
GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=2025-11-15-preview
Ottenere un contenitore per una versione specifica di un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| agent_version | path | Sì | corda | Versione dell'agente. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentContainerObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Elencare le operazioni del contenitore della versione dell'agente
GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=2025-11-15-preview
Elencare le operazioni del contenitore per una versione specifica di un agente.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| agent_version | path | Sì | corda | Versione dell'agente. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti : eliminare il contenitore dell'agente
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=2025-11-15-preview
Eliminare un contenitore per una versione specifica di un agente. Se il contenitore non esiste, l'operazione verrà 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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| agent_version | path | Sì | corda | Versione dell'agente. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 202
Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentContainerOperationObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti : avviare il contenitore dell'agente
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=2025-11-15-preview
Avviare un contenitore per una versione specifica di un agente. Se il contenitore è già in esecuzione, l'operazione verrà 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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| agent_version | path | Sì | corda | Versione dell'agente. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_replicas | numero intero | Numero massimo di repliche. Il valore predefinito è 1. | NO | 1 |
| min_replicas | numero intero | Numero minimo di repliche. Il valore predefinito è 1. | NO | 1 |
Responses
Codice di stato: 202
Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentContainerOperationObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti - Arrestare il contenitore dell'agente
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=2025-11-15-preview
Arrestare un contenitore per una versione specifica di un agente. Se il contenitore non è in esecuzione o è già stato arrestato, l'operazione verrà 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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| agent_version | path | Sì | corda | Versione dell'agente. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 202
Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentContainerOperationObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse o ApiErrorResponse |
Agenti - Aggiornare il contenitore dell'agente
POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=2025-11-15-preview
Aggiornare un contenitore per una versione specifica di un agente. Se il contenitore non è in esecuzione, l'operazione verrà 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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | Nome dell'agente. |
| agent_version | path | Sì | corda | Versione dell'agente. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_replicas | numero intero | Numero massimo di repliche. | NO | |
| min_replicas | numero intero | Numero minimo di repliche. | NO |
Responses
Codice di stato: 202
Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentContainerOperationObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti : creare la versione dell'agente dal manifesto
POST {endpoint}/agents/{agent_name}/versions:import?api-version=2025-11-15-preview
Creare una nuova versione dell'agente da un manifesto.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| agent_name | path | Sì | corda | 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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| manifest_id | corda | ID manifesto da cui importare la versione dell'agente. | Sì | |
| metadata | oggetto | 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 | oggetto | Input al manifesto che genererà un agente completamente materializzato. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentVersionObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Agenti: creare l'agente dal manifesto
POST {endpoint}/agents:import?api-version=2025-11-15-preview
Crea un agente da un manifesto.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| manifest_id | corda | ID manifesto da cui importare la versione dell'agente. | Sì | |
| metadata | oggetto | 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 | corda | 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. |
Sì | |
| parameter_values | oggetto | Input al manifesto che genererà un agente completamente materializzato. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AgentObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Connessioni - elenco
GET {endpoint}/connections?api-version=2025-11-15-preview
Elencare tutte le connessioni nel progetto, senza popolare le credenziali di connessione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| connectionType | query | NO | Elenca le connessioni di questo tipo specifico | |
| defaultConnection | query | NO | boolean | Elencare le connessioni predefinite |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedConnection |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Connessioni - ottenere
GET {endpoint}/connections/{name}?api-version=2025-11-15-preview
Ottenere una connessione in base al nome, senza popolare le credenziali di connessione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome descrittivo della connessione, fornito dall'utente. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Connessione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Connessioni : ottenere con le credenziali
POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=2025-11-15-preview
Ottenere una connessione per nome, con le relative credenziali di connessione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome descrittivo della connessione, fornito dall'utente. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Connessione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati - Elencare la versione più recente
GET {endpoint}/datasets?api-version=2025-11-15-preview
Elenca la versione più recente di ogni DatasetVersion
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedDatasetVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati - elencare le versioni
GET {endpoint}/datasets/{name}/versions?api-version=2025-11-15-preview
Elenca tutte le versioni del DatasetVersion specificato
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedDatasetVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati - Ottenere la versione
GET {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview
Ottenere la versione specifica di DatasetVersion. Il servizio restituisce l'errore 404 Not Found se DatasetVersion non esiste.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico di DatasetVersion da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DatasetVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati - Eliminare la versione
DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview
Eliminare la versione specifica di DatasetVersion. Il servizio restituisce 204 No Content se DatasetVersion è stato eliminato correttamente o se DatasetVersion non esiste.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | Versione di DatasetVersion da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
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 | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati: creare o aggiornare la versione
PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=2025-11-15-preview
Creare un nuovo DatasetVersion o aggiornare un DatasetVersion esistente con l'ID versione specificato
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico di DatasetVersion da creare o aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/merge-patch+json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| type | oggetto | Enumerazione per determinare il tipo di dati. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DatasetVersion |
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DatasetVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati - Ottenere le credenziali
POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=2025-11-15-preview
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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico di DatasetVersion su cui operare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AssetCredentialResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Set di dati: avviare la versione di caricamento in sospeso
POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=2025-11-15-preview
Avviare un nuovo caricamento o ottenere un caricamento in sospeso esistente di un set di dati per una versione specifica.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico di DatasetVersion su cui operare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| connectionName | corda | 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 | corda | Se PendingUploadId non viene specificato, verrà usato un GUID casuale. | NO | |
| pendingUploadType | enum | BlobReference è l'unico tipo supportato. Valori possibili: BlobReference |
Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PendingUploadResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Distribuzioni - elenco
GET {endpoint}/deployments?api-version=2025-11-15-preview
Elencare tutti i modelli distribuiti nel progetto
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| modelPublisher | query | NO | corda | Editore di modelli per filtrare i modelli in base a |
| modelName | query | NO | corda | Nome del modello (il nome specifico dell'editore) per filtrare i modelli in base al quale |
| deploymentType | query | NO | Tipo di distribuzione per filtrare l'elenco in base al quale | |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedDeployment |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Distribuzioni : ottenere
GET {endpoint}/deployments/{name}?api-version=2025-11-15-preview
Ottieni un modello distribuito.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della distribuzione |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Deployment |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Regole di valutazione - elenco
GET {endpoint}/evaluationrules?api-version=2025-11-15-preview
Elenca tutte le regole di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| actionType | query | NO | Filtrare in base al tipo di regola di valutazione. | |
| nomeagente | query | NO | corda | Filtra in base al nome dell'agente. |
| enabled | query | NO | boolean | Filtra in base allo stato abilitato. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedEvaluationRule |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Regole di valutazione - get
GET {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview
Ottenere una regola di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore univoco per la regola di valutazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationRule |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Regole di valutazione - eliminazione
DELETE {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview
Eliminare una regola di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore univoco per la regola di valutazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
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 | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Regole di valutazione: creare o aggiornare
PUT {endpoint}/evaluationrules/{id}?api-version=2025-11-15-preview
Creare o aggiornare una regola di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore univoco per la regola di valutazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | oggetto | Modello di azione di valutazione. | Sì | |
| └─ Tipo | EvaluationRuleActionType | Tipo di azione di valutazione. | NO | |
| descrizione | corda | Descrizione della regola di valutazione. | NO | |
| nome visualizzato | corda | Nome visualizzato per la regola di valutazione. | NO | |
| enabled | boolean | Indica se la regola di valutazione è abilitata. Il valore predefinito è vero. | Sì | |
| eventType | oggetto | Tipo di evento della regola di valutazione. | Sì | |
| filtro | oggetto | Modello di filtro di valutazione. | NO | |
| └* agentName | corda | Filtra in base al nome dell'agente. | NO | |
| id | corda | Identificatore univoco per la regola di valutazione. | Sì | |
| dati di sistema | oggetto | Metadati di sistema per la regola di valutazione. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationRule |
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationRule |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Tassonomie di valutazione - elenco
GET {endpoint}/evaluationtaxonomies?api-version=2025-11-15-preview
Elenco delle tassonomie di valutazione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| inputName | query | NO | corda | Filtrare in base al nome dell'input di valutazione. |
| inputType | query | NO | corda | Filtrare in base al tipo di input della tassonomia. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedEvaluationTaxonomy |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Tassonomie di valutazione - get
GET {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview
Ottenere una valutazione eseguita per nome.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationTaxonomy |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Tassonomie di valutazione - eliminazione
DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview
Eliminare una tassonomia di valutazione in base al nome.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
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 | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Tassonomie di valutazione : creazione
PUT {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview
Creare una tassonomia di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della tassonomia di valutazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| proprietà | oggetto | Proprietà aggiuntive per la tassonomia di valutazione. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| tassonomiaCategorie | array | Elenco delle categorie di tassonomia. | NO | |
| tassonomiaInput | oggetto | Configurazione di input per la tassonomia di valutazione. | Sì | |
| └─ Tipo | EvaluationTaxonomyInputType | Tipo di input della tassonomia di valutazione. | NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationTaxonomy |
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationTaxonomy |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Tassonomie di valutazione - aggiornamento
PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=2025-11-15-preview
Aggiornare una tassonomia di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della tassonomia di valutazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| proprietà | oggetto | Proprietà aggiuntive per la tassonomia di valutazione. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| tassonomiaCategorie | array | Elenco delle categorie di tassonomia. | NO | |
| tassonomiaInput | oggetto | Configurazione di input per la tassonomia di valutazione. | NO | |
| └─ Tipo | EvaluationTaxonomyInputType | Tipo di input della tassonomia di valutazione. | NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvaluationTaxonomy |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Analizzatori - Elencare le versioni più recenti
GET {endpoint}/evaluators?api-version=2025-11-15-preview
Elenca l'ultima versione di ogni analizzatore
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| type | query | NO | Filtrare gli analizzatori in base al tipo. Valori possibili: 'all', 'custom', 'builtin'. | |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedEvaluatorVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Analizzatori - Elencare le versioni
GET {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview
Elenca tutte le versioni dell'analizzatore specificato
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| type | query | NO | Filtrare gli analizzatori in base al tipo. Valori possibili: 'all', 'custom', 'builtin'. | |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedEvaluatorVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Analizzatori - Creare la versione
POST {endpoint}/evaluators/{name}/versions?api-version=2025-11-15-preview
Creare un nuovo EvaluatorVersion con ID versione incrementato automaticamente
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| categories | array | Le categorie del valutatore | Sì | |
| Definizione | oggetto | Configurazione dell'analizzatore di base con discriminatore | Sì | |
| └data_schema | Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| └init_parameters | Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| └* Metriche | oggetto | Elenco delle metriche di output prodotte da questo valutatore | NO | |
| └─ Tipo | AnalizzatoreDefinitionType | Il tipo di definizione del valutatore | NO | |
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| display_name | corda | Nome visualizzato per l'analizzatore. Aiuta a trovare facilmente l'analizzatore in Foundry. Non è necessario che sia univoco. | NO | |
| evaluator_type | oggetto | Il tipo di valutatore | Sì | |
| metadata | oggetto | Metadati relativi all'analizzatore | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO |
Responses
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AnalizzatoreVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Analizzatori : ottenere la versione
GET {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview
Ottenere la versione specifica di EvaluatorVersion. Il servizio restituisce l'errore 404 Not Found se EvaluatorVersion non esiste.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico dell'analizzatoreVersion da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AnalizzatoreVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Analizzatori - Eliminare la versione
DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview
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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | Versione di EvaluatorVersion da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
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 | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Analizzatori - versione di aggiornamento
PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=2025-11-15-preview
Aggiorna un EvaluatorVersion esistente con l'ID versione specificato
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | Versione di EvaluatorVersion da aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| categories | array | Le categorie del valutatore | NO | |
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| display_name | corda | Nome visualizzato per l'analizzatore. Aiuta a trovare facilmente l'analizzatore in Foundry. Non è necessario che sia univoco. | NO | |
| metadata | oggetto | Metadati relativi all'analizzatore | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | AnalizzatoreVersion |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Indici - elenco più recente
GET {endpoint}/indexes?api-version=2025-11-15-preview
Elenca l'ultima versione di ciascun indice
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedIndex |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Indici - elencare le versioni
GET {endpoint}/indexes/{name}/versions?api-version=2025-11-15-preview
Elenca tutte le versioni dell'indice dato
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedIndex |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Indici - ottenere la versione
GET {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview
Ottieni la versione specifica dell'indice. Il servizio restituisce l'errore 404 Non trovato se l'indice non esiste.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico dell'indice da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Indice |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Indici - Eliminare la versione
DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview
Elimina 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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | La versione dell'indice da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
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 | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Indici : creare o aggiornare la versione
PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=2025-11-15-preview
Creare un nuovo indice o aggiornare un indice esistente con l'ID versione specificato
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome della risorsa |
| version | path | Sì | corda | ID versione specifico dell'indice da creare o aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/merge-patch+json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| type | oggetto | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Indice |
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Indice |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Informazioni dettagliate : genera
POST {endpoint}/insights?api-version=2025-11-15-preview
Genera approfondimenti
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| Ripetibilità-Request-ID | intestazione | NO | corda | 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 | intestazione | NO | corda | Timestamp che indica quando la richiesta è stata avviata per la prima volta. Utilizzato in combinazione con repeatability-request-id per il controllo dell'idempotenza. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome visualizzato | corda | Nome visualizzato descrittivo per l'approfondimento. | Sì | |
| id | corda | L'identificatore univoco per il report di informazioni dettagliate. | Sì | |
| metadata | oggetto | Metadati relativi alle informazioni dettagliate. | Sì | |
| └* completedAt | corda | Il timestamp in cui sono state completate le informazioni dettagliate. | NO | |
| └> createdAt | corda | Il timestamp in cui sono state create le informazioni dettagliate. | NO | |
| request | oggetto | La richiesta del report di approfondimento. | Sì | |
| └─ Tipo | InsightType | Tipo di richiesta. | NO | |
| risultato | oggetto | Il risultato degli approfondimenti. | NO | |
| └─ Tipo | InsightType | Il tipo di risultato delle informazioni dettagliate. | NO | |
| state | oggetto | Enumerazione che descrive gli stati di funzionamento consentiti. | Sì |
Responses
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Intuzione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Informazioni dettagliate - elenco
GET {endpoint}/insights?api-version=2025-11-15-preview
Elenca tutte le informazioni dettagliate in ordine cronologico inverso (prima il più recente).
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| type | query | NO | Filtra in base al tipo di analisi. | |
| evalId | query | NO | corda | Filtrare in base all'ID di valutazione. |
| runId | query | NO | corda | Filtrare in base all'ID dell'esecuzione della valutazione. |
| nomeagente | query | NO | corda | 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. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedInsight |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Informazioni dettagliate - Ottenere
GET {endpoint}/insights/{id}?api-version=2025-11-15-preview
Ottieni informazioni dettagliate specifiche in base all'ID.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | L'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. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Intuzione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Creare un archivio di memoria
POST {endpoint}/memory_stores?api-version=2025-11-15-preview
Creare un archivio di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Definizione di base per le configurazioni dell'archivio di memoria. | Sì | |
| └* tipo | MemoryStoreKind | Il tipo di memoria memorizzata. | NO | |
| descrizione | corda | Una descrizione leggibile dall'uomo dell'archivio di memoria. | NO | |
| metadata | oggetto | Metadati chiave-valore arbitrari da associare all'archivio di memoria. | NO | |
| nome | corda | Il nome dell'archivio di memoria. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare gli archivi di memoria
GET {endpoint}/memory_stores?api-version=2025-11-15-preview
Elencare tutti gli archivi di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Aggiornare l'archivio memoria
POST {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview
Aggiornare un archivio di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome dell'archivio di memoria da aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dall'uomo dell'archivio di memoria. | NO | |
| metadata | oggetto | Metadati chiave-valore arbitrari da associare all'archivio di memoria. | NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Ottenere l'archivio di memoria
GET {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview
Recuperare un archivio di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome dell'archivio di memoria da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreObject |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Eliminare l'archivio memoria
DELETE {endpoint}/memory_stores/{name}?api-version=2025-11-15-preview
Eliminare un archivio di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome dell'archivio di memoria da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DeleteMemoryStoreResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Ottenere il risultato dell'aggiornamento
GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=2025-11-15-preview
Ottenere il risultato dell'aggiornamento dell'archivio di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Il nome dell'archivio di memoria. |
| update_id | path | Sì | corda | ID dell'operazione di aggiornamento della memoria. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreUpdateResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Eliminare i ricordi dell'ambito
POST {endpoint}/memory_stores/{name}:delete_scope?api-version=2025-11-15-preview
Eliminare tutte le memorie associate a un oscilloscopio specifico da un archivio di memoria.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Il nome dell'archivio di memoria. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| scopo | corda | Spazio dei nomi che raggruppa logicamente e isola i ricordi da eliminare, ad esempio un ID utente. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreDeleteScopeResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Cerca ricordi
POST {endpoint}/memory_stores/{name}:search_memories?api-version=2025-11-15-preview
Cerca ricordi rilevanti da un archivio di memoria in base al contesto della conversazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome dell'archivio di memoria da cercare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| elementi | array | Oggetti per i quali cercare ricordi rilevanti. | NO | |
| options | oggetto | Opzioni di ricerca in memoria. | NO | |
| └max_memories | numero intero | Numero massimo di elementi di memoria da restituire. | NO | |
| previous_search_id | corda | L'ID univoco della richiesta di ricerca precedente, che consente la ricerca incrementale in memoria dal punto in cui è stata interrotta l'ultima operazione. | NO | |
| scopo | corda | Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreSearchResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Aggiornare i ricordi
POST {endpoint}/memory_stores/{name}:update_memories?api-version=2025-11-15-preview
Aggiorna l'archivio di memoria con le memorie di conversazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Nome dell'archivio di memoria da aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| elementi | array | Elementi di conversazione da cui estrarre ricordi. | NO | |
| previous_update_id | corda | L'ID univoco della richiesta di aggiornamento precedente, che consente gli aggiornamenti incrementali della memoria dal punto in cui è stata interrotta l'ultima operazione. | NO | |
| scopo | corda | Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente. | Sì | |
| update_delay | numero intero | Periodo di timeout prima dell'elaborazione dell'aggiornamento della memoria in secondi. Se durante questo periodo viene ricevuta una nuova richiesta di aggiornamento, la richiesta corrente verrà annullata e il timeout verrà reimpostato. Impostare su 0 per attivare immediatamente l'aggiornamento senza indugio. Il valore predefinito è 300 (5 minuti). |
NO | 300 |
Responses
Codice di stato: 202
Descrizione: la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | MemoryStoreUpdateResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Creare una conversazione
POST {endpoint}/openai/conversations?api-version=2025-11-15-preview
Creare una conversazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| elementi | array | Elementi iniziali da includere nel contesto della conversazione. È possibile aggiungere fino a 20 elementi alla volta. |
NO | |
| metadata | oggetto | 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 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare le conversazioni
GET {endpoint}/openai/conversations?api-version=2025-11-15-preview
Restituisce l'elenco di tutte le conversazioni.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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 | corda | Filtra in base al nome dell'agente. Se specificato, verranno restituiti solo gli elementi associati all'agente specificato. |
| agent_id | query | NO | corda | Filtrare in base all'ID agente nel formato name:version. Se specificato, verranno restituiti solo gli elementi associati all'ID agente specificato. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Aggiornare la conversazione
POST {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview
Aggiornare una conversazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione da aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| metadata | oggetto | 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 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Ottenere una conversazione
GET {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview
Recupera una conversazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elimina conversazione
DELETE {endpoint}/openai/conversations/{conversation_id}?api-version=2025-11-15-preview
Elimina una conversazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.DeletedConversationResource |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Creare elementi di conversazione
POST {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview
Creare elementi in una conversazione con l'ID specificato.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione in cui deve essere creato l'elemento. |
| includi | query | NO | array | Campi aggiuntivi da includere nella risposta. Per altre informazioni, vedere il include parametro per elencare gli elementi di conversazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| elementi | array | Elementi da aggiungere alla conversazione. È possibile aggiungere fino a 20 elementi alla volta. | Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ConversationItemList |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare gli elementi della conversazione
GET {endpoint}/openai/conversations/{conversation_id}/items?api-version=2025-11-15-preview
Elencare tutti gli elementi per una conversazione con l'ID specificato.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione in cui devono essere elencati gli elementi. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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 | Filtra per tipo di elemento. Se specificato, verranno restituiti solo gli elementi del tipo specificato. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Ottenere l'elemento della conversazione
GET {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview
Ottenere un singolo elemento da una conversazione con gli ID specificati.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione che contiene l'elemento. |
| item_id | path | Sì | corda | ID dell'elemento della conversazione da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ItemResource |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Eliminare l'elemento della conversazione
DELETE {endpoint}/openai/conversations/{conversation_id}/items/{item_id}?api-version=2025-11-15-preview
Eliminare un elemento da una conversazione con gli ID specificati.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| conversation_id | path | Sì | corda | ID della conversazione da cui deve essere eliminato l'elemento. |
| item_id | path | Sì | corda | ID dell'elemento della conversazione da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ConversationResource |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - list evals
GET {endpoint}/openai/evals?api-version=2025-11-15-preview
Elencare tutte le valutazioni Elencare le valutazioni per un progetto.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| dopo | query | NO | corda | Identificatore dell'ultima esecuzione della richiesta di impaginazione precedente. |
| limit | query | NO | Numero di esecuzioni da recuperare. | |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinamento delle esecuzioni in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente. Il valore predefinito è asc. |
| ordina per | query | NO | corda Valori possibili: created_at, updated_at |
Le valutazioni possono essere ordinate in base all'ora di creazione o all'ultima ora di aggiornamento. Utilizzocreated_at per l'ora di creazione o updated_at per l'ora dell'ultimo aggiornamento. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Creare eval
POST {endpoint}/openai/evals?api-version=2025-11-15-preview
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
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| configurazione_sorgente_dati | oggetto | 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 |
Sì | |
| └include_sample_schema | 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 | |
| └item_schema | oggetto | Schema JSON per ogni riga nell'origine dati. | NO | |
| └─ metadati | oggetto | Filtri dei metadati per l'origine dati dei completamenti archiviati. | NO | |
| Scenario └* | enum | Scenario dello schema dei dati. Valori possibili: red_team, responses, traces |
NO | |
| └─ Tipo | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: azure_ai_source |
NO | |
| 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. |
NO | |
| nome | corda | Nome della valutazione. | NO | |
| proprietà | oggetto | 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 | array | Elenco di classificatori per tutte le esecuzioni di valutazione in questo gruppo. I classificatori possono fare riferimento alle 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 spazio dei nomi sample (ad esempio, {{sample.output_text}}). |
Sì |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Valutazione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - delete eval
DELETE {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview
Eliminare una valutazione Consente di eliminare una valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DeleteEvalResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - get eval
GET {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview
Ottenere una valutazione Ottenere una valutazione in base all'ID.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Valutazione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - update eval
POST {endpoint}/openai/evals/{eval_id}?api-version=2025-11-15-preview
Aggiornare una valutazione Aggiornare determinate proprietà di una valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione da aggiornare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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. |
NO | |
| nome | corda | NO | ||
| proprietà | oggetto | 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 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Valutazione |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Esecuzioni elenco
GET {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview
Ottenere un elenco di esecuzioni per una valutazione Ottenere un elenco di esecuzioni per una valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione per la quale recuperare le esecuzioni. |
| dopo | query | NO | corda | Identificatore dell'ultima esecuzione della richiesta di impaginazione precedente. |
| limit | query | NO | Numero di esecuzioni da recuperare. | |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinamento delle esecuzioni in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente. Il valore predefinito è asc. |
| stato | query | NO | corda Valori possibili: queued, in_progresscompleted, , canceled, failed . Filtra le esecuzioni per stato. Uno di queued, in_progress, failedcompleted, , canceled. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Creare eval run
POST {endpoint}/openai/evals/{eval_id}/runs?api-version=2025-11-15-preview
Creare un'esecuzione di valutazione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione per la quale creare un'esecuzione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| fonte_dati | oggetto | Oggetto JsonlRunDataSource con che specifica un file JSONL che corrisponde all'eval | Sì | |
| └ input_messages | 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 | |
| └item_generation_params | RedTeamItemGenerationParams | Parametri per la generazione di elementi. | NO | |
| └─ Modello | corda | Nome del modello da utilizzare per la generazione di completamenti, ad esempio "o3-mini". | NO | |
| └sampling_params | OpenAI.CreateEvalResponsesRunDataSourceSamplingParams | NO | ||
| └─ sorgente | OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalResponsesSource | Determina il popolamento dello item spazio dei nomi nell'origine dati di questa esecuzione. |
NO | |
| Destinazione └* | Destinazione | Configurazione di destinazione per la valutazione. | NO | |
| └─ Tipo | corda | Discriminare del tipo di origine dati. | NO | |
| 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. |
NO | |
| nome | corda | Nome della corsa. | NO | |
| proprietà | oggetto | 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 |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvalRun |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Delete eval run
DELETE {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview
Eliminare l'esecuzione della valutazione Eliminare un'esecuzione di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione dalla quale eliminare l'esecuzione. |
| run_id | path | Sì | corda | ID della sessione di esecuzione da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DeleteEvalRunResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Get eval run
GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview
Ottenere un'esecuzione di valutazione Ottenere un'esecuzione di valutazione in base all'ID.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione per la quale recuperare le esecuzioni. |
| run_id | path | Sì | corda | ID dell'esecuzione da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvalRun |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Annullare l'esecuzione di eval
POST {endpoint}/openai/evals/{eval_id}/runs/{run_id}?api-version=2025-11-15-preview
Annullare l'esecuzione della valutazione Annullare un'esecuzione di valutazione in corso.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione per la quale si desidera annullare l'esecuzione. |
| run_id | path | Sì | corda | ID dell'esecuzione da annullare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvalRun |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Ottenere gli elementi di output dell'esecuzione di eval
GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items?api-version=2025-11-15-preview
Ottenere gli elementi di output dell'esecuzione della valutazione Ottenere un elenco di elementi di output per un'esecuzione di valutazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | |
| run_id | path | Sì | corda | ID dell'esecuzione per la quale recuperare gli elementi di output. |
| dopo | query | NO | corda | Identificatore dell'ultima esecuzione della richiesta di impaginazione precedente. |
| limit | query | NO | Numero di esecuzioni da recuperare. | |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinamento delle esecuzioni in base al timestamp. Usare asc per l'ordine crescente o desc per l'ordine decrescente. Il valore predefinito è asc. |
| stato | query | NO | corda Valori possibili: fail, pass |
Filtrare gli elementi di output in base allo stato. Usare failed per filtrare in base all'output non riuscitoelementi o pass per filtrare in base agli elementi di output passati. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
OpenAI evals - Ottenere l'elemento di output dell'esecuzione di eval
GET {endpoint}/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=2025-11-15-preview
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
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| eval_id | path | Sì | corda | ID della valutazione per la quale recuperare le esecuzioni. |
| run_id | path | Sì | corda | ID dell'esecuzione da recuperare. |
| output_item_id | path | Sì | corda | ID dell'elemento di output da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | EvalRunOutputItem |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Creare un processo di ottimizzazione fine
POST {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview
Crea un processo di ottimizzazione che inizia il processo di creazione di un nuovo modello da un set di dati specificato.
La risposta include i dettagli del processo accodato, inclusi lo stato del processo e il nome dei modelli ottimizzati al termine.
Altre informazioni sull'ottimizzazione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| iperparametri | oggetto | Iperparametri usati per il processo di ottimizzazione. Questo valore è ora deprecato a favore di methode deve essere passato sotto il parametro method. |
NO | |
| └' batch_size | enum | Valori possibili: auto |
NO | |
| └' learning_rate_multiplier | enum | Valori possibili: auto |
NO | |
| └' n_epochs | enum | Valori possibili: auto |
NO | |
| integrazioni | array | Elenco di integrazioni da abilitare per il processo di ottimizzazione. | NO | |
| metadata | oggetto | 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 uno dei modelli supportati. |
Sì | |
| seed | numero intero | Il seme controlla la riproducibilità del lavoro. Il passaggio degli stessi parametri di inizializzazione e processo dovrebbe produrre gli stessi risultati, ma in rari casi può differire. Se non viene specificato un valore di inizializzazione, ne verrà generato uno automaticamente. |
NO | |
| suffix | corda | Stringa di un massimo di 64 caratteri che verrà aggiunta al nome del modello ottimizzato. Ad esempio, un suffix oggetto "custom-model-name" produrrebbe un nome di modello come ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. |
NO | None |
| file di allenamento | corda | ID di un file caricato che contiene i dati di training. 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 delle preferenze. Per altri dettagli, vedere la guida all'ottimizzazione. |
Sì | |
| file_di_validazione | corda | ID di un file caricato contenente 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 nel file dei risultati dell'ottimizzazione. Gli stessi dati non devono essere presenti sia nei file di training sia nei file di convalida. Il set di dati deve essere formattato come file JSONL. È necessario caricare il file con lo scopo fine-tune.Per altri dettagli, vedere la guida all'ottimizzazione. |
NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare i processi di ottimizzazione delle prestazioni impaginati
GET {endpoint}/openai/fine-tuning/jobs?api-version=2025-11-15-preview
Elencare i processi di ottimizzazione dell'organizzazione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| dopo | query | NO | corda | Identificatore dell'ultimo processo della richiesta di paginazione precedente. |
| limit | query | NO | numero intero | Numero di processi di ottimizzazione da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ListPaginatedFineTuningJobsResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Recuperare un processo di ottimizzazione fine
GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}?api-version=2025-11-15-preview
Ottenere informazioni su un processo di ottimizzazione.
Altre informazioni sull'ottimizzazione
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id_lavoro_affinamento | path | Sì | corda | ID del processo di ottimizzazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Annullare il processo di ottimizzazione
POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/cancel?api-version=2025-11-15-preview
Annullare immediatamente un processo di ottimizzazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id_lavoro_affinamento | path | Sì | corda | ID del processo di ottimizzazione da annullare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare i checkpoint dei processi di ottimizzazione
GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=2025-11-15-preview
Elencare i checkpoint per un processo di ottimizzazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id_lavoro_affinamento | path | Sì | corda | ID del processo di ottimizzazione per cui ottenere i checkpoint. |
| dopo | query | NO | corda | Identificatore dell'ultimo ID del checkpoint della richiesta di paginazione precedente. |
| limit | query | NO | numero intero | Numero di checkpoint da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ListFineTuningJobCheckpointsResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare gli eventi del processo di ottimizzazione
GET {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/events?api-version=2025-11-15-preview
Ottenere aggiornamenti dello stato con granularità fine per un processo di ottimizzazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id_lavoro_affinamento | path | Sì | corda | ID del processo di ottimizzazione per cui ottenere gli eventi. |
| dopo | query | NO | corda | Identificatore dell'ultimo evento della richiesta di paginazione precedente. |
| limit | query | NO | numero intero | Numero di eventi da recuperare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.ListFineTuningJobEventsResponse |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Sospendere il processo di ottimizzazione fine
POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/pause?api-version=2025-11-15-preview
Sospendere un processo di ottimizzazione in esecuzione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id_lavoro_affinamento | path | Sì | corda | ID del processo di ottimizzazione da sospendere. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Riprendere il processo di ottimizzazione
POST {endpoint}/openai/fine-tuning/jobs/{fine_tuning_job_id}/resume?api-version=2025-11-15-preview
Riprendere un processo di ottimizzazione sospeso.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id_lavoro_affinamento | path | Sì | corda | ID del processo di ottimizzazione da riprendere. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.FineTuningJob |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Creare una risposta : creare il flusso di risposta
POST {endpoint}/openai/responses?api-version=2025-11-15-preview
Crea una risposta del modello. Crea una risposta del modello (risposta di streaming).
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | NO | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| agent | AgentReference | Agente da usare per generare la risposta. | NO | |
| sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| conversazione | stringa o oggetto | NO | ||
| includi | array | Specificare dati di output aggiuntivi da includere nella risposta del modello. Attualmente i valori supportati sono: - code_interpreter_call.outputs: include gli output dell'esecuzione del codice Pythonnegli elementi di chiamata dello strumento dell'interprete di codice. - computer_call_output.output.image_url: includere gli URL delle immagini provenienti dall'output della chiamata computer.- file_search_call.results: includere i risultati della ricerca dirichiesta allo strumento di ricerca dei file. - message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.- message.output_text.logprobs: includere logprob con messaggi di assistente.- reasoning.encrypted_content: include una versione crittografata del motivotoken nell'output dell'elemento di ragionamento. In questo modo è possibile utilizzare gli elementi di ragionamento in conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su false o quando un'organizzazione èregistrato nel programma a conservazione dati nulla. |
NO | |
| ingresso | stringa o matrice | 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 - Gestione dello stato della conversazione - Chiamata di funzione |
NO | |
| instructions | corda | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| metadata | oggetto | 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 | corda | Il modello di distribuzione da utilizzare per la creazione di questa risposta. | NO | |
| chiamate_parallele_agli_strumenti | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| reasoning | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| livello_servizio | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | NO | |
| store | boolean | Indica se archiviare la risposta del modello generata per il recupero successivo tramite API. |
NO | Vero |
| torrente | boolean | Se impostato su true, i dati di risposta del modello verranno trasmessi al client generato tramite eventi inviati dal server. per altre informazioni. |
NO | Falso |
| structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | 1 |
| Testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| strumenti | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: - Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca di file. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. |
NO | |
| top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | 1 |
| truncation | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. Valori possibili: auto, disabled |
NO | |
| utente | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.Response | |
| text/event-stream | OpenAI.ResponseStreamEvent |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare le risposte
GET {endpoint}/openai/responses?api-version=2025-11-15-preview
Restituisce l'elenco di tutte le risposte.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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 | corda | Filtra in base al nome dell'agente. Se specificato, verranno restituiti solo gli elementi associati all'agente specificato. |
| agent_id | query | NO | corda | 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 | corda | Filtrare in base all'ID conversazione. Se specificato, verranno restituite solo le risposte associate alla conversazione specificata. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Ottenere la risposta : ottenere il flusso di risposta
GET {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview
Recupera una risposta del modello con l'ID specificato. Recupera una risposta del modello con l'ID specificato (risposta di streaming).
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | NO | corda | Versione dell'API da usare per questa operazione. |
| response_id | path | Sì | corda | |
| include[] | query | NO | array | |
| torrente | query | NO | boolean | |
| starting_after | query | NO | numero intero | |
| accettare | intestazione | NO | corda Valori possibili: text/event-stream |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.Response | |
| text/event-stream | OpenAI.ResponseStreamEvent |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Eliminare la risposta
DELETE {endpoint}/openai/responses/{response_id}?api-version=2025-11-15-preview
Elimina una risposta del modello.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| response_id | path | Sì | corda | ID della risposta da eliminare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | DeleteResponseResult |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Annulla risposta
POST {endpoint}/openai/responses/{response_id}/cancel?api-version=2025-11-15-preview
Annulla una risposta del modello.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| response_id | path | Sì | corda | ID della risposta da annullare. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | OpenAI.Response |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Elencare gli elementi di input
GET {endpoint}/openai/responses/{response_id}/input_items?api-version=2025-11-15-preview
Restituisce un elenco di elementi di input per una determinata risposta.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| response_id | path | Sì | corda | |
| limit | query | NO | numero intero | Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. |
| order | query | NO | corda Valori possibili: asc, desc |
Ordinare l'ordinamento in base al created_at timestamp degli oggetti.
asc per l'ordine crescente edescper ordine decrescente. |
| dopo | query | NO | corda | Cursore da usare nell'impaginazione.
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 | corda | Cursore da usare nell'impaginazione.
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. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | oggetto | Dati di risposta per un elenco di elementi richiesto. |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ApiErrorResponse |
Redteams - elenco
GET {endpoint}/redTeams/runs?api-version=2025-11-15-preview
Elenca un redteam per nome.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedRedTeam |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Redteams - ottieni
GET {endpoint}/redTeams/runs/{name}?api-version=2025-11-15-preview
Prendi un redteam per nome.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| nome | path | Sì | corda | Identificatore della corsa della squadra rossa. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | RedTeam |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Redteams - Create
POST {endpoint}/redTeams/runs:run?api-version=2025-11-15-preview
Crea una corsa redteam.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| applicationScenario | corda | Scenario applicativo per l'operazione red team, per generare attacchi specifici dello scenario. | NO | |
| attackStrategies | array | Elenco di strategie di attacco o elenchi nidificati di strategie di attacco. | NO | |
| nome visualizzato | corda | Nome della corsa della squadra rossa. | NO | |
| id | corda | Identificatore della corsa della squadra rossa. | Sì | |
| numTurns | numero intero | Numero di round di simulazione. | NO | |
| proprietà | oggetto | Proprietà della squadra rossa. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà. | NO | |
| riskCategories | array | Elenco delle categorie di rischio per cui generare obiettivi di attacco. | NO | |
| simulationOnly | boolean | Solo simulazione o Simulazione + Valutazione. Impostazione predefinita: false, se true la scansione restituisce la conversazione, non il risultato della valutazione. | NO | Falso |
| stato | corda | Stato della squadra rossa. Viene impostato dal servizio ed è di sola lettura. | NO | |
| tags | oggetto | Tag della squadra rossa. A differenza delle proprietà, i tag sono completamente modificabili. | NO | |
| target | oggetto | Classe astratta per la configurazione del target. | Sì | |
| └─ Tipo | corda | Tipo di configurazione del modello. | NO |
Responses
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | RedTeam |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Pianificazioni - elenco
GET {endpoint}/schedules?api-version=2025-11-15-preview
Elenca tutti gli orari.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedSchedule |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Pianificazioni - eliminazione
DELETE {endpoint}/schedules/{id}?api-version=2025-11-15-preview
Elimina una pianificazione.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore della pianificazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
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 | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Pianificazioni : ottenere
GET {endpoint}/schedules/{id}?api-version=2025-11-15-preview
Ottieni un programma per id.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore della pianificazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Schedule |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Pianificazioni : creazione o aggiornamento
PUT {endpoint}/schedules/{id}?api-version=2025-11-15-preview
Creare o aggiornare una pianificazione in base all'ID.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore della pianificazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Corpo della richiesta
Content-Type: application/json
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione della pianificazione. | NO | |
| nome visualizzato | corda | Nome della pianificazione. | NO | |
| enabled | boolean | Stato abilitato della pianificazione. | Sì | |
| id | corda | Identificatore della pianificazione. | Sì | |
| proprietà | oggetto | Proprietà del programma. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà. | NO | |
| provisioningStatus | oggetto | Pianificare lo stato del provisioning. | NO | |
| dati di sistema | oggetto | Metadati di sistema per la risorsa. | Sì | |
| tags | oggetto | Tag del programma. A differenza delle proprietà, i tag sono completamente modificabili. | NO | |
| compito | oggetto | Modello di attività di pianificazione. | Sì | |
| Configurazione di └* | oggetto | Configurazione per l'attività. | NO | |
| └─ Tipo | ScheduleTaskType | Tipo dell'attività. | NO | |
| trigger | oggetto | Modello base per il Trigger del programma. | Sì | |
| └─ Tipo | TriggerType | Tipo di trigger. | NO |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Schedule |
Codice di stato: 201
Descrizione: la richiesta è riuscita e di conseguenza è stata creata una nuova risorsa.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Schedule |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Pianificazioni - Esecuzioni elenco
GET {endpoint}/schedules/{id}/runs?api-version=2025-11-15-preview
Elenca tutte le esecuzioni pianificate.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| id | path | Sì | corda | Identificatore della pianificazione. |
| x-ms-client-request-id | intestazione | NO | Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | PagedScheduleRun |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Pianificazioni - Get Run
GET {endpoint}/schedules/{scheduleId}/runs/{runId}?api-version=2025-11-15-preview
Ottenere una pianificazione eseguita in base all'ID.
Parametri dell'URI
| Nome | In | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|---|
| endpoint | path | Sì | corda URL. |
Endpoint del progetto Foundry nel formato https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}. Se nell'hub Foundry è presente un solo progetto o se si ha come destinazione il progetto predefinito nell'hub, usare il modulo https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project |
| versione-api | query | Sì | corda | Versione dell'API da usare per questa operazione. |
| scheduleId | path | Sì | corda | Identificatore della pianificazione. |
| runId | path | Sì | corda | Identificatore dell'esecuzione della pianificazione. |
Intestazione della richiesta
| Nome | Obbligatorio | TIPO | Descrzione |
|---|---|---|---|
| Autorizzazione | Vero | corda |
Esempio:Authorization: Bearer {Azure_AI_Foundry_Project_Auth_Token}Per generare un token di autenticazione tramite l'interfaccia della riga di comando di Azure: az account get-access-token --resource https://ai.azure.com/Tipo: oauth2 URL autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeambito: https://ai.azure.com/.default |
Responses
Codice di stato: 200
Descrizione: la richiesta ha avuto esito positivo.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | ScheduleRun |
Codice di stato: impostazione predefinita
Descrizione: risposta di errore imprevista.
| Tipo di contenuto | Tipo | Descrizione |
|---|---|---|
| application/json | Azure.Core.Foundations.ErrorResponse |
Components
A2ATool
Un agente che implementa il protocollo A2A.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| agent_card_path | corda | Il percorso della scheda agente relativa a .base_urlSe non specificato, il valore predefinito è /.well-known/agent-card.json |
NO | |
| base_url | corda | URL di base dell'agente. | NO | |
| project_connection_id | corda | L'ID di connessione nel progetto 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.Valori possibili: a2a_preview |
Sì |
AISearchIndexResource
Una risorsa dell'indice di ricerca AI.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| filtro | corda | Stringa di filtro per la risorsa di ricerca. Altre informazioni sono disponibili qui. | NO | |
| index_asset_id | corda | ID asset dell'indice per la risorsa di ricerca. | NO | |
| index_name | corda | Nome di un indice in un oggetto IndexResource associato a questo agente. | NO | |
| project_connection_id | corda | ID di connessione all'indice in un oggetto IndexResource collegato all'agente. | NO | |
| tipo di query | oggetto | Tipi di query disponibili per lo strumento di ricerca di intelligenza artificiale di Azure. | NO | |
| top_k | numero intero | Numero di documenti da recuperare dalla ricerca e presenti al modello. | NO |
AgentClusterInsightResult
Informazioni dettagliate dall'analisi del cluster di agenti.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| clusterInsight | ClusterInsightResult | Approfondimenti dall'analisi dei cluster. | Sì | |
| type | enum | Il tipo di risultato delle informazioni dettagliate. Valori possibili: AgentClusterInsight |
Sì |
AgentClusterInsightsRequest
Informazioni dettagliate sul set di risultati della valutazione dell'agente
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nomeagente | corda | Identificatore dell'agente. | Sì | |
| modelConfiguration | oggetto | Configurazione del modello utilizzato nella generazione dell'insight. | NO | |
| └* modelDeploymentName | corda | Distribuzione del modello da valutare. Accetta solo il nome della distribuzione o con il nome della connessione come {connectionName}/<modelDeploymentName>. |
NO | |
| type | enum | Tipo di richiesta. Valori possibili: AgentClusterInsight |
Sì |
AgentContainerObject
Dettagli del contenitore di una versione specifica di un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | corda | Ora di creazione del contenitore. | Sì | |
| error_message | corda | Messaggio di errore se il contenitore non è riuscito a funzionare, se presente. | NO | |
| max_replicas | numero intero | Numero massimo di repliche per il contenitore. Il valore predefinito è 1. | NO | |
| min_replicas | numero intero | 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 | oggetto | Stato del contenitore di una versione specifica di un agente. | Sì | |
| updated_at | corda | Ora dell'ultimo aggiornamento del contenitore. | Sì |
AgentContainerOperationError
Dettagli dell'errore dell'operazione del contenitore, se presente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Codice di errore dell'operazione contenitore, se presente. | Sì | |
| message | corda | Messaggio di errore dell'operazione contenitore, se presente. | Sì | |
| type | corda | Tipo di errore dell'operazione contenitore, se presente. | Sì |
AgentContainerOperationObject
Operazione contenitore per una versione specifica di un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| agent_id | corda | ID dell'agente. | Sì | |
| agent_version_id | corda | ID della versione dell'agente. | Sì | |
| container | oggetto | Dettagli del contenitore di una versione specifica di un agente. | NO | |
| └created_at | corda | Ora di creazione del contenitore. | NO | |
| └error_message | corda | Messaggio di errore se il contenitore non è riuscito a funzionare, se presente. | NO | |
| └max_replicas | numero intero | Numero massimo di repliche per il contenitore. Il valore predefinito è 1. | NO | |
| └min_replicas | numero intero | 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 |
NO | |
| └─ stato | AgentContainerStatus | Stato del contenitore di una versione specifica di un agente. | NO | |
| └updated_at | corda | Ora dell'ultimo aggiornamento del contenitore. | NO | |
| Errore | oggetto | Dettagli dell'errore dell'operazione del contenitore, se presente. | NO | |
| └─ codice | corda | Codice di errore dell'operazione contenitore, se presente. | NO | |
| └* messaggio | corda | Messaggio di errore dell'operazione contenitore, se presente. | NO | |
| └─ Tipo | corda | Tipo di errore dell'operazione contenitore, se presente. | NO | |
| id | corda | ID dell'operazione del contenitore. Questo ID è un identificatore univoco nel sistema. | Sì | |
| stato | oggetto | 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 |
|---|---|
| Descrizione | Stato dell'operazione del contenitore per una versione specifica di un agente. |
| Tipo | corda |
| Valori | NotStartedInProgressSucceededFailed |
AgentContainerStatus
Stato del contenitore di una versione specifica di un agente.
| Proprietà | Value |
|---|---|
| Descrizione | Stato del contenitore di una versione specifica di un agente. |
| Tipo | corda |
| Valori | StartingRunningStoppingStoppedFailedDeletingDeletedUpdating |
AgentDefinition
Discriminante per AgentDefinition
Questo componente usa la proprietà kind per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
workflow |
WorkflowAgentDefinition |
hosted |
HostedAgentDefinition |
container_app |
ContainerAppAgentDefinition |
prompt |
PromptAgentDefinition |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| tipo/gentile | AgentKind | Sì | ||
| rai_config | oggetto | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| └rai_policy_name | corda | Il nome della polizza RAI da applicare. | NO |
AgentId
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Nome dell'agente. | Sì | |
| type | enum | Valori possibili: agent_id |
Sì | |
| version | corda | Identificatore della versione dell'agente. | Sì |
AgentKind
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | prompthostedcontainer_appworkflow |
AgentObject
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | Identificatore univoco dell'agente. | Sì | |
| nome | corda | Nome dell'agente. | Sì | |
| oggetto | enum | Il tipo di oggetto, che è sempre 'agente'. Valori possibili: agent |
Sì | |
| versions | oggetto | La versione più recente dell'agente. | Sì | |
| └└+ più recente | AgentVersionObject | NO |
AgentProtocol
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | activity_protocolresponses |
Riferimento agente
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Nome dell'agente. | Sì | |
| type | enum | Valori possibili: agent_reference |
Sì | |
| version | corda | Identificatore della versione dell'agente. | NO |
AgentTaxonomyInput
Configurazione dell'input per la tassonomia di valutazione quando il tipo di input è agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| riskCategories | array | Elenco delle categorie di rischio da valutare. | Sì | |
| target | oggetto | Rappresenta una destinazione che specifica un agente di intelligenza artificiale di Azure. | Sì | |
| └> nome | corda | Identificatore univoco dell'agente di intelligenza artificiale di Azure. | NO | |
| └tool_descriptions | array | Parametri utilizzati per controllare il comportamento di campionamento dell'agente durante la generazione del testo. | NO | |
| └─ Tipo | enum | Il tipo di target, sempre azure_ai_agent.Valori possibili: azure_ai_agent |
NO | |
| └─ versione | corda | Versione dell'agente di intelligenza artificiale di Azure. | NO | |
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| riskCategories | array | Elenco delle categorie di rischio da valutare. | NO | |
| target | oggetto | Rappresenta una destinazione che specifica un agente di intelligenza artificiale di Azure. | NO | |
| └> nome | corda | Identificatore univoco dell'agente di intelligenza artificiale di Azure. | NO | |
| └tool_descriptions | array | Parametri utilizzati per controllare il comportamento di campionamento dell'agente durante la generazione del testo. | NO | |
| └─ Tipo | enum | Il tipo di target, sempre azure_ai_agent.Valori possibili: azure_ai_agent |
NO | |
| └─ versione | corda | Versione dell'agente di intelligenza artificiale di Azure. | NO | |
| type | enum | Tipo di input della tassonomia di valutazione. Valori possibili: agent |
NO |
AgentVersionObject
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | numero intero | Il timestamp Unix (secondi) al momento della creazione dell'agente. | Sì | |
| Definizione | AgentDefinition | Sì | ||
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| id | corda | Identificatore univoco della versione dell'agente. | Sì | |
| metadata | oggetto | 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 | corda | Nome dell'agente. Il nome può essere utilizzato per recuperare/aggiornare/eliminare l'agente. | Sì | |
| oggetto | enum | Il tipo di oggetto, che è sempre 'agent.version'. Valori possibili: agent.version |
Sì | |
| version | corda | Identificatore della versione dell'agente. Gli agenti sono immutabili e ogni aggiornamento crea una nuova versione mantenendo lo stesso nome. | Sì |
AgenticIdentityCredentials
Definizione delle credenziali di identità agentica
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di credenziale Valori possibili: AgenticIdentityToken |
Sì |
ApiErrorResponse
Risposta di errore per errori API.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | OpenAI.Error | Sì |
ApiKeyCredentials
Definizione delle credenziali della chiave API
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| chiave | corda | Chiave API | NO | |
| type | enum | Tipo di credenziale Valori possibili: ApiKey |
Sì |
AssetCredentialResponse
Rappresenta un riferimento a un BLOB per l'utilizzo
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| blobReference | oggetto | Dettagli di riferimento BLOB. | Sì | |
| └* blobUri | corda | Percorso URI BLOB per il caricamento dei dati da parte del client. Esempio: https://blob.windows.core.net/Container/Path |
NO | |
| └* credenziali | SasCredential | Informazioni sulle credenziali per accedere all'account di archiviazione. | NO | |
| └\ storageAccountArmId | corda | ID ARM dell'account di archiviazione da usare. | NO |
AssetId
Identificatore di un asset salvato.
Tipo: string
AttaccoStrategy
Strategie per gli attacchi.
| Proprietà | Value |
|---|---|
| Descrizione | Strategie per gli attacchi. |
| Tipo | corda |
| Valori | easymoderatedifficultascii_artascii_smuggleratbashbase64binarycaesarcharacter_spacejailbreakansii_attackcharacter_swapsuffix_appendstring_joinunicode_confusableunicode_substitutiondiacriticflipleetspeakrot13morseurlbaselineindirect_jailbreaktensemulti_turncrescendo |
Azure.Core.Foundations.Error
Oggetto error.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Uno di un set definito dal server di codici di errore. | Sì | |
| details | array | Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. | NO | |
| innererror | oggetto | Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors. | NO | |
| └─ codice | corda | Uno di un set definito dal server di codici di errore. | NO | |
| └\ innererror | Azure.Core.Foundations.InnerError | Errore interno. | NO | |
| message | corda | Rappresentazione leggibile dell'errore. | Sì | |
| target | corda | Destinazione dell'errore. | NO |
Azure.Core.Foundations.ErrorResponse
Risposta contenente i dettagli dell'errore.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | oggetto | Oggetto error. | Sì | |
| └─ codice | corda | Uno di un set definito dal server di codici di errore. | NO | |
| └* dettagli | array | 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 | corda | Rappresentazione leggibile dell'errore. | NO | |
| Destinazione └* | corda | Destinazione dell'errore. | NO |
Azure.Core.Foundations.InnerError
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Uno di un set definito dal server di codici di errore. | NO | |
| innererror | oggetto | Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors. | NO | |
| └─ codice | corda | 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 |
|---|---|
| Tipo | corda |
| Valori | NotStartedRunningSucceededFailedCanceled |
Azure.Core.uuid
Identificatore univoco universale
Tipo: string
Formato: uuid
AzureAIAgentTarget
Rappresenta una destinazione che specifica un agente di intelligenza artificiale di Azure.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Identificatore univoco dell'agente di intelligenza artificiale di Azure. | Sì | |
| tool_descriptions | array | 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 | corda | Versione dell'agente di intelligenza artificiale di Azure. | NO |
AzureAIAgentTargetUpdate
Rappresenta una destinazione che specifica un agente di intelligenza artificiale di Azure.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Identificatore univoco dell'agente di intelligenza artificiale di Azure. | NO | |
| tool_descriptions | array | 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 |
NO | |
| version | corda | Versione dell'agente di intelligenza artificiale di Azure. | NO |
AzureAIAssistantTarget
Rappresenta una destinazione che specifica un endpoint di Azure AI Assistant (Agent V1), incluso il relativo ID.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | Identificatore univoco di Azure AI Assistant. | NO | |
| tool_descriptions | array | Descrizioni degli strumenti disponibili per l'assistente. | Sì | |
| type | enum | Il tipo di target, sempre azure_ai_assistant.Valori possibili: azure_ai_assistant |
Sì |
AzureAIAssistantTargetUpdate
Rappresenta una destinazione che specifica un endpoint di Azure AI Assistant (Agent V1), incluso il relativo ID.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | Identificatore univoco di Azure AI Assistant. | NO | |
| tool_descriptions | array | Descrizioni degli strumenti disponibili per l'assistente. | NO | |
| type | enum | Il tipo di target, sempre azure_ai_assistant.Valori possibili: azure_ai_assistant |
NO |
AzureAIEvaluator
Definizione dell'analizzatore di intelligenza artificiale di Azure per gli analizzatori di trovatori.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data_mapping | oggetto | Modello da utilizzare per la valutazione. Deve supportare output strutturati. | NO | |
| evaluator_name | corda | Nome dell'analizzatore. | Sì | |
| evaluator_version | corda | Versione dell'analizzatore. | NO | |
| initialization_parameters | oggetto | Parametri di inizializzazione per la valutazione. Deve supportare output strutturati. | NO | |
| nome | corda | Nome del grader. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: azure_ai_evaluator |
Sì |
AzureAIModelTarget
Rappresenta una destinazione che specifica un modello di intelligenza artificiale di Azure per le operazioni che richiedono la selezione del modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| model | corda | Identificatore univoco del modello di intelligenza artificiale di Azure. | NO | |
| sampling_params | oggetto | 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 | numero intero | Numero massimo di token consentiti nel completamento. | NO | |
| └* seed | numero intero | 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ì |
AzureAIModelTargetUpdate
Rappresenta una destinazione che specifica un modello di intelligenza artificiale di Azure per le operazioni che richiedono la selezione del modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| model | corda | Identificatore univoco del modello di intelligenza artificiale di Azure. | NO | |
| sampling_params | oggetto | 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 | numero intero | Numero massimo di token consentiti nel completamento. | NO | |
| └* seed | numero intero | 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 |
NO |
AzureAIRedTeam
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_generation_params | oggetto | Rappresenta i parametri per la generazione di elementi red team. | Sì | |
| └attack_strategies | array | Raccolta di strategie di attacco da usare. | NO | |
| └num_turns | numero intero | Numero di turni consentiti nel gioco. | NO | |
| └─ Tipo | enum | Tipo di parametri di generazione di elementi, sempre red_team.Valori possibili: red_team |
NO | |
| target | oggetto | Classe base per bersagli con supporto per discriminatore. | Sì | |
| └─ Tipo | corda | Tipo di destinazione. | NO | |
| type | enum | Tipo di origine dati. Sempre azure_ai_red_team.Valori possibili: azure_ai_red_team |
Sì |
AzureAIResponses
Rappresenta un'origine dati per le esecuzioni di valutazione specifiche degli scenari di valutazione continua.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| event_configuration_id | corda | Nome della configurazione dell'evento associato a questa esecuzione di valutazione. | Sì | |
| item_generation_params | oggetto | Rappresenta i parametri per la generazione continua degli elementi di valutazione. | Sì | |
| └data_mapping | oggetto | Mapping dai campi di origine al campo response_id, necessario per recuperare la cronologia delle chat. | NO | |
| └max_num_turns | numero intero | Numero massimo di turni di cronologia chat da valutare. | NO | |
| └─ sorgente | OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource | Origine da cui viene letto il contenuto JSONL. | NO | |
| └─ Tipo | enum | Tipo di parametri di generazione di elementi, sempre ResponseRetrieval.Valori possibili: response_retrieval |
NO | |
| max_runs_hourly | numero intero | Numero massimo di esecuzioni di valutazione consentite all'ora. | Sì | |
| type | enum | Tipo di origine dati, sempre AzureAIResponses.Valori possibili: azure_ai_responses |
Sì |
AzureAISearchAgentTool
Informazioni sulla definizione di input per uno strumento di ricerca di intelligenza artificiale di Azure usato per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azure_ai_search | oggetto | Set di risorse di indice usate dallo strumento azure_ai_search. |
Sì | |
| └++ indici | array | Indici associati all'agente. Può essere presente un massimo di 1 indice risorsa collegata all'agente. |
NO | |
| type | enum | Il tipo di oggetto, che è sempre 'azure_ai_search'. Valori possibili: azure_ai_search |
Sì |
AzureIAIndiceDiRicerca
Definizione dell'indice di ricerca di Azure per intelligenza artificiale
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di indice Valori possibili: AzureSearch |
Sì |
AzureAISearchIndexUpdate
Definizione dell'indice di ricerca di Azure per intelligenza artificiale
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di indice Valori possibili: AzureSearch |
Sì |
AzureAISearchQueryType
Tipi di query disponibili per lo strumento di ricerca di intelligenza artificiale di Azure.
| Proprietà | Value |
|---|---|
| Descrizione | Tipi di query disponibili per lo strumento di ricerca di intelligenza artificiale di Azure. |
| Tipo | corda |
| Valori | simplesemanticvectorvector_simple_hybridvector_semantic_hybrid |
AzureAISearchToolResource
Set di risorse di indice usate dallo strumento azure_ai_search.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Indici | array | Indici associati all'agente. Può essere presente un massimo di 1 indice risorsa collegata all'agente. |
Sì |
AzureAISource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| situazione | enum | Scenario dello schema dei dati. Valori possibili: red_team, responses, traces |
Sì | |
| type | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: azure_ai_source |
Sì |
AzureFunctionAgentTool
Informazioni sulla definizione di input per uno strumento per le funzioni di Azure, usate per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azure_function | oggetto | Definizione della funzione di Azure. | Sì | |
| Funzione └* | oggetto | Definizione della funzione di Azure e dei relativi parametri. | NO | |
| └* descrizione | corda | Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. | NO | |
| └> nome | corda | Nome della funzione che deve essere chiamata. | NO | |
| └─ Parametri | I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. | NO | ||
| └input_binding | AzureFunctionBinding | Coda di archiviazione di input. Il trigger di archiviazione code esegue una funzione quando vengono aggiunti messaggi. | NO | |
| └output_binding | AzureFunctionBinding | Coda di archiviazione di output. La funzione scrive l'output in questa coda quando vengono elaborati gli elementi di input. | NO | |
| type | enum | Il tipo di oggetto, che è sempre 'browser_automation'. Valori possibili: azure_function |
Sì |
AzureFunctionBinding
Struttura per mantenere il nome e l'URI della coda di archiviazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| storage_queue | oggetto | Struttura per mantenere il nome e l'URI della coda di archiviazione. | Sì | |
| └queue_name | corda | Nome di una coda di archiviazione delle funzioni di Azure. | NO | |
| └queue_service_endpoint | corda | URI per il servizio di accodamento di Archiviazione di Azure che consente di modificare una coda. | NO | |
| type | enum | Tipo di associazione, che è sempre "storage_queue". Valori possibili: storage_queue |
Sì |
AzureFunctionDefinition
Definizione della funzione di Azure.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| funzione | oggetto | Definizione della funzione di Azure e dei relativi parametri. | Sì | |
| └* descrizione | corda | Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. | NO | |
| └> nome | corda | Nome della funzione che deve essere chiamata. | NO | |
| └─ Parametri | I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. | NO | ||
| input_binding | oggetto | Struttura per mantenere il nome e l'URI della coda di archiviazione. | Sì | |
| └storage_queue | AzureFunctionStorageQueue | Coda di archiviazione. | NO | |
| └─ Tipo | enum | Tipo di associazione, che è sempre "storage_queue". Valori possibili: storage_queue |
NO | |
| output_binding | oggetto | Struttura per mantenere il nome e l'URI della coda di archiviazione. | Sì | |
| └storage_queue | AzureFunctionStorageQueue | Coda di archiviazione. | NO | |
| └─ Tipo | enum | Tipo di associazione, che è sempre "storage_queue". Valori possibili: storage_queue |
NO |
AzureFunctionStorageQueue
Struttura per mantenere il nome e l'URI della coda di archiviazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| queue_name | corda | Nome di una coda di archiviazione delle funzioni di Azure. | Sì | |
| queue_service_endpoint | corda | URI per il servizio di accodamento di Archiviazione di Azure che consente di modificare una coda. | Sì |
AzureOpenAIModelConfiguration
Configurazione del modello Azure OpenAI. La versione dell'API verrebbe selezionata dal servizio per l'esecuzione di query sul modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| modelDeploymentName | corda | Nome della distribuzione per il modello AOAI. Esempio: gpt-4o se in AIServices o basati su connection_name/deployment_name connessione (ad es. 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 tipo | Schema |
|---|---|
ApiKey |
ApiKeyCredentials |
AAD |
EntraIDCredentials |
CustomKeys |
CustomCredential |
SAS |
SasCredentials |
None |
NoAuthenticationCredentials |
AgenticIdentityToken |
AgenticIdentityCredentials |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | Tipo di credenziale utilizzato dalla connessione | Sì |
BingCustomSearchAgentTool
Informazioni di definizione di input per uno strumento di ricerca personalizzato Bing usato per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| bing_custom_search_preview | oggetto | I parametri dello strumento di ricerca personalizzata di Bing. | Sì | |
| └search_configurations | array | Le connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. |
NO | |
| type | enum | Il tipo di oggetto, che è sempre 'bing_custom_search'. Valori possibili: bing_custom_search_preview |
Sì |
BingCustomSearchConfiguration
Una configurazione di ricerca personalizzata di Bing.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| count | numero intero | Il numero di risultati della ricerca da restituire nella risposta dell'API Bing | NO | |
| freshness | corda | Filtra i risultati della ricerca in base a un intervallo di tempo specifico. Vedere i valori accettati qui. | NO | |
| instance_name | corda | Nome dell'istanza di configurazione personalizzata assegnata alla configurazione. | Sì | |
| mercato | corda | Il mercato da cui provengono i risultati. | NO | |
| project_connection_id | corda | ID connessione progetto per messa a terra con ricerca bing | Sì | |
| set_lang | corda | Lingua da utilizzare per le stringhe dell'interfaccia utente quando si chiama l'API Bing. | NO |
BingCustomSearchToolParameters
I parametri dello strumento di ricerca personalizzata di Bing.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| search_configurations | array | Le connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. |
Sì |
BingGroundingAgentTool
Informazioni sulla definizione di input per uno strumento di ricerca a terra Bing usato per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| bing_grounding | oggetto | I parametri dello strumento di ricerca per la messa a terra di bing. | Sì | |
| └search_configurations | array | Le configurazioni di ricerca associate a questo strumento. Può essere presente un massimo di 1 risorsa di configurazione di ricerca collegata allo strumento. |
NO | |
| type | enum | Tipo di oggetto, che è sempre "bing_grounding". Valori possibili: bing_grounding |
Sì |
BingGroundingSearchConfiguration
Configurazione di ricerca per l'incaglio di Bing
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| count | numero intero | Il numero di risultati della ricerca da restituire nella risposta dell'API Bing | NO | |
| freshness | corda | Filtra i risultati della ricerca in base a un intervallo di tempo specifico. Vedere i valori accettati qui. | NO | |
| mercato | corda | Il mercato da cui provengono i risultati. | NO | |
| project_connection_id | corda | ID connessione progetto per messa a terra con ricerca bing | Sì | |
| set_lang | corda | Lingua da utilizzare per le stringhe dell'interfaccia utente quando si chiama l'API Bing. | NO |
BingGroundingSearchToolParameters
I parametri dello strumento di ricerca per la messa a terra di bing.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| search_configurations | array | Le configurazioni di ricerca associate a questo strumento. Può essere presente un massimo di 1 risorsa di configurazione di ricerca collegata allo strumento. |
Sì |
BlobReference
Dettagli di riferimento BLOB.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| BLOBUri | corda | Percorso URI BLOB per il caricamento dei dati da parte del client. Esempio: https://blob.windows.core.net/Container/Path |
Sì | |
| credenziali | oggetto | Definizione delle credenziali di firma di accesso condiviso | Sì | |
| └* sasUri | corda | URI SAS | NO | |
| └─ Tipo | enum | Tipo di credenziale Valori possibili: SAS |
NO | |
| storageAccountArmId | corda | ID ARM dell'account di archiviazione da usare. | Sì |
BrowserAutomationAgentTool
Le informazioni di input della definizione per uno strumento di automazione del browser, utilizzate per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| browser_automation_preview | oggetto | Definizione dei parametri di input per il Browser Automation Tool. | Sì | |
| Connessione └* | BrowserAutomationToolConnectionParameters | I parametri di connessione del progetto associati allo strumento di automazione del browser. | NO | |
| type | enum | Il tipo di oggetto, che è sempre 'browser_automation'. Valori possibili: browser_automation_preview |
Sì |
BrowserAutomationToolConnectionParameters
Definizione dei parametri di input per la connessione utilizzata dal Browser Automation Tool.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| project_connection_id | corda | ID della connessione del progetto alla risorsa Azure Playwright. | Sì |
BrowserAutomationToolParameters
Definizione dei parametri di input per il Browser Automation Tool.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| connessione | oggetto | Definizione dei parametri di input per la connessione utilizzata dal Browser Automation Tool. | Sì | |
| └project_connection_id | corda | ID della connessione del progetto alla risorsa Azure Playwright. | NO |
CaptureStructuredOutputsTool
Uno strumento per l'acquisizione di output strutturati
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Risultati | oggetto | Output strutturato che può essere prodotto dall'agente. | Sì | |
| └* descrizione | corda | Descrizione dell'output da emettere. Utilizzato dal modello per determinare quando generare l'output. | NO | |
| └> nome | corda | Nome dell'output strutturato. | NO | |
| └─ Schema | Schema JSON per l'output strutturato. | NO | ||
| └─ rigoroso | boolean | Se applicare una convalida rigorosa. Valore predefinito true. |
NO | |
| type | enum | Tipo dello strumento. Sempre capture_structured_outputs.Valori possibili: capture_structured_outputs |
Sì |
ChartCoordinate
Coordinate per il grafico di analisi.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| size | numero intero | Dimensioni dell'elemento del grafico. | Sì | |
| x | numero intero | Coordinata dell'asse X. | Sì | |
| y | numero intero | Coordinate dell'asse Y. | Sì |
ChatSummaryMemoryItem
Un elemento di memoria contenente un riepilogo estratto dalle conversazioni.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| tipo/gentile | enum | Il tipo di elemento della memoria. Valori possibili: chat_summary |
Sì |
ClusterInsightResult
Approfondimenti dall'analisi dei cluster.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| clusters | array | Elenco dei cluster identificati nelle informazioni dettagliate. | Sì | |
| Coordinate | oggetto | Mappatura opzionale degli ID alle coordinate 2D utilizzate 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 | oggetto | Riepilogo dell'analisi dei cluster di errori. | Sì | |
| Metodo └* | corda | Metodo utilizzato per il clustering. | NO | |
| └> sampleCount | numero intero | Numero totale di campioni analizzati. | NO | |
| └* uniqueClusterCount | numero intero | Numero totale di cluster univoci. | NO | |
| └* uniqueSubclusterCount | numero intero | Numero totale di etichette univoche del sottocluster. | NO | |
| └─ utilizzo | ClusterTokenUsage | Utilizzo dei token durante l'esecuzione dell'analisi di clustering | NO |
ClusterTokenUsage
Utilizzo dei token per l'analisi dei cluster
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| inputTokenUsage | numero intero | Utilizzo del token di input | Sì | |
| outputTokenUsage | numero intero | Utilizzo del token di output | Sì | |
| totalTokenUsage | numero intero | Utilizzo totale dei token | Sì |
CodeBasedEvaluatorDefinition
Definizione dell'analizzatore basata su codice utilizzando il codice Python
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| code_text | corda | Testo del codice incorporato per l'analizzatore | Sì | |
| type | enum | Valori possibili: code |
Sì |
Connection
Risposta dall'elenco e operazioni di get connections
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| credentials | oggetto | Una classe di base per le credenziali di connessione | Sì | |
| └─ Tipo | CredentialType | Il tipo di credenziale utilizzata dalla connessione | NO | |
| id | corda | Un identificatore univoco per la connessione, generato dal servizio | Sì | |
| isDefault | boolean | Se la connessione è contrassegnata come connessione predefinita del relativo tipo | Sì | |
| metadata | oggetto | Metadati della connessione | Sì | |
| nome | corda | Nome descrittivo della connessione, fornito dall'utente. | Sì | |
| target | corda | URL di connessione da usare per questo servizio | Sì | |
| type | oggetto | Tipo (o categoria) della connessione | Sì |
Tipo di Connessione
Tipo (o categoria) della connessione
| Proprietà | Value |
|---|---|
| Descrizione | Tipo (o categoria) della connessione |
| Tipo | corda |
| Valori | AzureOpenAIAzureBlobAzureStorageAccountCognitiveSearchCosmosDBApiKeyAppConfigAppInsightsCustomKeysRemoteTool |
ContainerAppAgentDefinition
Definizione dell'agente dell'app contenitore.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| container_app_resource_id | corda | ID risorsa dell'app Azure Container che ospita l'agente. Non modificabile tra le versioni. | Sì | |
| container_protocol_versions | array | Protocolli supportati dall'agente per la comunicazione in ingresso dei contenitori. | Sì | |
| ingress_subdomain_suffix | corda | Suffisso da applicare al sottodominio dell'app quando si invia l'ingresso all'agente. Può trattarsi di un'etichetta (ad esempio, '---corrente'), di una revisione specifica (ad esempio, '--0000001') o di un vuoto per usare l'endpoint predefinito per l'app contenitore. | Sì | |
| tipo/gentile | enum | Valori possibili: container_app |
Sì |
ContinuousEvalItemGenerationParams
Rappresenta i parametri per la generazione continua degli elementi di valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data_mapping | oggetto | Mapping dai campi di origine al campo response_id, necessario per recuperare la cronologia delle chat. | Sì | |
| max_num_turns | numero intero | Numero massimo di turni di cronologia chat da valutare. | Sì | |
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └* id | corda | Identificatore del file. | NO | |
| └─ Tipo | enum | Tipo di origine JSONL. Sempre file_id.Valori possibili: file_id |
NO | |
| type | enum | Tipo di parametri di generazione di elementi, sempre ResponseRetrieval.Valori possibili: response_retrieval |
Sì |
ContinuousEvaluationRuleAction
Azione della regola di valutazione per la valutazione continua.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| evalId | corda | Eval Id a cui aggiungere esecuzioni di valutazione continua. | Sì | |
| maxHourlyRuns | numero intero | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di indice Valori possibili: CosmosDBNoSqlVectorStore |
Sì |
CosmosDBIndexUpdate
Definizione dell'indice dell'archivio vettoriale CosmosDB
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di indice Valori possibili: CosmosDBNoSqlVectorStore |
Sì |
CreateAgentFromManifestRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| manifest_id | corda | ID manifesto da cui importare la versione dell'agente. | Sì | |
| metadata | oggetto | 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 | corda | 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. |
Sì | |
| parameter_values | oggetto | Input al manifesto che genererà un agente completamente materializzato. | Sì |
CreateAgentRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Sì | ||
| └* tipo | AgentKind | NO | ||
| └rai_config | RaiConfig | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| metadata | oggetto | 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 | corda | 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. |
Sì |
CreateAgentVersionFromManifestRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| manifest_id | corda | ID manifesto da cui importare la versione dell'agente. | Sì | |
| metadata | oggetto | 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 | oggetto | Input al manifesto che genererà un agente completamente materializzato. | Sì |
CreateAgentVersionRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Sì | ||
| └* tipo | AgentKind | NO | ||
| └rai_config | RaiConfig | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| metadata | oggetto | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| configurazione_sorgente_dati | oggetto | 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 |
Sì | |
| └include_sample_schema | 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 | |
| └item_schema | oggetto | Schema JSON per ogni riga nell'origine dati. | NO | |
| └─ metadati | oggetto | Filtri dei metadati per l'origine dati dei completamenti archiviati. | NO | |
| Scenario └* | enum | Scenario dello schema dei dati. Valori possibili: red_team, responses, traces |
NO | |
| └─ Tipo | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: azure_ai_source |
NO | |
| 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. |
NO | |
| nome | corda | Nome della valutazione. | NO | |
| proprietà | oggetto | 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 | array | Elenco di classificatori per tutte le esecuzioni di valutazione in questo gruppo. I classificatori possono fare riferimento alle 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 spazio dei nomi sample (ad esempio, {{sample.output_text}}). |
Sì |
CreateEvalRunRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| fonte_dati | oggetto | Oggetto JsonlRunDataSource con che specifica un file JSONL che corrisponde all'eval | Sì | |
| └ input_messages | 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 | |
| └item_generation_params | RedTeamItemGenerationParams | Parametri per la generazione di elementi. | NO | |
| └─ Modello | corda | Nome del modello da utilizzare per la generazione di completamenti, ad esempio "o3-mini". | NO | |
| └sampling_params | OpenAI.CreateEvalResponsesRunDataSourceSamplingParams | NO | ||
| └─ sorgente | OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalResponsesSource | Determina il popolamento dello item spazio dei nomi nell'origine dati di questa esecuzione. |
NO | |
| Destinazione └* | Destinazione | Configurazione di destinazione per la valutazione. | NO | |
| └─ Tipo | corda | Discriminare del tipo di origine dati. | NO | |
| 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. |
NO | |
| nome | corda | Nome della corsa. | NO | |
| proprietà | oggetto | 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 |
CreatedBy
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| agent | oggetto | NO | ||
| └> nome | corda | Nome dell'agente. | NO | |
| └─ Tipo | enum | Valori possibili: agent_id |
NO | |
| └─ versione | corda | Identificatore della versione dell'agente. | NO | |
| response_id | corda | Risposta in base alla quale viene creato l'elemento. | NO |
CredentialType
Tipo di credenziale utilizzato dalla connessione
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di credenziale utilizzato dalla connessione |
| Tipo | corda |
| Valori | ApiKeyAADSASCustomKeysNoneAgenticIdentityToken |
CronTrigger
Grilletto basato su Cron.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| endTime | corda | Ora di fine per la pianificazione cron in formato ISO 8601. | NO | |
| expression | corda | Espressione Cron che definisce la frequenza di pianificazione. | Sì | |
| startTime | corda | Ora di inizio per il programma cron in formato ISO 8601. | NO | |
| timeZone | corda | Fuso orario per la pianificazione cron. | NO | UTC |
| type | enum | Valori possibili: Cron |
Sì |
CustomCredential
Definizione delle credenziali personalizzate
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di credenziale Valori possibili: CustomKeys |
Sì |
DailyRecurrenceSchedule
Pianificazione giornaliera delle ricorrenze.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Ore | array | Ore per la pianificazione della ricorrenza. | Sì | |
| type | enum | Tipo di ricorrenza giornaliera. Valori possibili: Daily |
Sì |
DatasetType
Enumerazione per determinare il tipo di dati.
| Proprietà | Value |
|---|---|
| Descrizione | Enumerazione per determinare il tipo di dati. |
| Tipo | corda |
| Valori | uri_fileuri_folder |
DatasetVersion
Definizione di DatasetVersion
Discriminare per DatasetVersion
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
uri_file |
FileDatasetVersion |
uri_folder |
FolderDatasetVersion |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| connectionName | corda | Nome della connessione dell'account di archiviazione di Azure. Obbligatorio se startPendingUploadVersion non è stato chiamato prima della creazione del set di dati | NO | |
| dataUri | corda | URI dei dati (esempio) | Sì | |
| id | corda | Asset ID, un identificatore univoco per l'asset | NO | |
| isReference | boolean | 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 | corda | Nome della risorsa | Sì | |
| type | oggetto | Enumerazione per determinare il tipo di dati. | Sì | |
| version | corda | La versione della risorsa | Sì |
DatasetVersionUpdate
Definizione di DatasetVersion
Discriminare per DatasetVersionUpdate
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
uri_file |
FileDatasetVersionUpdate |
uri_folder |
FolderDatasetVersionUpdate |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| type | oggetto | Enumerazione per determinare il tipo di dati. | Sì |
GiornoDellaSettimana
Giorni della settimana per la pianificazione della ricorrenza.
| Proprietà | Value |
|---|---|
| Descrizione | Giorni della settimana per la pianificazione della ricorrenza. |
| Tipo | corda |
| Valori | SundayMondayTuesdayWednesdayThursdayFridaySaturday |
DeleteAgentResponse
Un oggetto agente eliminato
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Indica se l'agente è stato eliminato correttamente. | Sì | |
| nome | corda | Nome dell'agente. | Sì | |
| oggetto | enum | Tipo dell'oggetto. Sempre 'agent.deleted'. Valori possibili: agent.deleted |
Sì |
DeleteAgentVersionResponse
Un oggetto versione dell'agente eliminato
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Indica se l'agente è stato eliminato correttamente. | Sì | |
| nome | corda | Nome dell'agente. | Sì | |
| oggetto | enum | Tipo dell'oggetto. Sempre 'agent.deleted'. Valori possibili: agent.version.deleted |
Sì | |
| version | corda | Identificatore della versione dell'agente. | Sì |
DeleteEvalResponse
Oggetto di valutazione eliminato
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Indica se l'eval è stato eliminato correttamente. | Sì | |
| eval_id | corda | id dell'eval. | Sì | |
| oggetto | enum | Tipo dell'oggetto. Sempre 'eval.deleted'. Valori possibili: eval.deleted |
Sì |
DeleteEvalRunResponse
Oggetto di esecuzione della valutazione eliminato.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Indica se l'eval è stato eliminato correttamente. | NO | |
| oggetto | enum | Tipo dell'oggetto. Sempre 'eval.deleted'. Valori possibili: eval.deleted |
NO | |
| run_id | corda | id dell'eval. | NO |
DeleteMemoryStoreResponse
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Indica se l'archivio memoria è stato eliminato correttamente. | Sì | |
| nome | corda | Il nome dell'archivio di memoria. | Sì | |
| oggetto | enum | Tipo dell'oggetto. Sempre 'memory_store.deleted'. Valori possibili: memory_store.deleted |
Sì |
DeleteResponseResult
Risultato di un'operazione di eliminazione della risposta.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | enum | Restituisce sempre true Valori possibili: True |
Sì | |
| id | corda | ID operazione. | Sì | |
| oggetto | enum | Restituisce sempre 'response'. Valori possibili: response |
Sì |
Distribuzione
Definizione della distribuzione del modello
Discriminare per la distribuzione
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
ModelDeployment |
ModelDeployment |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Nome della distribuzione | Sì | |
| type | oggetto | Sì |
Deploymenttype
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | ModelDeployment |
EntraIDCredentials
Definizione delle credenziali dell'ID Entra
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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. Ad esempio:
- Migliorare la qualità del chatbot
- Scopri in che modo il mio chatbot gestisce il supporto clienti
- Controlla se o4-mini è migliore nel mio caso d'uso rispetto a gpt-4o
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | oggetto | Sì | ||
| creato_da | corda | nome della persona che ha creato l'esecuzione. | NO | |
| configurazione_sorgente_dati | oggetto | 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 |
Sì | |
| └include_sample_schema | 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 | |
| └item_schema | oggetto | Schema JSON per ogni riga nell'origine dati. | NO | |
| └─ metadati | oggetto | Filtri dei metadati per l'origine dati dei completamenti archiviati. | NO | |
| Scenario └* | enum | Scenario dello schema dei dati. Valori possibili: red_team, responses, traces |
NO | |
| └─ Tipo | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: azure_ai_source |
NO | |
| id | corda | Identificatore univoco per la valutazione. | 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ì | |
| modified_at | oggetto | NO | ||
| nome | corda | Nome della valutazione. | Sì | |
| oggetto | enum | Tipo dell'oggetto. Valori possibili: eval |
Sì | |
| proprietà | oggetto | 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 | array | Elenco dei criteri di test. | Sì |
EvalCompareReport
Approfondimenti dal confronto delle valutazioni.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Confronti | array | Risultati del confronto per ogni trattamento eseguito rispetto al basale. | Sì | |
| method | corda | Il metodo statistico utilizzato per il confronto. | Sì | |
| type | enum | Il tipo di risultato delle informazioni dettagliate. Valori possibili: EvaluationComparison |
Sì |
EvalResult
Risultato della valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Nome dell'assegno | Sì | |
| passato | boolean | Indica se il controllo è stato superato o meno | Sì | |
| Punteggio | numero | Punteggio | Sì | |
| type | corda | Tipo di assegno | Sì |
EvalRun
Schema che rappresenta un ciclo di valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | oggetto | Sì | ||
| creato_da | corda | nome della persona che ha creato l'esecuzione. | NO | |
| fonte_dati | oggetto | Oggetto JsonlRunDataSource con che specifica un file JSONL che corrisponde all'eval | Sì | |
| └ input_messages | 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 | |
| └item_generation_params | RedTeamItemGenerationParams | Parametri per la generazione di elementi. | NO | |
| └─ Modello | corda | Nome del modello da utilizzare per la generazione di completamenti, ad esempio "o3-mini". | NO | |
| └sampling_params | OpenAI.CreateEvalResponsesRunDataSourceSamplingParams | NO | ||
| └─ sorgente | OpenAI.EvalJsonlFileContentSource o OpenAI.EvalJsonlFileIdSource o OpenAI.EvalResponsesSource | Determina il popolamento dello item spazio dei nomi nell'origine dati di questa esecuzione. |
NO | |
| Destinazione └* | Destinazione | Configurazione di destinazione per la valutazione. | NO | |
| └─ Tipo | corda | Discriminare del tipo di origine dati. | NO | |
| Errore | OpenAI.EvalApiError | Oggetto che rappresenta una risposta di errore dall'API Eval. | Sì | |
| eval_id | corda | Identificatore della valutazione associata. | Sì | |
| id | corda | Identificatore univoco per l'esecuzione della valutazione. | 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ì | |
| model | corda | Modello valutato, se applicabile. | Sì | |
| modified_at | oggetto | NO | ||
| nome | corda | Nome della sessione di valutazione. | Sì | |
| oggetto | enum | Tipo dell'oggetto . Sempre "eval.run". Valori possibili: eval.run |
Sì | |
| utilizzo_per_modello | array | Statistiche di utilizzo per ogni modello durante l'esecuzione della valutazione. | Sì | |
| risultati_per_criteri_di_test | array | Risultati in base ai criteri di test applicati durante l'esecuzione della valutazione. | Sì | |
| proprietà | oggetto | 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 | corda | URL del report renderizzato dell'esecuzione della valutazione nella dashboard dell'interfaccia utente. | Sì | |
| conteggio_risultati | oggetto | Sì | ||
| └* non riuscito | OpenAI.integer | NO | ||
| └* non riuscito | OpenAI.integer | NO | ||
| └> superato | OpenAI.integer | NO | ||
| └─ totale | OpenAI.integer | NO | ||
| stato | corda | 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 tipo | Schema |
|---|---|
azure_ai_traces |
TracesEvalRunDataSource |
azure_ai_responses |
AzureAIResponses |
azure_ai_target_completions |
TargetCompletions |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | corda | Discriminare del tipo di origine dati. | Sì |
EvalRunOutputItem
Un elemento di output di un'esecuzione di valutazione rappresentato da uno schema.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | oggetto | Sì | ||
| elemento_fonte_dati | oggetto | Dettagli dell'elemento di origine dei dati di input. | Sì | |
| datasource_item_id (identificativo_elemento_fonte_dati) | oggetto | Sì | ||
| eval_id | corda | Identificatore del gruppo di valutazione. | Sì | |
| id | corda | Identificatore univoco per l'elemento di output del ciclo di valutazione. | Sì | |
| oggetto | enum | Tipo dell'oggetto . Sempre "eval.run.output_item". Valori possibili: eval.run.output_item |
Sì | |
| results | array | Elenco dei risultati del grader per questo elemento di output. | Sì | |
| run_id | corda | Identificatore dell'esecuzione di valutazione associata a questo elemento dell'output. | Sì | |
| campione | oggetto | Sì | ||
| └─ Errore | OpenAI.EvalApiError | Oggetto che rappresenta una risposta di errore dall'API Eval. | NO | |
| └─ motivo_fine | corda | NO | ||
| └ Input | array | NO | ||
| └ max_completion_tokens | OpenAI.integer | NO | ||
| └─ Modello | corda | NO | ||
| └─ uscita | array | NO | ||
| └* seed | OpenAI.integer | NO | ||
| └* temperatura | OpenAI.numeric | NO | ||
| └top_p | OpenAI.numeric | NO | ||
| └─ utilizzo | OpenAI.EvalRunOutputItemSampleUsage | NO | ||
| stato | corda | Stato dell'esecuzione della valutazione. | Sì |
EvalRunOutputItemResult
Risultato di un singolo gradore per un elemento di output dell'esecuzione della valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| label | corda | Etichetta associata alla metrica dei criteri di test (ad esempio, "pass", "fail", "good", "bad"). | NO | |
| metric | corda | Nome della metrica ,ad esempio "fluenza", "f1_score"). | NO | |
| nome | corda | Nome del grader. | Sì | |
| passato | boolean | Indica se il grader ha considerato l'output un passaggio. | Sì | |
| proprietà | oggetto | Dettagli aggiuntivi sulla metrica dei criteri di test. | NO | |
| reason | corda | Motivo della metrica dei criteri di test. | NO | |
| campione | oggetto | Dati facoltativi di esempio o intermedi prodotti dal grader. | NO | |
| Punteggio | oggetto | Sì | ||
| threshold | numero | Soglia utilizzata per determinare il superamento/esito negativo di questo criterio di test, se è numerico. | NO | |
| type | corda | Tipo di grader (ad esempio, "string-check-grader"). | NO |
EvalRunResultCompareItem
Confronto metrico per un trattamento rispetto al basale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| deltaEstimate | numero | Differenza stimata tra il trattamento e il basale. | Sì | |
| pValue | numero | Valore P per l'effetto del trattamento. | Sì | |
| trattamentoEffect | oggetto | Tipo di effetto del trattamento. | Sì | |
| treatmentRunId | corda | ID dell'esecuzione del trattamento. | Sì | |
| treatmentRunSummary | oggetto | Statistiche di riepilogo di una metrica in un'esecuzione di valutazione. | Sì | |
| └* media | numero | Valore medio della metrica nell'esecuzione della valutazione. | NO | |
| └* runId | corda | ID dell'esecuzione della valutazione. | NO | |
| └> sampleCount | numero intero | Numero di campioni nell'esecuzione della valutazione. | NO | |
| └++ standardDeviation | numero | Deviazione standard della metrica nell'esecuzione della valutazione. | NO |
EvalRunResultComparison
I risultati del confronto per il trattamento vengono eseguiti rispetto al basale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| baselineRunSummary | oggetto | Statistiche di riepilogo di una metrica in un'esecuzione di valutazione. | Sì | |
| └* media | numero | Valore medio della metrica nell'esecuzione della valutazione. | NO | |
| └* runId | corda | ID dell'esecuzione della valutazione. | NO | |
| └> sampleCount | numero intero | Numero di campioni nell'esecuzione della valutazione. | NO | |
| └++ standardDeviation | numero | Deviazione standard della metrica nell'esecuzione della valutazione. | NO | |
| compareItems | array | Elenco dei risultati del confronto per ogni ciclo di trattamento. | Sì | |
| valutatore | corda | Nome del valutatore per questo criterio di test. | Sì | |
| metric | corda | Metrica in fase di valutazione. | Sì | |
| testingCriteria | corda | Nome dei criteri di prova. | Sì |
EvalRunResultSummary
Statistiche di riepilogo di una metrica in un'esecuzione di valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| average | numero | Valore medio della metrica nell'esecuzione della valutazione. | Sì | |
| runId | corda | ID dell'esecuzione della valutazione. | Sì | |
| sampleCount | numero intero | Numero di campioni nell'esecuzione della valutazione. | Sì | |
| standardDeviation | numero | Deviazione standard della metrica nell'esecuzione della valutazione. | Sì |
EvaluationComparisonRequest
Richiesta di confronto della valutazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| baselineRunId | corda | ID di esecuzione della baseline per il confronto. | Sì | |
| evalId | corda | Identificatore per la valutazione. | Sì | |
| treatmentRunIds | array | Elenco degli ID delle esecuzioni dei trattamenti per il confronto. | Sì | |
| type | enum | Tipo di richiesta. Valori possibili: EvaluationComparison |
Sì |
EvaluationResultSample
Un campione del risultato della valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| evaluationResult | oggetto | Risultato della valutazione. | Sì | |
| └> nome | corda | Nome dell'assegno | NO | |
| └> superato | boolean | Indica se il controllo è stato superato o meno | NO | |
| └* punteggio | numero | Punteggio | NO | |
| └─ Tipo | corda | Tipo di assegno | NO | |
| type | enum | Tipo di campione Risultato della valutazione Valori possibili: EvaluationResultSample |
Sì |
Regola di valutazione
Modello di regole di valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | oggetto | Modello di azione di valutazione. | Sì | |
| └─ Tipo | EvaluationRuleActionType | Tipo di azione di valutazione. | NO | |
| descrizione | corda | Descrizione della regola di valutazione. | NO | |
| nome visualizzato | corda | Nome visualizzato per la regola di valutazione. | NO | |
| enabled | boolean | Indica se la regola di valutazione è abilitata. Il valore predefinito è vero. | Sì | |
| eventType | oggetto | Tipo di evento della regola di valutazione. | Sì | |
| filtro | oggetto | Modello di filtro di valutazione. | NO | |
| └* agentName | corda | Filtra in base al nome dell'agente. | NO | |
| id | corda | Identificatore univoco per la regola di valutazione. | Sì | |
| dati di sistema | oggetto | 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 tipo | Schema |
|---|---|
continuousEvaluation |
ContinuousEvaluationRuleAction |
humanEvaluation |
HumanEvaluationRuleAction |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | Tipo di azione di valutazione. | Sì |
EvaluationRuleActionType
Tipo di azione di valutazione.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di azione di valutazione. |
| Tipo | corda |
| Valori | continuousEvaluationhumanEvaluation |
EvaluationRuleEventType
Tipo di evento della regola di valutazione.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di evento della regola di valutazione. |
| Tipo | corda |
| Valori | responseCompletedmanual |
EvaluationRuleFilter
Modello di filtro di valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nomeagente | corda | Filtra in base al nome dell'agente. | Sì |
EvaluationRunClusterInsightResult
Le informazioni dettagliate della valutazione eseguono l'analisi dei cluster.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| clusterInsight | ClusterInsightResult | Approfondimenti dall'analisi dei cluster. | Sì | |
| type | enum | Il tipo di risultato delle informazioni dettagliate. Valori possibili: EvaluationRunClusterInsight |
Sì |
EvaluationRunClusterInsightsRequest
Approfondimenti sull'insieme dei risultati della valutazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| evalId | corda | ID di valutazione per le informazioni dettagliate. | Sì | |
| modelConfiguration | oggetto | Configurazione del modello utilizzato nella generazione dell'insight. | NO | |
| └* modelDeploymentName | corda | Distribuzione del modello da valutare. Accetta solo il nome della distribuzione o con il nome della connessione come {connectionName}/<modelDeploymentName>. |
NO | |
| runIds | array | Elenco degli ID di esecuzione della valutazione per le informazioni dettagliate. | Sì | |
| type | enum | Il tipo di richiesta di informazioni dettagliate. Valori possibili: EvaluationRunClusterInsight |
Sì |
EvaluationScheduleTask
Attività di valutazione per la pianificazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| evalId | corda | Identificatore del gruppo di valutazione. | Sì | |
| evalRun | oggetto | Payload dell'esecuzione della valutazione. | Sì | |
| type | enum | Valori possibili: Evaluation |
Sì |
EvaluationTaxonomy
Definizione della tassonomia di valutazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | Asset ID, un identificatore univoco per l'asset | NO | |
| nome | corda | Nome della risorsa | Sì | |
| proprietà | oggetto | Proprietà aggiuntive per la tassonomia di valutazione. | NO | |
| tassonomiaCategorie | array | Elenco delle categorie di tassonomia. | NO | |
| tassonomiaInput | oggetto | Configurazione di input per la tassonomia di valutazione. | Sì | |
| └─ Tipo | EvaluationTaxonomyInputType | Tipo di input della tassonomia di valutazione. | NO | |
| version | corda | La versione della risorsa | Sì |
EvaluationTaxonomyCreateOrUpdate
Definizione della tassonomia di valutazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| proprietà | oggetto | Proprietà aggiuntive per la tassonomia di valutazione. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| tassonomiaCategorie | array | Elenco delle categorie di tassonomia. | NO | |
| tassonomiaInput | oggetto | Configurazione di input per la tassonomia di valutazione. | Sì | |
| └─ Tipo | EvaluationTaxonomyInputType | Tipo di input della tassonomia di valutazione. | NO |
EvaluationTaxonomyInput
Configurazione di input per la tassonomia di valutazione.
Discriminante per EvaluationTaxonomyInput
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
agent |
AgentTaxonomyInput |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | 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. |
| Tipo | corda |
| Valori | agentpolicy |
EvaluationTaxonomyInputUpdate
Configurazione di input per la tassonomia di valutazione.
Discriminante per EvaluationTaxonomyInputUpdate
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
agent |
AgentTaxonomyInputUpdate |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | Tipo di input della tassonomia di valutazione. | Sì |
EvaluationTaxonomyUpdate
Definizione della tassonomia di valutazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| proprietà | oggetto | Proprietà aggiuntive per la tassonomia di valutazione. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| tassonomiaCategorie | array | Elenco delle categorie di tassonomia. | NO | |
| tassonomiaInput | oggetto | Configurazione di input per la tassonomia di valutazione. | NO | |
| └─ Tipo | EvaluationTaxonomyInputType | Tipo di input della tassonomia di valutazione. | NO |
AnalizzatoreCategory
La categoria del valutatore
| Proprietà | Value |
|---|---|
| Descrizione | La categoria del valutatore |
| Tipo | corda |
| Valori | qualitysafetyagents |
AnalizzatoreDefinition
Configurazione dell'analizzatore di base con discriminatore
Discriminante per l'analizzatoreDefinition
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
code |
CodeBasedEvaluatorDefinition |
prompt |
PromptBasedEvaluatorDefinition |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data_schema | Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| init_parameters | Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| metrics | oggetto | Elenco delle metriche di output prodotte da questo valutatore | NO | |
| type | oggetto | Il tipo di definizione del valutatore | Sì |
AnalizzatoreDefinitionType
Il tipo di definizione del valutatore
| Proprietà | Value |
|---|---|
| Descrizione | Il tipo di definizione del valutatore |
| Tipo | corda |
| Valori | promptcodeprompt_and_codeserviceopenai_graders |
AnalizzatoreMetrico
Metrica del valutatore
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| desirable_direction | oggetto | 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 viene specificato, si presuppone che sia illimitato. | NO | |
| min_value | numero | Valore minimo per la metrica | NO | |
| type | oggetto | 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 |
| Tipo | corda |
| Valori | increasedecreaseneutral |
AnalizzatoreMetricType
Il tipo di valutatore
| Proprietà | Value |
|---|---|
| Descrizione | Il tipo di valutatore |
| Tipo | corda |
| Valori | ordinalcontinuousboolean |
AnalizzatoreType
Il tipo di valutatore
| Proprietà | Value |
|---|---|
| Descrizione | Il tipo di valutatore |
| Tipo | corda |
| Valori | builtincustom |
AnalizzatoreVersion
Definizione del valutatore
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| categories | array | Le categorie del valutatore | Sì | |
| creato_il | numero intero | Data/ora di creazione del valutatore | Sì | |
| creato_da | corda | Creatore del valutatore | Sì | |
| Definizione | oggetto | Configurazione dell'analizzatore di base con discriminatore | Sì | |
| └data_schema | Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| └init_parameters | Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| └* Metriche | oggetto | Elenco delle metriche di output prodotte da questo valutatore | NO | |
| └─ Tipo | AnalizzatoreDefinitionType | Il tipo di definizione del valutatore | NO | |
| display_name | corda | Nome visualizzato per l'analizzatore. Aiuta a trovare facilmente l'analizzatore in Foundry. Non è necessario che sia univoco. | NO | |
| evaluator_type | oggetto | Il tipo di valutatore | Sì | |
| id | corda | Asset ID, un identificatore univoco per l'asset | NO | |
| metadata | oggetto | Metadati relativi all'analizzatore | NO | |
| modified_at | numero intero | Data/ora dell'ultima modifica del valutatore | Sì | |
| nome | corda | Nome della risorsa | Sì | |
| version | corda | La versione della risorsa | Sì |
EvaluatorVersionCreate
Definizione del valutatore
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| categories | array | Le categorie del valutatore | Sì | |
| Definizione | oggetto | Configurazione dell'analizzatore di base con discriminatore | Sì | |
| └data_schema | Lo schema JSON (bozza 2020-12) per i dati di input del valutatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| └init_parameters | Lo schema JSON (bozza 2020-12) per i parametri di input dell'analizzatore. Ciò include parametri come tipo, proprietà, obbligatorio. | NO | ||
| └* Metriche | oggetto | Elenco delle metriche di output prodotte da questo valutatore | NO | |
| └─ Tipo | AnalizzatoreDefinitionType | Il tipo di definizione del valutatore | NO | |
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| display_name | corda | Nome visualizzato per l'analizzatore. Aiuta a trovare facilmente l'analizzatore in Foundry. Non è necessario che sia univoco. | NO | |
| evaluator_type | oggetto | Il tipo di valutatore | Sì | |
| metadata | oggetto | Metadati relativi all'analizzatore | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO |
EvaluatorVersionUpdate
Definizione del valutatore
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| categories | array | Le categorie del valutatore | NO | |
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| display_name | corda | Nome visualizzato per l'analizzatore. Aiuta a trovare facilmente l'analizzatore in Foundry. Non è necessario che sia univoco. | NO | |
| metadata | oggetto | Metadati relativi all'analizzatore | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO |
FabricDataAgentToolParameters
Parametri dello strumento agente dati fabric.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| project_connections | array | Le connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. |
NO |
FileDatasetVersion
Definizione di FileDatasetVersion
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di set di dati Valori possibili: uri_file |
Sì |
FileDatasetVersionUpdate
Definizione di FileDatasetVersion
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di set di dati Valori possibili: uri_file |
Sì |
FolderDatasetVersion
Definizione di FileDatasetVersion
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di set di dati Valori possibili: uri_folder |
Sì |
FolderDatasetVersionUpdate
Definizione di FileDatasetVersion
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di set di dati Valori possibili: uri_folder |
Sì |
HostedAgentDefinition
Definizione dell'agente ospitato.
Discriminante per HostedAgentDefinition
Questo componente usa la proprietà kind per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
hosted |
ImageBasedHostedAgentDefinition |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| container_protocol_versions | array | Protocolli supportati dall'agente per la comunicazione in ingresso dei contenitori. | Sì | |
| CPU | corda | Configurazione della CPU per l'agente ospitato. | Sì | |
| environment_variables | oggetto | Variabili di ambiente da impostare nel contenitore dell'agente ospitato. | NO | |
| tipo/gentile | enum | Valori possibili: hosted |
Sì | |
| memory | corda | Configurazione della memoria per l'agente ospitato. | Sì | |
| strumenti | array | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: Hourly |
Sì |
HumanEvaluationRuleAction
Azione della regola di valutazione per la valutazione umana.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ID del modello | oggetto | Identificatore di un asset salvato. | Sì | |
| type | enum | Valori possibili: humanEvaluation |
Sì |
ImageBasedHostedAgentDefinition
Definizione di distribuzione basata su immagini per un agente hosted.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| image | corda | Immagine dell'agente ospitato. | Sì | |
| tipo/gentile | enum | Valori possibili: hosted |
Sì |
Index
Definizione della risorsa indice
Discriminare per l'indice
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
AzureSearch |
AzureAISearchIndex |
ManagedAzureSearch |
ManagedAzureAISearchIndex |
CosmosDBNoSqlVectorStore |
CosmosDBIndex |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | Asset ID, un identificatore univoco per l'asset | NO | |
| nome | corda | Nome della risorsa | Sì | |
| type | oggetto | Sì | ||
| version | corda | La versione della risorsa | Sì |
IndexType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | AzureSearchCosmosDBNoSqlVectorStoreManagedAzureSearch |
IndexUpdate
Definizione della risorsa indice
Discriminare per IndexUpdate
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
AzureSearch |
AzureAISearchIndexUpdate |
ManagedAzureSearch |
ManagedAzureAISearchIndexUpdate |
CosmosDBNoSqlVectorStore |
CosmosDBIndexUpdate |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Testo della descrizione dell'asset. | NO | |
| tags | oggetto | Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. | NO | |
| type | oggetto | Sì |
Intuzione
Corpo della risposta per le informazioni dettagliate del cluster.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome visualizzato | corda | Nome visualizzato descrittivo per l'approfondimento. | Sì | |
| id | corda | L'identificatore univoco per il report di informazioni dettagliate. | Sì | |
| metadata | oggetto | Metadati relativi alle informazioni dettagliate. | Sì | |
| └* completedAt | corda | Il timestamp in cui sono state completate le informazioni dettagliate. | NO | |
| └> createdAt | corda | Il timestamp in cui sono state create le informazioni dettagliate. | NO | |
| request | oggetto | La richiesta del report di approfondimento. | Sì | |
| └─ Tipo | InsightType | Tipo di richiesta. | NO | |
| risultato | oggetto | Il risultato degli approfondimenti. | NO | |
| └─ Tipo | InsightType | Il tipo di risultato delle informazioni dettagliate. | NO | |
| state | oggetto | Enumerazione che descrive gli stati di funzionamento consentiti. | Sì |
InsightCluster
Un cluster di campioni di analisi.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione del cluster di analisi. | Sì | |
| id | corda | L'ID del cluster di analisi. | Sì | |
| label | corda | Etichetta per il cluster | Sì | |
| Campioni | array | Elenco di campioni che appartengono a questo cluster. Vuoto se i campioni fanno parte di sottocluster. | NO | |
| subCluster | array | Elenco dei sottocluster all'interno di questo cluster. Vuoto se non esistono cluster secondari. | NO | |
| suggerimento | corda | Suggerimento per il cluster | Sì | |
| suggestionTitle | corda | Il titolo del suggerimento per il cluster | Sì | |
| weight | numero intero | Il peso del cluster di analisi. Indica il numero di campioni nel cluster. | Sì |
InsightModelConfiguration
Configurazione del modello utilizzato nella generazione dell'insight.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| modelDeploymentName | corda | 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 tipo | Schema |
|---|---|
EvaluationRunClusterInsight |
EvaluationRunClusterInsightsRequest |
AgentClusterInsight |
AgentClusterInsightsRequest |
EvaluationComparison |
EvaluationComparisonRequest |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | 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 tipo | Schema |
|---|---|
EvaluationComparison |
EvalCompareReport |
EvaluationRunClusterInsight |
EvaluationRunClusterInsightResult |
AgentClusterInsight |
AgentClusterInsightResult |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | 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 tipo | Schema |
|---|---|
EvaluationResultSample |
EvaluationResultSample |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| correlationInfo | oggetto | Informazioni sulla correlazione per il campione di analisi. | Sì | |
| features | oggetto | Funzionalità per aiutare con un filtraggio aggiuntivo dei dati in UX. | Sì | |
| id | corda | Identificatore univoco per il campione di analisi. | Sì | |
| type | oggetto | Il tipo di campione utilizzato nell'analisi. | Sì |
InsightScheduleTask
Attività di approfondimento per la pianificazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| dati analitici | oggetto | Corpo della risposta per le informazioni dettagliate del cluster. | Sì | |
| └\ displayName | corda | Nome visualizzato descrittivo per l'approfondimento. | NO | |
| └* id | corda | L'identificatore univoco per il report di informazioni dettagliate. | NO | |
| └─ metadati | InsightsMetadata | Metadati relativi al report di informazioni dettagliate. | NO | |
| └* richiesta | InsightRequest | Richiesta di analisi degli approfondimenti. | NO | |
| └* risultato | InsightResult | Il risultato del rapporto di approfondimento. | NO | |
| └* stato | Azure.Core.Foundations.OperationState | Stato corrente delle informazioni dettagliate. | NO | |
| type | enum | Valori possibili: Insight |
Sì |
InsightSummary
Riepilogo dell'analisi dei cluster di errori.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| method | corda | Metodo utilizzato per il clustering. | Sì | |
| sampleCount | numero intero | Numero totale di campioni analizzati. | Sì | |
| uniqueClusterCount | numero intero | Numero totale di cluster univoci. | Sì | |
| uniqueSubclusterCount | numero intero | Numero totale di etichette univoche del sottocluster. | Sì | |
| usage | oggetto | Utilizzo dei token per l'analisi dei cluster | Sì | |
| └\ inputTokenUsage | numero intero | Utilizzo del token di input | NO | |
| └\ outputTokenUsage | numero intero | Utilizzo del token di output | NO | |
| └> totalTokenUsage | numero intero | Utilizzo totale dei token | NO |
InsightType
La richiesta degli approfondimenti.
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | EvaluationRunClusterInsightAgentClusterInsightEvaluationComparison |
InsightsMetadata
Metadati relativi alle informazioni dettagliate.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| completedAt | corda | Il timestamp in cui sono state completate le informazioni dettagliate. | NO | |
| createdAt | corda | Il timestamp in cui sono state create le 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 tipo | Schema |
|---|
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | corda | Tipo di parametri di generazione di elementi da usare. | Sì |
ManagedAzureAISearchIndex
Definizione dell'indice di ricerca di Azure per intelligenza artificiale gestita
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di indice Valori possibili: ManagedAzureSearch |
Sì |
ManagedAzureAISearchIndexUpdate
Definizione dell'indice di ricerca di Azure per intelligenza artificiale gestita
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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 tipo | Schema |
|---|---|
user_profile |
UserProfileMemoryItem |
chat_summary |
ChatSummaryMemoryItem |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | corda | Il contenuto della memoria. | Sì | |
| tipo/gentile | oggetto | Tipo di elemento di memoria. | Sì | |
| memory_id | corda | L'ID univoco dell'elemento di memoria. | Sì | |
| scopo | corda | Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente. | Sì | |
| updated_at | numero intero | L'ora dell'ultimo aggiornamento dell'elemento in memoria. | Sì |
MemoryItemKind
Tipo di elemento di memoria.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di elemento di memoria. |
| Tipo | corda |
| Valori | user_profilechat_summary |
MemoryOperation
Rappresenta una singola operazione di memoria (creazione, aggiornamento o eliminazione) eseguita su un elemento di memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| tipo/gentile | oggetto | Tipo di operazione di memoria. | Sì | |
| memory_item | oggetto | Un singolo elemento di memoria memorizzato nell'archivio di memoria, contenente contenuto e metadati. | Sì | |
| └> contenuto | corda | Il contenuto della memoria. | NO | |
| └* tipo | MemoryItemKind | Il tipo di elemento della memoria. | NO | |
| └memory_id | corda | L'ID univoco dell'elemento di memoria. | NO | |
| Ambito └* | corda | Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente. | NO | |
| └updated_at | numero intero | L'ora dell'ultimo aggiornamento dell'elemento in memoria. | NO |
MemoryOperationKind
Tipo di operazione di memoria.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di operazione di memoria. |
| Tipo | corda |
| Valori | createupdatedelete |
MemorySearchItem
Elemento di memoria recuperato dalla ricerca in memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| memory_item | oggetto | Un singolo elemento di memoria memorizzato nell'archivio di memoria, contenente contenuto e metadati. | Sì | |
| └> contenuto | corda | Il contenuto della memoria. | NO | |
| └* tipo | MemoryItemKind | Il tipo di elemento della memoria. | NO | |
| └memory_id | corda | L'ID univoco dell'elemento di memoria. | NO | |
| Ambito └* | corda | Spazio dei nomi che raggruppa e isola logicamente le memorie, ad esempio un ID utente. | NO | |
| └updated_at | numero intero | L'ora dell'ultimo aggiornamento dell'elemento in memoria. | NO |
MemorySearchOptions
Opzioni di ricerca in memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_memories | numero intero | Numero massimo di elementi di memoria da restituire. | NO |
MemorySearchTool
Uno strumento per integrare i ricordi nell'agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| memory_store_name | corda | Nome dell'archivio di memoria da utilizzare. | Sì | |
| scopo | corda | 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 | oggetto | Opzioni di ricerca in memoria. | NO | |
| └max_memories | numero intero | Numero massimo di elementi di memoria da restituire. | NO | |
| type | enum | Tipo dello strumento. Sempre memory_search.Valori possibili: memory_search |
Sì | |
| update_delay | numero intero | Tempo di attesa prima di aggiornare le memorie dopo inattività (secondi). Impostazione predefinita: 300. | NO | 300 |
MemorySearchToolCallItemParam
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| results | array | I risultati restituiti dalla ricerca in memoria. | NO | |
| type | enum | Valori possibili: memory_search_call |
Sì |
MemorySearchToolCallItemResource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| results | array | I risultati restituiti dalla ricerca in 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| chat_model | corda | Nome o identificatore della distribuzione del modello di completamento della chat utilizzata per l'elaborazione della memoria. | Sì | |
| embedding_model | corda | Nome o identificatore della distribuzione del modello di incorporamento utilizzata per l'elaborazione della memoria. | Sì | |
| tipo/gentile | enum | Il tipo di memoria memorizzata. Valori possibili: default |
Sì | |
| options | oggetto | Configurazioni predefinite dell'archivio di memoria. | NO | |
| └chat_summary_enabled | boolean | Se abilitare l'estrazione e l'archiviazione del riepilogo della chat. Il valore predefinito è vero. | NO | Vero |
| └user_profile_details | corda | 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'archiviazione dei profili utente. Il valore predefinito è vero. | NO | Vero |
MemoryStoreDefaultOptions
Configurazioni predefinite dell'archivio di memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| chat_summary_enabled | boolean | Se abilitare l'estrazione e l'archiviazione del riepilogo della chat. Il valore predefinito è vero. | Sì | Vero |
| user_profile_details | corda | 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'archiviazione dei profili utente. Il valore predefinito è vero. | Sì | Vero |
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 tipo | Schema |
|---|---|
default |
MemoryStoreDefaultDefinition |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| tipo/gentile | oggetto | Tipo di implementazione dell'archivio memoria da utilizzare. | Sì |
MemoryStoreDeleteScopeResponse
Risposta per l'eliminazione di ricordi da un oscilloscopio.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Se l'operazione di eliminazione è stata eseguita correttamente. | Sì | |
| nome | corda | Il nome dell'archivio di memoria. | Sì | |
| oggetto | enum | Tipo dell'oggetto. Sempre 'memory_store.scope.deleted'. Valori possibili: memory_store.scope.deleted |
Sì | |
| scopo | corda | L'ambito da cui sono state eliminate le memorie. | Sì |
MemoryStoreKind
Tipo di implementazione dell'archivio memoria da utilizzare.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di implementazione dell'archivio memoria da utilizzare. |
| Tipo | corda |
| Valori | default |
MemoryStoreObject
Un archivio di memoria in grado di memorizzare e recuperare le memorie degli utenti.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | numero intero | Il timestamp Unix (secondi) in cui è stato creato l'archivio di memoria. | Sì | |
| Definizione | oggetto | Definizione di base per le configurazioni dell'archivio di memoria. | Sì | |
| └* tipo | MemoryStoreKind | Il tipo di memoria memorizzata. | NO | |
| descrizione | corda | Una descrizione leggibile dall'uomo dell'archivio di memoria. | NO | |
| id | corda | Identificatore univoco dell'archivio di memoria. | Sì | |
| metadata | oggetto | Metadati chiave-valore arbitrari da associare all'archivio di memoria. | NO | |
| nome | corda | Il nome dell'archivio di memoria. | Sì | |
| oggetto | enum | Il tipo di oggetto, che è sempre 'memory_store'. Valori possibili: memory_store |
Sì | |
| updated_at | numero intero | Il timestamp Unix (secondi) dell'ultimo aggiornamento dell'archivio di memoria. | Sì |
MemoryStoreOperationUsage
Statistiche di utilizzo di un'operazione di archiviazione della memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| embedding_tokens | numero intero | Il numero di token di incorporamento. | Sì | |
| input_tokens | numero intero | Numero di token di input. | Sì | |
| input_tokens_details | oggetto | Dettaglio dei token di input. | Sì | |
| └cached_tokens | numero intero | Numero di token recuperati dalla cache. Altre informazioni sulla memorizzazione nella cache dei prompt. |
NO | |
| output_tokens | numero intero | Numero di token in uscita. | Sì | |
| output_tokens_details | oggetto | Dettaglio dei token di output. | Sì | |
| └─ token_di_ragionamento | numero intero | Numero di token di ragionamento. | NO | |
| total_tokens | numero intero | Numero totale di token usati. | Sì |
MemoryStoreSearchResponse
Risposta di ricerca in memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Ricordi | array | Elementi di memoria correlati trovati durante l'operazione di ricerca. | Sì | |
| search_id | corda | L'ID univoco di questa richiesta di ricerca. Utilizzare questo valore come previous_search_id nelle richieste successive per eseguire ricerche incrementali. | Sì | |
| usage | oggetto | Statistiche di utilizzo di un'operazione di archiviazione della memoria. | Sì | |
| └embedding_tokens | numero intero | Il numero di token di incorporamento. | NO | |
| └ input_tokens | numero intero | Numero di token di input. | NO | |
| └input_tokens_details | oggetto | Dettaglio dei token di input. | NO | |
| └cached_tokens | numero intero | Numero di token recuperati dalla cache. Altre informazioni sulla memorizzazione nella cache dei prompt. |
NO | |
| └output_tokens | numero intero | Numero di token in uscita. | NO | |
| └output_tokens_details | oggetto | Dettaglio dei token di output. | NO | |
| └─ token_di_ragionamento | numero intero | Numero di token di ragionamento. | NO | |
| └total_tokens | numero intero | Numero totale di token usati. | NO |
MemoryStoreUpdateCompletedResult
Risultato dell'aggiornamento della memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| memory_operations | array | Elenco delle singole operazioni di memoria eseguite durante l'aggiornamento. | Sì | |
| usage | oggetto | Statistiche di utilizzo di un'operazione di archiviazione della memoria. | Sì | |
| └embedding_tokens | numero intero | Il numero di token di incorporamento. | NO | |
| └ input_tokens | numero intero | Numero di token di input. | NO | |
| └input_tokens_details | oggetto | Dettaglio dei token di input. | NO | |
| └cached_tokens | numero intero | Numero di token recuperati dalla cache. Altre informazioni sulla memorizzazione nella cache dei prompt. |
NO | |
| └output_tokens | numero intero | Numero di token in uscita. | NO | |
| └output_tokens_details | oggetto | Dettaglio dei token di output. | NO | |
| └─ token_di_ragionamento | numero intero | Numero di token di ragionamento. | NO | |
| └total_tokens | numero intero | Numero totale di token usati. | NO |
MemoryStoreUpdateResponse
Fornisce lo stato di un'operazione di aggiornamento dell'archivio di memoria.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | oggetto | NO | ||
| └* additionalInfo | oggetto | NO | ||
| └─ codice | corda | NO | ||
| └* debugInfo | oggetto | NO | ||
| └* dettagli | array | NO | ||
| └* messaggio | corda | NO | ||
| └* param | corda | NO | ||
| └─ Tipo | corda | NO | ||
| risultato | oggetto | Risultato dell'aggiornamento della memoria. | NO | |
| └memory_operations | array | Elenco delle singole operazioni di memoria eseguite durante l'aggiornamento. | NO | |
| └─ utilizzo | MemoryStoreOperationUsage | Statistiche di utilizzo associate all'operazione di aggiornamento della memoria. | NO | |
| stato | oggetto | Stato di un'operazione di aggiornamento dell'archivio di memoria. | Sì | |
| superseded_by | corda | Il update_id l'operazione è stato sostituito da quando lo status è "sostituito". | NO | |
| update_id | corda | ID univoco della richiesta di aggiornamento. Utilizzare 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 |
|---|---|
| Descrizione | Stato di un'operazione di aggiornamento dell'archivio di memoria. |
| Tipo | corda |
| Valori | queuedin_progresscompletedfailedsuperseded |
MicrosoftFabricAgentTool
Informazioni sulla definizione di input per uno strumento di Microsoft Fabric usato per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| fabric_dataagent_preview | oggetto | Parametri dello strumento agente dati fabric. | Sì | |
| └project_connections | array | Le connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. |
NO | |
| type | enum | Tipo di oggetto, che è sempre "fabric_dataagent". Valori possibili: fabric_dataagent_preview |
Sì |
ModelDeployment
Definizione della distribuzione del modello
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| capabilities | oggetto | Funzionalità del modello distribuito | Sì | |
| connectionName | corda | Nome della connessione da cui proviene la distribuzione | NO | |
| modelName | corda | Nome specifico dell'editore del modello distribuito | Sì | |
| modelPublisher | corda | Nome dell'editore del modello distribuito | Sì | |
| versione del modello | corda | Versione specifica dell'editore del modello distribuito | Sì | |
| sku | oggetto | Informazioni sullo SKU | Sì | |
| └* capacità | numero intero | Capacità sku | NO | |
| Famiglia └* | corda | Famiglia Sku | NO | |
| └> nome | corda | Nome SKU | NO | |
| └* dimensioni | corda | Dimensioni sku | NO | |
| Livello └* | corda | Livello SKU | NO | |
| type | enum | Il 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_completion_tokens | numero intero | Numero massimo di token consentiti nel completamento. | Sì | |
| seed | numero intero | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_completion_tokens | numero intero | Numero massimo di token consentiti nel completamento. | NO | |
| seed | numero intero | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| daysOfMonth | array | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di credenziale Valori possibili: None |
Sì |
OAuthConsentRequestItemResource
Richiedere al servizio per consentire all'utente di eseguire il consenso OAuth.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| consent_link | corda | Collegamento che l'utente può usare per eseguire il consenso OAuth. | Sì | |
| id | corda | Sì | ||
| etichetta del server | corda | Etichetta del server per la richiesta di consenso OAuth. | Sì | |
| type | enum | Valori possibili: oauth_consent_request |
Sì |
OneTimeTrigger
Attivazione una tantum.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| timeZone | corda | Fuso orario per l'attivazione una tantum. | NO | UTC |
| triggerAt | corda | Data e ora del trigger una tantum in formato ISO 8601. | Sì | |
| type | enum | Valori possibili: OneTime |
Sì |
OpenAI.Annotation
Discriminare per OpenAI.Annotation
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
file_citation |
OpenAI.AnnotationFileCitation |
url_citation |
OpenAI.AnnotationUrlCitation |
file_path |
OpenAI.AnnotationFilePath |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.AnnotationType | Sì |
OpenAI.AnnotationFileCitation
Citazione in un file.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ID del file | corda | ID del file. | Sì | |
| filename | corda | Nome file del file citato. | Sì | |
| indice | numero intero | Indice del file nell'elenco di file. | Sì | |
| type | enum | Tipo di citazione del file. Sempre file_citation.Valori possibili: file_citation |
Sì |
OpenAI.AnnotationFilePath
Percorso di un file.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ID del file | corda | ID del file. | Sì | |
| indice | numero intero | Indice del file nell'elenco di file. | Sì | |
| type | enum | Tipo del percorso del file. Sempre file_path.Valori possibili: file_path |
Sì |
OpenAI.AnnotationType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | file_citationurl_citationfile_pathcontainer_file_citation |
OpenAI.AnnotationUrlCitation
Citazione per una risorsa Web usata per generare una risposta del modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| end_index | numero intero | Indice dell'ultimo carattere della citazione URL nel messaggio. | Sì | |
| start_index | numero intero | Indice del primo carattere della citazione URL nel messaggio. | Sì | |
| title | corda | Titolo della risorsa Web. | Sì | |
| type | enum | Tipo di citazione URL. Sempre url_citation.Valori possibili: url_citation |
Sì | |
| URL. | corda | URL della risorsa Web. | Sì |
OpenAI.PosizioneApprossimativa
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| città | corda | NO | ||
| country | corda | NO | ||
| region | corda | NO | ||
| timezone | corda | NO | ||
| type | enum | Valori possibili: approximate |
Sì |
OpenAI.ChatCompletionTool
Strumento di funzione che può essere usato per generare una risposta.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| funzione | OpenAI.FunctionObject | Sì | ||
| type | enum | Tipo dello strumento. Attualmente è supportato solo function.Valori possibili: function |
Sì |
OpenAI.CodeInterpreterOutput
Discriminatore per OpenAI.CodeInterpreterOutput
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
image |
OpenAI.CodeInterpreterOutputImage |
logs |
OpenAI.CodeInterpreterOutputLogs |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.CodeInterpreterOutputType | Sì |
OpenAI.CodeInterpreterOutputImage
Output dell'immagine dall'interprete di codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo dell'output. Sempre 'image'. Valori possibili: image |
Sì | |
| URL. | corda | URL dell'output dell'immagine dall'interprete di codice. | Sì |
OpenAI.CodeInterpreterOutputLogs
Output dei log dall'interprete del codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| logs | corda | Output dei log dall'interprete del codice. | Sì | |
| type | enum | Tipo dell'output. Sempre 'logs'. Valori possibili: logs |
Sì |
OpenAI.CodeInterpreterOutputType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | logsimage |
OpenAI.CodeInterpreterTool
Strumento che esegue codice Python per generare una risposta a un prompt.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| container | oggetto | Configurazione per un contenitore dell'interprete di codice. Facoltativamente, specificare gli ID dei file su cui eseguire il codice. |
Sì | |
| └file_ids | array | Elenco facoltativo di file caricati da rendere disponibili al tuo codice. | NO | |
| └─ Tipo | enum | Sempre auto.Valori possibili: auto |
NO | |
| type | enum | Tipo dello strumento dell'interprete di codice. Sempre code_interpreter.Valori possibili: code_interpreter |
Sì |
OpenAI.CodeInterpreterToolAuto
Configurazione per un contenitore dell'interprete di codice. Facoltativamente, specificare gli ID dei file in cui eseguire il codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| identificatori_di_file | array | Elenco facoltativo di file caricati da rendere disponibili al tuo codice. | NO | |
| type | enum | Sempre auto.Valori possibili: auto |
Sì |
OpenAI.CodeInterpreterToolCallItemParam
Chiamata dello strumento per eseguire il codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Codice da eseguire o Null se non disponibile. | Sì | |
| container_id | corda | ID del contenitore usato per eseguire il codice. | Sì | |
| Risultati | array | Output generati dall'interprete del codice, ad esempio log o immagini. Può essere Null se non sono disponibili output. |
Sì | |
| type | enum | Valori possibili: code_interpreter_call |
Sì |
OpenAI.CodeInterpreterToolCallItemResource
Chiamata dello strumento per eseguire il codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Codice da eseguire o Null se non disponibile. | Sì | |
| container_id | corda | ID del contenitore usato per eseguire il codice. | Sì | |
| Risultati | array | Output generati dall'interprete del codice, ad esempio log o immagini. Può essere Null se non sono disponibili output. |
Sì | |
| stato | enum | Valori possibili: in_progress, completedincomplete, , interpreting,failed |
Sì | |
| type | enum | Valori possibili: code_interpreter_call |
Sì |
OpenAI.ComparisonFilter
Filtro utilizzato per confrontare una chiave di attributo specificata con un determinato valore usando un'operazione di confronto definita.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| chiave | corda | La chiave da confrontare rispetto al valore. | Sì | |
| type | enum | Specifica l'operatore di confronto:eq (uguale), ne (diverso da), gt (maggiore di), gte (maggiore o uguale), (minore di), ltlte (minore o uguale).Valori possibili: eq, negt, gte, , ltlte |
Sì | |
| valore | stringa o numero o valore booleano | Sì |
OpenAI.CompoundFilter
Combinare più filtri usando and o or.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| filters | array | 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 tipo | Schema |
|---|---|
click |
OpenAI.ComputerActionClick |
double_click |
OpenAI.ComputerActionDoubleClick |
drag |
OpenAI.ComputerActionDrag |
move |
OpenAI.ComputerActionMove |
screenshot |
OpenAI.ComputerActionScreenshot |
scroll |
OpenAI.ComputerActionScroll |
type |
OpenAI.ComputerActionTypeKeys |
wait |
OpenAI.ComputerActionWait |
keypress |
OpenAI.ComputerActionKeyPress |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ComputerActionType | Sì |
OpenAI.ComputerActionClick
Azione di fare clic.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| pulsante | enum | Indica il pulsante del mouse premuto durante il clic. Uno di left, rightwheel, back, o forward.Valori possibili: left, rightwheel, , back,forward |
Sì | |
| type | enum | Specifica il tipo di evento. Per un'azione click, questa proprietà è sempre impostato su click.Valori possibili: click |
Sì | |
| x | numero intero | Coordinata x in cui si è verificato il clic. | Sì | |
| y | numero intero | Coordinata y in cui si è verificato il clic. | Sì |
OpenAI.ComputerActionDoubleClick
Azione con doppio clic.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Specifica il tipo di evento. Per un'azione di doppio clic, questa proprietà è sempre impostato su double_click.Valori possibili: double_click |
Sì | |
| x | numero intero | Coordinata x in cui si è verificato il doppio clic. | Sì | |
| y | numero intero | Coordinata y in cui si è verificato il doppio clic. | Sì |
OpenAI.ComputerActionDrag
Azione di trascinamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| path | array | 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.ComputerActionKeyPress
Una raccolta di pressioni di tasti che il modello desidera eseguire.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Chiavi | array | La combinazione di tasti che il modello richiede di premere. Questo è un matrice di stringhe, ognuna che rappresenta una chiave. |
Sì | |
| type | enum | Specifica il tipo di evento. Per un'azione keypress, questa proprietà è sempre impostato su keypress.Valori possibili: keypress |
Sì |
OpenAI.ComputerActionMove
Azione di spostamento del mouse.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Specifica il tipo di evento. Per un'azione di spostamento, questa proprietà è sempre impostato su move.Valori possibili: move |
Sì | |
| x | numero intero | Coordinata x in cui spostarsi. | Sì | |
| y | numero intero | Coordinata y su cui spostarsi. | Sì |
OpenAI.ComputerActionScreenshot
Azione screenshot.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Specifica il tipo di evento. Per un'azione screenshot, questa proprietà è sempre impostato su screenshot.Valori possibili: screenshot |
Sì |
OpenAI.ComputerActionScroll
Azione di scorrimento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| scroll_x | numero intero | Distanza di scorrimento orizzontale. | Sì | |
| scroll_y | numero intero | Distanza di scorrimento verticale. | Sì | |
| type | enum | Specifica il tipo di evento. Per un'azione di scorrimento, questa proprietà è sempre impostato su scroll.Valori possibili: scroll |
Sì | |
| x | numero intero | Coordinata x in cui si è verificato lo scorrimento. | Sì | |
| y | numero intero | Coordinata y in cui si è verificato lo scorrimento. | Sì |
OpenAI.ComputerActionType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | screenshotclickdouble_clickscrolltypewaitkeypressdragmove |
OpenAI.ComputerActionTypeKeys
Azione per digitare del testo.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Testo | corda | 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.ComputerActionWait
Azione di attesa.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Specifica il tipo di evento. Per un'azione di attesa, questa proprietà è sempre impostato su wait.Valori possibili: wait |
Sì |
OpenAI.ComputerToolCallItemParam
Chiamata di uno strumento a uno strumento per l'uso del computer. Per ulteriori informazioni, consultare la guida all'uso del computer .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | OpenAI.ComputerAction | Sì | ||
| call_id | corda | Identificatore usato per rispondere alla chiamata dello strumento con output. | Sì | |
| pending_safety_checks | array | Controlli di sicurezza in sospeso per la chiamata computer. | Sì | |
| type | enum | Valori possibili: computer_call |
Sì |
OpenAI.ComputerToolCallItemResource
Chiamata di uno strumento a uno strumento per l'uso del computer. Per ulteriori informazioni, consultare la guida all'uso del computer .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | OpenAI.ComputerAction | Sì | ||
| call_id | corda | Identificatore usato per rispondere alla chiamata dello strumento con output. | Sì | |
| pending_safety_checks | array | Controlli di sicurezza in sospeso per la chiamata computer. | Sì | |
| stato | enum | Stato dell'elemento. Uno di in_progress, completed, oincomplete. Popolato quando gli elementi vengono restituiti tramite l'API.Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Valori possibili: computer_call |
Sì |
OpenAI.ComputerToolCallOutputItemOutput
Discriminare per OpenAI.ComputerToolCallOutputItemOutput
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
computer_screenshot |
OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ComputerToolCallOutputItemOutputType | Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer. | Sì |
OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ID del file | corda | NO | ||
| image_url | corda | NO | ||
| type | enum | Valori possibili: computer_screenshot |
Sì |
OpenAI.ComputerToolCallOutputItemOutputType
Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer.
| Proprietà | Value |
|---|---|
| Descrizione | Immagine di uno screenshot del computer usata con lo strumento per l'uso del computer. |
| Tipo | corda |
| Valori | computer_screenshot |
OpenAI.ComputerToolCallOutputItemParam
Output di una chiamata allo strumento del computer.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array | I controlli di sicurezza segnalati dall'API che sono stati riconosciuti dal sviluppatore. |
NO | |
| call_id | corda | ID della chiamata dello strumento del computer che ha prodotto l'output. | Sì | |
| output | OpenAI.ComputerToolCallOutputItemOutput | Sì | ||
| type | enum | Valori possibili: computer_call_output |
Sì |
OpenAI.ComputerToolCallOutputItemResource
Output di una chiamata allo strumento del computer.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| acknowledged_safety_checks | array | I controlli di sicurezza segnalati dall'API che sono stati riconosciuti dal sviluppatore. |
NO | |
| call_id | corda | ID della chiamata dello strumento del computer che ha prodotto l'output. | Sì | |
| output | OpenAI.ComputerToolCallOutputItemOutput | Sì | ||
| stato | enum | Stato dell'elemento. Uno di in_progress, completed, oincomplete. Popolato quando gli elementi vengono restituiti tramite l'API.Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Valori possibili: computer_call_output |
Sì |
OpenAI.ComputerToolCallSafetyCheck
Controllo di sicurezza in sospeso per la chiamata computer.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Tipo del controllo di sicurezza in sospeso. | Sì | |
| id | corda | ID del controllo di sicurezza in sospeso. | Sì | |
| message | corda | Dettagli sul controllo di sicurezza in sospeso. | Sì |
OpenAI.ComputerUsePreviewTool
Strumento che controlla un computer virtuale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| altezza_schermo | numero intero | Altezza dello schermo del computer. | Sì | |
| larghezza_display | numero intero | Larghezza della visualizzazione del computer. | Sì | |
| environment | enum | Tipo di ambiente del computer da controllare. Valori possibili: windows, maclinux, , ubuntu,browser |
Sì | |
| type | enum | Tipo dello strumento di utilizzo del computer. Sempre computer_use_preview.Valori possibili: computer_use_preview |
Sì |
OpenAI.ConversationItemList
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data | array | Sì | ||
| first_id | corda | Sì | ||
| ha_di_piu | boolean | Sì | ||
| last_id | corda | Sì | ||
| oggetto | enum | Valori possibili: list |
Sì |
OpenAI.ConversationResource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | numero intero | Sì | ||
| id | corda | ID univoco della conversazione. | Sì | |
| metadata | oggetto | 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ì | |
| oggetto | enum | Tipo di oggetto, che è sempre "conversazione". Valori possibili: conversation |
Sì |
OpenAI.Coordinate
Coppia di coordinate x/y, ad esempio { x: 100, y: 200 }.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| x | numero intero | Coordinata x. | Sì | |
| y | numero intero | Coordinata y. | Sì |
OpenAI.CreateConversationRequest
Creare una conversazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| elementi | array | Elementi iniziali da includere nel contesto della conversazione. È possibile aggiungere fino a 20 elementi alla volta. |
NO | |
| metadata | oggetto | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| messaggi di input | oggetto | NO | ||
| └item_reference | corda | NO | ||
| Modello └─ | array | NO | ||
| └─ Tipo | enum | Valori possibili: item_reference |
NO | |
| model | corda | Nome del modello da utilizzare per la generazione di completamenti, ad esempio "o3-mini". | NO | |
| sampling_params | OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams | NO | ||
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └─created_after | OpenAI.integer | NO | ||
| └─ creato_prima | OpenAI.integer | NO | ||
| └* id | corda | Identificatore del file. | NO | |
| └* limite | OpenAI.integer | NO | ||
| └─ metadati | 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. |
NO | |
| └─ Modello | corda | NO | ||
| └─ Tipo | enum | Tipo di origine. Sempre stored_completions.Valori possibili: stored_completions |
NO | |
| type | enum | Tipo di origine dati di esecuzione. Sempre completions.Valori possibili: completions |
Sì |
OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_reference | corda | Sì | ||
| type | enum | Valori possibili: item_reference |
Sì |
OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| modello | array | Sì | ||
| type | enum | Valori possibili: template |
Sì |
OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_completion_tokens | OpenAI.integer | NO | ||
| sforzo di ragionamento | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| formato_risposta | oggetto | Formato di risposta predefinito. Usato per generare risposte di testo. | NO | |
| └ json_schema | oggetto | Opzioni di configurazione degli output strutturati, incluso uno schema JSON. | NO | |
| └* descrizione | corda | Descrizione del formato di risposta, usato dal modello per decidere come rispondere al formato. |
NO | |
| └> nome | corda | 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. |
NO | |
| └─ Schema | oggetto | NO | ||
| └─ rigoroso | boolean | Indica se abilitare una rigorosa conformità allo schema durante la generazione dell'output. Se impostato su true, il modello seguirà sempre lo schema esatto definito nel schema campo. Quando è supportato solo un subset di schema JSONstrict è true. Per altre informazioni, vedere Output strutturatiguida. |
NO | Falso |
| └─ Tipo | enum | Tipo di formato di risposta definito. Sempre json_object.Valori possibili: json_object |
NO | |
| seed | oggetto | NO | ||
| temperatura | oggetto | NO | ||
| strumenti | array | NO | ||
| top_p | oggetto | NO |
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:
- Usati per definire i criteri di test e
- Dati necessari per la creazione di un'esecuzione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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 | oggetto | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └* id | corda | Identificatore del file. | NO | |
| └─ Tipo | enum | Tipo di origine JSONL. Sempre file_id.Valori possibili: file_id |
NO | |
| 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 dei log.
Si tratta in genere di metadati come usecase=chatbot o prompt-version=v2e così via.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| metadata | oggetto | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| messaggi di input | oggetto | NO | ||
| └item_reference | corda | NO | ||
| Modello └─ | array | NO | ||
| └─ Tipo | enum | Valori possibili: item_reference |
NO | |
| model | corda | Nome del modello da utilizzare per la generazione di completamenti, ad esempio "o3-mini". | NO | |
| sampling_params | OpenAI.CreateEvalResponsesRunDataSourceSamplingParams | NO | ||
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └─created_after | OpenAI.integer | NO | ||
| └─ creato_prima | OpenAI.integer | NO | ||
| └* id | corda | Identificatore del file. | NO | |
| └instructions_search | corda | NO | ||
| └─ metadati | oggetto | NO | ||
| └─ Modello | corda | NO | ||
| └• reasoning_effort | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| └* temperatura | OpenAI.numeric | NO | ||
| Strumenti └* | array | NO | ||
| └top_p | OpenAI.numeric | NO | ||
| └─ Tipo | enum | Tipo di origine dati di esecuzione. Sempre responses.Valori possibili: responses |
NO | |
| └─ utenti | array | NO | ||
| type | enum | Tipo di origine dati di esecuzione. Sempre responses.Valori possibili: responses |
Sì |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_reference | corda | Sì | ||
| type | enum | Valori possibili: item_reference |
Sì |
OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| modello | array | Sì | ||
| type | enum | Valori possibili: template |
Sì |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParams
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_completion_tokens | OpenAI.integer | NO | ||
| sforzo di ragionamento | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| seed | oggetto | NO | ||
| temperatura | oggetto | NO | ||
| Testo | OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText | NO | ||
| strumenti | array | NO | ||
| top_p | oggetto | NO |
OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| format | 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 la 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, chegarantisce 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| metadata | oggetto | Filtri dei metadati per l'origine dati dei completamenti 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| iperparametri | oggetto | Iperparametri usati per il processo di ottimizzazione. Questo valore è ora deprecato a favore di methode deve essere passato sotto il parametro method. |
NO | |
| └' batch_size | enum | Valori possibili: auto |
NO | |
| └' learning_rate_multiplier | enum | Valori possibili: auto |
NO | |
| └' n_epochs | enum | Valori possibili: auto |
NO | |
| integrazioni | array | Elenco di integrazioni da abilitare per il processo di ottimizzazione. | NO | |
| metadata | oggetto | 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 uno dei modelli supportati. |
Sì | |
| seed | numero intero | Il seme controlla la riproducibilità del lavoro. Il passaggio degli stessi parametri di inizializzazione e processo dovrebbe produrre gli stessi risultati, ma in rari casi può differire. Se non viene specificato un valore di inizializzazione, ne verrà generato uno automaticamente. |
NO | |
| suffix | corda | Stringa di un massimo di 64 caratteri che verrà aggiunta al nome del modello ottimizzato. Ad esempio, un suffix oggetto "custom-model-name" produrrebbe un nome di modello come ft:gpt-4o-mini:openai:custom-model-name:7p4lURel. |
NO | None |
| file di allenamento | corda | ID di un file caricato che contiene i dati di training. 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 delle preferenze. Per altri dettagli, vedere la guida all'ottimizzazione. |
Sì | |
| file_di_validazione | corda | ID di un file caricato contenente 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 nel file dei risultati dell'ottimizzazione. Gli stessi dati non devono essere presenti sia nei file di training sia nei file di convalida. Il set di dati deve essere formattato come file JSONL. È necessario caricare il file con lo scopo fine-tune.Per altri dettagli, vedere la guida all'ottimizzazione. |
NO |
OpenAI.CreateFineTuningJobRequestIntegration
Discriminatore per OpenAI.CreateFineTuningJobRequestIntegration
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
wandb |
OpenAI.CreateFineTuningJobRequestWandbIntegration |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | string (vedere modelli validi di seguito) | Sì |
OpenAI.CreateFineTuningJobRequestWandbIntegration
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: wandb |
Sì | |
| wandb | oggetto | Sì | ||
| └─ Entità | corda | NO | ||
| └> nome | corda | NO | ||
| └─ Progetto | corda | NO | ||
| └* tag | array | NO |
OpenAI.CreateResponse
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| agent | oggetto | NO | ||
| └> nome | corda | Nome dell'agente. | NO | |
| └─ Tipo | enum | Valori possibili: agent_reference |
NO | |
| └─ versione | corda | Identificatore della versione dell'agente. | NO | |
| sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| includi | array | Specificare dati di output aggiuntivi da includere nella risposta del modello. Attualmente i valori supportati sono: - code_interpreter_call.outputs: include gli output dell'esecuzione del codice Pythonnegli elementi di chiamata dello strumento dell'interprete di codice. - computer_call_output.output.image_url: includere gli URL delle immagini provenienti dall'output della chiamata computer.- file_search_call.results: includere i risultati della ricerca dirichiesta allo strumento di ricerca dei file. - message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.- message.output_text.logprobs: includere logprob con messaggi di assistente.- reasoning.encrypted_content: include una versione crittografata del motivotoken nell'output dell'elemento di ragionamento. In questo modo è possibile utilizzare gli elementi di ragionamento in conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su false o quando un'organizzazione èregistrato nel programma a conservazione dati nulla. |
NO | |
| ingresso | stringa o matrice | NO | ||
| instructions | corda | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| metadata | oggetto | 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 | corda | Il modello di distribuzione da utilizzare per la creazione di questa risposta. | NO | |
| chiamate_parallele_agli_strumenti | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| prompt | oggetto | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* id | corda | Identificatore univoco del modello di richiesta da utilizzare. | NO | |
| ** └─ Variabili | OpenAI.ResponsePromptVariables | 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 | |
| └─ versione | corda | Versione facoltativa del modello di richiesta. | NO | |
| reasoning | oggetto |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └* sforzo | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| └─ genera_sommario | enum |
Deprecato: utilizzare summary al suo posto. Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| └─ Riepilogo | enum | Riepilogo del ragionamento eseguito dal modello. Può trattarsi di utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| livello_servizio | oggetto | Specifica il tipo di elaborazione utilizzato per gestire la richiesta. * Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurata nelle impostazioni del progetto. Se non diversamente configurato, il progetto userà 'default'. * Se impostato su "default", la richiesta verrà elaborata con lo standard prezzi e prestazioni per il modello selezionato. * Se impostato su 'flex' o "priorità", la richiesta verrà elaborata con il servizio corrispondente livello. Per altre informazioni sull'elaborazione priorità, contattare le vendite. * Quando non è impostato, il comportamento predefinito è 'auto'. Quando il service_tier parametro è impostato, il corpo della risposta includerà service_tiervalore basato sulla modalità di elaborazione effettivamente utilizzata per gestire la richiesta. Questo valore della risposta può essere diverso dal valore impostato nel parametro . |
NO | |
| store | boolean | Indica se archiviare la risposta del modello generata per il recupero successivo tramite API. |
NO | Vero |
| torrente | boolean | Se impostato su true, i dati di risposta del modello verranno trasmessi al client generato tramite eventi inviati dal server. per altre informazioni. |
NO | Falso |
| structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | 1 |
| Testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| tool_choice | oggetto | Controlla quale strumento (se presente) viene chiamato dal modello.none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno opiù strumenti required indica che il modello deve chiamare uno o più strumenti. |
NO | |
| └─ Tipo | OpenAI.ToolChoiceObjectType | Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti. |
NO | |
| strumenti | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: - Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca di file. - Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. |
NO | |
| top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | 1 |
| truncation | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. Valori possibili: auto, disabled |
NO | |
| utente | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO |
OpenAI.DeletedConversationResource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cancellato | boolean | Sì | ||
| id | corda | Sì | ||
| oggetto | enum | Valori possibili: conversation.deleted |
Sì |
OpenAI.EasyInputMessage
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | stringa o matrice | Sì | ||
| ruolo | corda | Sì |
OpenAI.Error
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| informazioni aggiuntive | oggetto | NO | ||
| codice | corda | Sì | ||
| Informazioni di debug | oggetto | NO | ||
| details | array | NO | ||
| message | corda | Sì | ||
| param | corda | Sì | ||
| type | corda | Sì |
Errore OpenAI.EvalApiError
Oggetto che rappresenta una risposta di errore dall'API Eval.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Codice di errore. | Sì | |
| message | corda | Messaggio di errore. | Sì |
OpenAI.EvalGraderLabelModel
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ingresso | array | Sì | ||
| labels | array | Etichette da assegnare a ogni elemento della valutazione. | Sì | |
| model | corda | Modello da utilizzare per la valutazione. Deve supportare output strutturati. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| etichette_di_passaggio | array | Le etichette che indicano un risultato positivo. Deve essere un sottoinsieme di etichette. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: label_model |
Sì |
OpenAI.EvalGraderPython
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| image_tag | corda | Tag immagine da usare per lo script Python. | NO | |
| nome | corda | Nome del grader. | Sì | |
| soglia di superamento | oggetto | NO | ||
| source | corda | Codice sorgente dello script Python. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre python.Valori possibili: python |
Sì |
OpenAI.EvalGraderScoreModel
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ingresso | array | Testo di input. Ciò può includere stringhe di modello. | Sì | |
| model | corda | Modello da utilizzare per la valutazione. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| soglia di superamento | oggetto | NO | ||
| intervallo | array | La gamma del punteggio. Il valore predefinito è [0, 1]. |
NO | |
| sampling_params | oggetto | NO | ||
| └max_completions_tokens | OpenAI.integer | NO | ||
| └• reasoning_effort | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| └* seed | OpenAI.integer | NO | ||
| └* temperatura | OpenAI.numeric | NO | ||
| └top_p | OpenAI.numeric | NO | ||
| type | enum | Il tipo di oggetto, che è sempre score_model.Valori possibili: score_model |
Sì |
OpenAI.EvalGraderScoreModelSamplingParams
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| max_completions_tokens | oggetto | NO | ||
| sforzo di ragionamento | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| seed | oggetto | NO | ||
| temperatura | oggetto | NO | ||
| top_p | oggetto | NO |
OpenAI.EvalGraderStringCheck
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ingresso | corda | Testo di input. Ciò può includere stringhe di modello. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| operazione | enum | Operazione di controllo della stringa da eseguire. Uno tra eq, ne, like o ilike.Valori possibili: eq, ne, like, ilike |
Sì | |
| riferimento | corda | Testo di riferimento. Ciò può includere stringhe di modello. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre string_check.Valori possibili: string_check |
Sì |
OpenAI.EvalGraderTextSimilarity
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| metrica di valutazione | enum | Metrica di valutazione da usare. Uno tra cosine, fuzzy_match, bleu,gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5o rouge_l.Valori possibili: cosine, fuzzy_matchbleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l |
Sì | |
| ingresso | corda | Il testo in valutazione. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| soglia di superamento | oggetto | Sì | ||
| riferimento | corda | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | oggetto | Input di testo per il modello. | Sì | |
| └* dati | corda | Dati audio con codifica Base64. | NO | |
| └─ dettaglio | corda | NO | ||
| └* formato | enum | Formato dei dati audio. I formati attualmente supportati sono mp3 ewav.Valori possibili: mp3, wav |
NO | |
| └ image_url | corda | NO | ||
| └─ testo | corda | NO | ||
| └─ Tipo | enum | Tipo dell'elemento di input. Sempre input_audio.Valori possibili: input_audio |
NO | |
| ruolo | enum | Ruolo dell'inserimento del messaggio. Uno di user, assistant, system, odeveloper.Valori possibili: user, assistant, system, developer |
Sì | |
| type | enum | Tipo di input del messaggio. Sempre message.Valori possibili: message |
NO |
OpenAI.EvalItemContentInputImage
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| detail | corda | NO | ||
| image_url | corda | Sì | ||
| type | enum | Valori possibili: input_image |
Sì |
OpenAI.EvalItemContentOutputText
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Testo | corda | Sì | ||
| type | enum | Valori possibili: output_text |
Sì |
OpenAI.EvalJsonlFileContentSource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | array | Contenuto del file jsonl. | Sì | |
| type | enum | Tipo di origine JSONL. Sempre file_content.Valori possibili: file_content |
Sì |
OpenAI.EvalJsonlFileContentSourceContentContent
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| oggetto | oggetto | Sì | ||
| campione | oggetto | NO |
OpenAI.EvalJsonlFileIdSource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_dopo | oggetto | NO | ||
| creato_prima | oggetto | NO | ||
| instructions_search | corda | NO | ||
| metadata | oggetto | NO | ||
| model | corda | NO | ||
| sforzo di ragionamento | oggetto | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| temperatura | oggetto | NO | ||
| strumenti | array | NO | ||
| top_p | oggetto | NO | ||
| type | enum | Tipo di origine dati di esecuzione. Sempre responses.Valori possibili: responses |
Sì | |
| users | array | NO |
OpenAI.EvalRunOutputItemSample
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | OpenAI.EvalApiError | Oggetto che rappresenta una risposta di errore dall'API Eval. | Sì | |
| finish_reason | corda | Sì | ||
| ingresso | array | Sì | ||
| max_completion_tokens | OpenAI.integer | Sì | ||
| model | corda | Sì | ||
| output | array | Sì | ||
| seed | OpenAI.integer | Sì | ||
| temperatura | OpenAI.numeric | Sì | ||
| top_p | OpenAI.numeric | Sì | ||
| usage | OpenAI.EvalRunOutputItemSampleUsage | Sì |
OpenAI.EvalRunOutputItemSampleInput
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | corda | Sì | ||
| ruolo | corda | Sì |
OpenAI.EvalRunOutputItemSampleOutput
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | corda | NO | ||
| ruolo | corda | NO |
OpenAI.EvalRunOutputItemSampleUsage
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cached_tokens | OpenAI.integer | Sì | ||
| completion_tokens | OpenAI.integer | Sì | ||
| prompt_tokens | OpenAI.integer | Sì | ||
| total_tokens | OpenAI.integer | Sì |
OpenAI.EvalRunPerModelUsage
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cached_tokens | OpenAI.integer | Sì | ||
| completion_tokens | OpenAI.integer | Sì | ||
| invocation_count | OpenAI.integer | Sì | ||
| nome_modello | corda | Sì | ||
| prompt_tokens | OpenAI.integer | Sì | ||
| total_tokens | OpenAI.integer | Sì |
OpenAI.EvalRunPerTestingCriteriaResults
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| fallito | OpenAI.integer | Sì | ||
| passato | OpenAI.integer | Sì | ||
| criteri_di_test | corda | Sì |
OpenAI.EvalRunResultCounts
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_dopo | oggetto | NO | ||
| creato_prima | oggetto | NO | ||
| limit | oggetto | NO | ||
| 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. |
NO | |
| model | corda | NO | ||
| type | enum | Tipo di origine. Sempre stored_completions.Valori possibili: stored_completions |
Sì |
OpenAI.FileSearchTool
Strumento che cerca il contenuto pertinente dai file caricati.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| filters | oggetto | NO | ||
| max_num_risultati | numero intero | Il numero massimo di risultati da restituire. Questo numero deve essere compreso tra 1 e 50 (estremi inclusi). | NO | |
| opzioni_di_classifica | oggetto | NO | ||
| └* ranker | enum | Ranker da usare per la ricerca di file. Valori possibili: auto, default-2024-11-15 |
NO | |
| └─ soglia_punteggio | numero | Soglia del punteggio per la ricerca di file, un numero compreso tra 0 e 1. I numeri più vicini a 1 tenteranno di restituire solo i risultati più rilevanti, ma potrebbero restituire meno risultati. | NO | |
| type | enum | Tipo dello strumento di ricerca file. Sempre file_search.Valori possibili: file_search |
Sì | |
| vector_store_ids | array | ID degli archivi vettoriali da cercare. | Sì |
OpenAI.FileSearchToolCallItemParam
Risultati di una chiamata allo strumento di ricerca file. Per ulteriori informazioni, consulta la guida alla ricerca dei file .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| queries | array | Le interrogazioni usate per cercare i file. | Sì | |
| results | array | Risultati della chiamata allo strumento di ricerca file. | NO | |
| type | enum | Valori possibili: file_search_call |
Sì |
OpenAI.FileSearchToolCallItemResource
Risultati di una chiamata allo strumento di ricerca file. Per ulteriori informazioni, consulta la guida alla ricerca dei file .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| queries | array | Le interrogazioni usate per cercare i file. | Sì | |
| results | array | Risultati della chiamata allo strumento di ricerca file. | 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 | Valori possibili: file_search_call |
Sì |
OpenAI.Filters
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| filters | array | Matrice di filtri da combinare. Gli elementi possono essere ComparisonFilter o CompoundFilter. |
Sì | |
| chiave | corda | La chiave da confrontare rispetto al valore. | Sì | |
| type | enum | Tipo di operazione: and o or.Valori possibili: and, or |
Sì | |
| valore | stringa o numero o valore booleano | Valore da confrontare con la chiave dell'attributo; supporta tipi stringa, numero o boolean. | Sì |
OpenAI.FineTuneDPOHyperparameters
Iperparametri usati per il processo di ottimizzazione DPO.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| dimensione del batch | enum | Valori possibili: auto |
NO | |
| beta | enum | Valori possibili: auto |
NO | |
| moltiplicatore_tasso_apprendimento | enum | Valori possibili: auto |
NO | |
| numero di epoche | enum | Valori possibili: auto |
NO |
OpenAI.FineTuneDPOMethod
Configurazione per il metodo di ottimizzazione DPO.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| iperparametri | OpenAI.FineTuneDPOHyperparameters | Iperparametri usati per il processo di ottimizzazione DPO. | NO |
OpenAI.FineTuneMethod
Metodo utilizzato per l'ottimizzazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| DPO | OpenAI.FineTuneDPOMethod | Configurazione per il metodo di ottimizzazione 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, dpo o reinforcement.Valori possibili: supervised, dpo, reinforcement |
Sì |
OpenAI.FineTuneReinforcementHyperparameters
Iperparametri usati per il processo di ottimizzazione per rinforzo.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| dimensione del batch | enum | Valori possibili: auto |
NO | |
| compute_multiplier | enum | Valori possibili: auto |
NO | |
| eval_interval | enum | Valori possibili: auto |
NO | |
| eval_samples | enum | Valori possibili: auto |
NO | |
| moltiplicatore_tasso_apprendimento | enum | Valori possibili: auto |
NO | |
| numero di epoche | enum | Valori possibili: auto |
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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| cernitore | oggetto | Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. | Sì | |
| └' calculate_output | corda | Formula per calcolare l'output in base ai risultati del classificatore. | NO | |
| └' evaluation_metric | enum | Metrica di valutazione da usare. Uno tra cosine, fuzzy_match, bleu,gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5o rouge_l.Valori possibili: cosine, fuzzy_matchbleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l |
NO | |
| └️ voti | OpenAI.GraderStringCheck o OpenAI.GraderTextSimilarity o OpenAI.GraderPython o OpenAI.GraderScoreModel o OpenAI.GraderLabelModel | Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. | NO | |
| └' image_tag | corda | Tag immagine da usare per lo script Python. | NO | |
| └ Input | array | Testo di input. Ciò può includere stringhe di modello. | NO | |
| └─ Modello | corda | Modello da utilizzare per la valutazione. | NO | |
| └> nome | corda | Nome del grader. | NO | |
| └─ Operazione | enum | Operazione di controllo della stringa da eseguire. Uno tra eq, ne, like o ilike.Valori possibili: eq, ne, like, ilike |
NO | |
| └* intervallo | array | La gamma del punteggio. Il valore predefinito è [0, 1]. |
NO | |
| Riferimento | corda | Testo che viene valutato. | NO | |
| └sampling_params | OpenAI.EvalGraderScoreModelSamplingParams | Parametri di campionamento per il modello. | NO | |
| └─ sorgente | corda | Codice sorgente dello script Python. | NO | |
| └─ Tipo | enum | Il tipo di oggetto, che è sempre multi.Valori possibili: multi |
NO | |
| iperparametri | OpenAI.FineTuneReinforcementHyperparameters | Iperparametri usati per il processo di ottimizzazione per rinforzo. | NO |
OpenAI.FineTuneSupervisedHyperparameters
Iperparametri usati per il processo di ottimizzazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| dimensione del batch | enum | Valori possibili: auto |
NO | |
| moltiplicatore_tasso_apprendimento | enum | Valori possibili: auto |
NO | |
| numero di epoche | enum | Valori possibili: auto |
NO |
OpenAI.FineTuneSupervisedMethod
Configurazione per il metodo di ottimizzazione con supervisione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| iperparametri | OpenAI.FineTuneSupervisedHyperparameters | Iperparametri usati per il processo di ottimizzazione. | NO |
OpenAI.FineTuningIntegration
Discriminatore per OpenAI.FineTuningIntegration
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
wandb |
OpenAI.FineTuningIntegrationWandb |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | string (vedere modelli validi di seguito) | Sì |
OpenAI.FineTuningIntegrationWandb
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di integrazione da abilitare per il processo di ottimizzazione Valori possibili: wandb |
Sì | |
| wandb | oggetto | Impostazioni per l'integrazione con pesi e distorsioni. Questo payload specifica il progetto a cui verranno inviate le metriche. Facoltativamente, è possibile impostare un nome visualizzato esplicito per l'esecuzione, aggiungere tag per l'esecuzione e impostare un'entità predefinita (team, nome utente e così via) da associare all'esecuzione. |
Sì | |
| └─ Entità | corda | Entità da utilizzare per l'esecuzione. In questo modo è possibile impostare il team o il nome utente dell'utente Dibb che si desidera come associato all'esecuzione. Se non è impostato, viene usata l'entità predefinita per la chiave API JpgB registrata. |
NO | |
| └> nome | corda | Nome visualizzato da impostare per l'esecuzione. Se non è impostato, verrà usato l'ID processo come nome. | NO | |
| └─ Progetto | corda | Nome del progetto in cui verrà creata la nuova esecuzione. | NO | |
| └* tag | array | Elenco di tag da collegare all'esecuzione appena creata. Questi tag vengono passati direttamente a JpgB. Some I tag predefiniti vengono generati da OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}". |
NO |
OpenAI.FineTuningJob
L'oggetto fine_tuning.job rappresenta un processo di ottimizzazione che è stato creato tramite l'API.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | numero intero | Timestamp Unix (in secondi) per la creazione del processo di ottimizzazione. | Sì | |
| Errore | oggetto | Per i processi di ottimizzazione con failed, verranno fornite ulteriori informazioni sulla causa dell'errore. |
Sì | |
| └─ codice | corda | Codice di errore leggibile dal computer. | NO | |
| └* messaggio | corda | Messaggio di errore leggibile. | NO | |
| └* param | corda | Parametro non valido, in genere training_file o validation_file. Questo campo sarà Null se l'errore non fosse specifico del parametro. |
NO | |
| completamento stimato | numero intero | Timestamp Unix (in secondi) relativo alla previsione di completamento del processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione non è in esecuzione. | NO | |
| fine_tuned_model | corda | Nome del modello ottimizzato in fase di creazione. Il valore sarà Null se il processo di ottimizzazione è ancora in esecuzione. | Sì | |
| terminato_il | numero intero | Timestamp Unix (in secondi) per il completamento del processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione è ancora in esecuzione. | Sì | |
| iperparametri | oggetto | Iperparametri usati per il processo di ottimizzazione. Questo valore verrà restituito solo durante l'esecuzione di processi supervised. |
Sì | |
| └' batch_size | enum | Valori possibili: auto |
NO | |
| └' learning_rate_multiplier | enum | Valori possibili: auto |
NO | |
| └' n_epochs | enum | Valori possibili: auto |
NO | |
| id | corda | Identificatore dell'oggetto a cui è possibile fare riferimento negli endpoint dell'API. | Sì | |
| integrazioni | array | Elenco di integrazioni da abilitare per questo processo di ottimizzazione. | NO | |
| metadata | oggetto | 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ì | |
| method | OpenAI.FineTuneMethod | Metodo utilizzato per l'ottimizzazione. | NO | |
| model | corda | Modello di base ottimizzato. | Sì | |
| oggetto | enum | Tipo di oggetto, che è sempre "fine_tuning.job". Valori possibili: fine_tuning.job |
Sì | |
| organization_id | corda | L'organizzazione proprietaria del processo di ottimizzazione. | Sì | |
| file_di_risultato | array | ID file dei risultati compilati per il processo di ottimizzazione. È possibile recuperare i risultati con l'API File. | Sì | |
| seed | numero intero | Valore di inizializzazione utilizzato per il processo di ottimizzazione. | Sì | |
| stato | enum | Stato corrente del processo di ottimizzazione, che può essere validating_files, queued, running, succeeded, failedo cancelled.Valori possibili: validating_files, queuedrunning, succeeded, , failedcancelled |
Sì | |
| trained_tokens | numero intero | Numero totale di token fatturabili elaborati da questo processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione è ancora in esecuzione. | Sì | |
| file di allenamento | corda | ID file utilizzato per il training. È possibile recuperare i dati di training con l'API File. | Sì | |
| user_provided_suffix | corda | Suffisso descrittivo applicato al processo, come specificato nella richiesta di creazione del processo. | NO | |
| file_di_validazione | corda | ID file utilizzato per la convalida. È possibile recuperare i risultati della convalida con l'API File. | Sì |
OpenAI.FineTuningJobCheckpoint
L'oggetto fine_tuning.job.checkpoint rappresenta un checkpoint del modello per un processo di ottimizzazione pronto per l'uso.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | numero intero | Timestamp UNIX (in secondi) relativo al momento in cui è stato creato il checkpoint. | Sì | |
| punto_di_controllo_modello_ottimizzato | corda | Nome del modello di checkpoint ottimizzato che viene creato. | Sì | |
| id_lavoro_affinamento | corda | Nome del processo di ottimizzazione da cui è stato creato il checkpoint. | Sì | |
| id | corda | Identificatore del checkpoint, a cui è possibile fare riferimento negli endpoint dell'API. | Sì | |
| metrics | oggetto | Metriche al numero di passaggio durante il processo di ottimizzazione. | Sì | |
| └' full_valid_loss | numero | NO | ||
| └' full_valid_mean_token_accuracy | numero | NO | ||
| └* passaggio | numero | NO | ||
| └' train_loss | numero | NO | ||
| └' train_mean_token_accuracy | numero | NO | ||
| └' valid_loss | numero | NO | ||
| └' valid_mean_token_accuracy | numero | NO | ||
| oggetto | enum | Tipo di oggetto, che è sempre "fine_tuning.job.checkpoint". Valori possibili: fine_tuning.job.checkpoint |
Sì | |
| numero_passaggio | numero intero | Numero del passaggio in cui è stato creato il checkpoint. | Sì |
OpenAI.FineTuningJobEvent
Oggetto evento processo di ottimizzazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_il | numero intero | Timestamp Unix (in secondi) per la creazione del processo di ottimizzazione. | Sì | |
| data | Dati associati all'evento. | NO | ||
| id | corda | Identificatore dell'oggetto. | Sì | |
| livello | enum | Livello di log dell'evento. Valori possibili: info, warn, error |
Sì | |
| message | corda | Messaggio dell'evento. | Sì | |
| oggetto | 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.FunctionObject
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. | NO | |
| nome | corda | Nome della funzione che deve essere chiamata. Deve essere a-z, A-Z, 0-9 o contenere caratteri di sottolineatura e trattini, con una lunghezza massima di 64 caratteri. | Sì | |
| parameters | I parametri accettati dalle funzioni, descritti come oggetto Schema JSON. Consultare la guida per trovare esempi e le informazioni di riferimento sullo schema JSON per la documentazione sul formato. L'omissione di parameters definisce una funzione con un elenco di parametri vuoto. |
NO | ||
| rigido | boolean | Indica se abilitare una rigorosa conformità allo schema durante la generazione della chiamata di funzione. Se impostato su true, il modello seguirà lo schema esatto definito nel campo parameters. Solo un subset di schema JSON è supportato quando strict è true. Altre informazioni sugli output strutturati in |
NO | Falso |
OpenAI.FunctionTool
Definisce una funzione nel tuo codice che il modello può chiamare.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione della funzione. Utilizzato dal modello per determinare se chiamare o meno la funzione. | NO | |
| nome | corda | Nome della funzione da chiamare. | Sì | |
| parameters | Oggetto schema JSON che descrive i parametri della funzione. | Sì | ||
| rigido | boolean | Indica se applicare la convalida rigorosa dei parametri. Valore predefinito true. |
Sì | |
| type | enum | Tipo di strumento funzionale. Sempre function.Valori possibili: function |
Sì |
OpenAI.FunctionToolCallItemParam
Chiamata di uno strumento per eseguire una funzione. Per altre informazioni, vedere la guida alla chiamata di funzione .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Stringa JSON degli argomenti da passare alla funzione. | Sì | |
| call_id | corda | ID univoco della chiamata dello strumento di funzione generata dal modello. | Sì | |
| nome | corda | Nome della funzione da eseguire. | Sì | |
| type | enum | Valori possibili: function_call |
Sì |
OpenAI.FunctionToolCallItemResource
Chiamata di uno strumento per eseguire una funzione. Per altre informazioni, vedere la guida alla chiamata di funzione .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Stringa JSON degli argomenti da passare alla funzione. | Sì | |
| call_id | corda | ID univoco della chiamata dello strumento di funzione generata dal modello. | Sì | |
| nome | corda | Nome della funzione da eseguire. | Sì | |
| stato | enum | Stato dell'elemento. Uno di in_progress, completed, oincomplete. Popolato quando gli elementi vengono restituiti tramite l'API.Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Valori possibili: function_call |
Sì |
OpenAI.FunctionToolCallOutputItemParam
Output di una chiamata dello strumento di funzione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| call_id | corda | ID univoco della chiamata dello strumento di funzione generata dal modello. | Sì | |
| output | corda | Stringa JSON dell'output della chiamata dello strumento di funzione. | Sì | |
| type | enum | Valori possibili: function_call_output |
Sì |
OpenAI.FunctionToolCallOutputItemResource
Output di una chiamata dello strumento di funzione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| call_id | corda | ID univoco della chiamata dello strumento di funzione generata dal modello. | Sì | |
| output | corda | Stringa JSON dell'output della chiamata dello strumento di funzione. | Sì | |
| stato | enum | Stato dell'elemento. Uno di in_progress, completed, oincomplete. Popolato quando gli elementi vengono restituiti tramite l'API.Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Valori possibili: function_call_output |
Sì |
OpenAI.GraderLabelModel
Oggetto LabelModelGrader che usa un modello per assegnare etichette a ogni elemento della valutazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ingresso | array | Sì | ||
| labels | array | Etichette da assegnare a ogni elemento della valutazione. | Sì | |
| model | corda | Modello da utilizzare per la valutazione. Deve supportare output strutturati. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| etichette_di_passaggio | array | Le etichette che indicano un risultato positivo. Deve essere un sottoinsieme di etichette. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: label_model |
Sì |
OpenAI.GraderMulti
Un oggetto multivalutatori combina l'output di più grader per produrre un singolo punteggio.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| calculate_output | corda | Formula per calcolare l'output in base ai risultati del classificatore. | Sì | |
| valutatori | oggetto | Oggetto StringCheckGrader che esegue un confronto di stringhe tra input e riferimento usando un'operazione specificata. | Sì | |
| └' evaluation_metric | enum | Metrica di valutazione da usare. Uno tra cosine, fuzzy_match, bleu,gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5o rouge_l.Valori possibili: cosine, fuzzy_matchbleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l |
NO | |
| └' image_tag | corda | Tag immagine da usare per lo script Python. | NO | |
| └ Input | array | NO | ||
| └* etichette | array | Etichette da assegnare a ogni elemento della valutazione. | NO | |
| └─ Modello | corda | Modello da utilizzare per la valutazione. Deve supportare output strutturati. | NO | |
| └> nome | corda | Nome del grader. | NO | |
| └─ Operazione | enum | Operazione di controllo della stringa da eseguire. Uno tra eq, ne, like o ilike.Valori possibili: eq, ne, like, ilike |
NO | |
| └passing_labels | array | Le etichette che indicano un risultato positivo. Deve essere un sottoinsieme di etichette. | NO | |
| └* intervallo | array | La gamma del punteggio. Il valore predefinito è [0, 1]. |
NO | |
| Riferimento | corda | Testo che viene valutato. | NO | |
| └sampling_params | OpenAI.EvalGraderScoreModelSamplingParams | Parametri di campionamento per il modello. | NO | |
| └─ sorgente | corda | Codice sorgente dello script Python. | NO | |
| └─ Tipo | enum | Il tipo di oggetto, che è sempre label_model.Valori possibili: label_model |
NO | |
| nome | corda | Nome del grader. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre multi.Valori possibili: multi |
Sì |
OpenAI.GraderPython
Oggetto PythonGrader che esegue uno script Python nell'input.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| image_tag | corda | Tag immagine da usare per lo script Python. | NO | |
| nome | corda | Nome del grader. | Sì | |
| source | corda | Codice sorgente dello script Python. | Sì | |
| type | enum | Il tipo di oggetto, che è sempre python.Valori possibili: python |
Sì |
OpenAI.GraderScoreModel
Oggetto ScoreModelGrader che usa un modello per assegnare un punteggio all'input.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ingresso | array | Testo di input. Ciò può includere stringhe di modello. | Sì | |
| model | corda | Modello da utilizzare per la valutazione. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| intervallo | array | La gamma del punteggio. Il valore predefinito è [0, 1]. |
NO | |
| sampling_params | oggetto | NO | ||
| └max_completions_tokens | OpenAI.integer | NO | ||
| └• reasoning_effort | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| └* seed | OpenAI.integer | NO | ||
| └* temperatura | OpenAI.numeric | NO | ||
| └top_p | OpenAI.numeric | NO | ||
| type | enum | Il 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ingresso | corda | Testo di input. Ciò può includere stringhe di modello. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| operazione | enum | Operazione di controllo della stringa da eseguire. Uno tra eq, ne, like o ilike.Valori possibili: eq, ne, like, ilike |
Sì | |
| riferimento | corda | Testo di riferimento. Ciò può includere stringhe di modello. | Sì | |
| type | enum | Il 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| metrica di valutazione | enum | Metrica di valutazione da usare. Uno tra cosine, fuzzy_match, bleu,gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5o rouge_l.Valori possibili: cosine, fuzzy_matchbleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5rouge_l |
Sì | |
| ingresso | corda | Il testo in valutazione. | Sì | |
| nome | corda | Nome del grader. | Sì | |
| riferimento | corda | Testo che viene valutato. | Sì | |
| type | enum | Tipo di grader. Valori possibili: text_similarity |
Sì |
OpenAI.ImageGenTool
Strumento che genera immagini usando un modello come gpt-image-1.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| sfondo | enum | Tipo di sfondo per l'immagine generata. Uno di transparent,opaque, o auto. Impostazione predefinita: auto.Valori possibili: transparent, opaque, auto |
NO | |
| input_image_mask | oggetto | Maschera opzionale per ritocco immagine. Contiene image_url(stringa, facoltativa) e file_id (stringa, facoltativa). |
NO | |
| └ file_id | corda | ID del file per l'immagine della maschera. | NO | |
| └ image_url | corda | Immagine maschera con codifica Base64. | NO | |
| model | enum | Modello di generazione di immagini da usare. Impostazione predefinita: gpt-image-1.Valori possibili: gpt-image-1 |
NO | |
| moderation | enum | Livello di moderazione per l'immagine generata. Impostazione predefinita: auto.Valori possibili: auto, low |
NO | |
| Compressione dell'output | numero intero | Livello di compressione per l'immagine di output. Predefinito: 100. | NO | 100 |
| formato_di_output | enum | Formato di output dell'immagine generata. Uno di png, webp, ojpeg. Impostazione predefinita: png.Valori possibili: png, webp, jpeg |
NO | |
| immagini parziali | numero intero | Numero di immagini parziali da generare in modalità di streaming, da 0 (valore predefinito) a 3. | NO | 0 |
| qualità | enum | Qualità dell'immagine generata. Uno tra 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.ImageGenToolCallItemParam
Richiesta di generazione di immagini effettuata dal modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| risultato | corda | Immagine generata codificata in base64. | Sì | |
| type | enum | Valori possibili: image_generation_call |
Sì |
OpenAI.ImageGenToolCallItemResource
Richiesta di generazione di immagini effettuata dal modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| risultato | corda | Immagine generata codificata in base64. | Sì | |
| stato | enum | Valori possibili: in_progress, completed, generating, failed |
Sì | |
| type | enum | Valori possibili: image_generation_call |
Sì |
OpenAI.Includable
Specificare dati di output aggiuntivi da includere nella risposta del modello. I valori attualmente supportati sono:
-
code_interpreter_call.outputs: include gli output dell'esecuzione di codice Python negli elementi di chiamata dello strumento dell'interprete di codice. -
computer_call_output.output.image_url: includere gli URL delle immagini provenienti dall'output della chiamata computer. -
file_search_call.results: includere i risultati della ricerca della chiamata allo strumento di ricerca file. -
message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input. -
message.output_text.logprobs: includere logprob 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 ilstoreparametro è impostato sufalseo 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. Attualmente i valori supportati sono: - code_interpreter_call.outputs: include gli output dell'esecuzione del codice Pythonnegli elementi di chiamata dello strumento dell'interprete di codice. - computer_call_output.output.image_url: includere gli URL delle immagini provenienti dall'output della chiamata computer.- file_search_call.results: includere i risultati della ricerca dirichiesta allo strumento di ricerca dei file. - message.input_image.image_url: includere gli URL dell'immagine dal messaggio di input.- message.output_text.logprobs: includere logprob con messaggi di assistente.- reasoning.encrypted_content: include una versione crittografata del motivotoken nell'output dell'elemento di ragionamento. In questo modo è possibile utilizzare gli elementi di ragionamento in conversazioni a più turni quando si usa l'API Risposte senza stato (ad esempio quando il store parametro è impostato su false o quando un'organizzazione èregistrato nel programma a conservazione dati nulla. |
| Tipo | corda |
| Valori | code_interpreter_call.outputscomputer_call_output.output.image_urlfile_search_call.resultsmessage.input_image.image_urlmessage.output_text.logprobsreasoning.encrypted_contentweb_search_call.resultsweb_search_call.action.sourcesmemory_search_call.results |
OpenAI.ItemContent
Discriminare per OpenAI.ItemContent
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
input_audio |
OpenAI.ItemContentInputAudio |
output_audio |
OpenAI.ItemContentOutputAudio |
refusal |
OpenAI.ItemContentRefusal |
input_text |
OpenAI.ItemContentInputText |
input_image |
OpenAI.ItemContentInputImage |
input_file |
OpenAI.ItemContentInputFile |
output_text |
OpenAI.ItemContentOutputText |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ItemContentType | Contenuti di input e output multimodali. | Sì |
OpenAI.ItemContentInputAudio
Input audio per il modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data | corda | Dati audio con codifica Base64. | Sì | |
| format | enum | Formato dei dati audio. I formati attualmente supportati sono mp3 ewav.Valori possibili: mp3, wav |
Sì | |
| type | enum | Tipo dell'elemento di input. Sempre input_audio.Valori possibili: input_audio |
Sì |
OpenAI.ItemContentInputFile
Un file di input per il modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| file_data | corda | Contenuto del file da inviare al modello. | NO | |
| ID del file | corda | ID del file da inviare al modello. | NO | |
| filename | corda | Nome del file da inviare al modello. | NO | |
| type | enum | Tipo dell'elemento di input. Sempre input_file.Valori possibili: input_file |
Sì |
OpenAI.ItemContentInputImage
Un'immagine come input per il modello. Scopri di più sugli input delle immagini.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| detail | enum | Livello di dettaglio dell'immagine da inviare al modello. Uno tra high, low e auto. Il valore predefinito è auto.Valori possibili: low, high, auto |
NO | |
| ID del file | corda | ID del file da inviare al modello. | NO | |
| image_url | corda | URL dell'immagine da inviare al modello. URL completo o immagine con codifica Base64 in un URL dati. | NO | |
| type | enum | Tipo dell'elemento di input. Sempre input_image.Valori possibili: input_image |
Sì |
OpenAI.ItemContentInputText
Input di testo per il modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Testo | corda | Input di testo per il modello. | Sì | |
| type | enum | Tipo dell'elemento di input. Sempre input_text.Valori possibili: input_text |
Sì |
OpenAI.ItemContentOutputAudio
Un'uscita audio dal modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data | corda | Dati audio con codifica Base64 dal modello. | Sì | |
| transcript | corda | Trascrizione dei dati audio del modello. | Sì | |
| type | enum | Tipo di output audio. Sempre output_audio.Valori possibili: output_audio |
Sì |
OpenAI.ItemContentOutputText
Output di testo del modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| annotazioni | array | Annotazioni dell'output di testo. | Sì | |
| logprobs | array | NO | ||
| Testo | corda | L'output di testo generato dal modello. | Sì | |
| type | enum | Tipo del testo di uscita. Sempre output_text.Valori possibili: output_text |
Sì |
OpenAI.ItemContentRefusal
Rifiuto da parte del modello.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| refusal | corda | Spiegazione del rifiuto dal modello. | Sì | |
| type | enum | Tipo di rifiuto. Sempre refusal.Valori possibili: refusal |
Sì |
OpenAI.ItemContentType
Contenuti di input e output multimodali.
| Proprietà | Value |
|---|---|
| Descrizione | Contenuti di input e output multimodali. |
| Tipo | corda |
| Valori | input_textinput_audioinput_imageinput_fileoutput_textoutput_audiorefusal |
OpenAI.ItemParam
Elemento di contenuto usato per generare una risposta.
Discriminare per OpenAI.ItemParam
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
message |
OpenAI.ResponsesMessageItemParam |
function_call_output |
OpenAI.FunctionToolCallOutputItemParam |
file_search_call |
OpenAI.FileSearchToolCallItemParam |
computer_call |
OpenAI.ComputerToolCallItemParam |
computer_call_output |
OpenAI.ComputerToolCallOutputItemParam |
web_search_call |
OpenAI.WebSearchToolCallItemParam |
function_call |
OpenAI.FunctionToolCallItemParam |
reasoning |
OpenAI.ReasoningItemParam |
item_reference |
OpenAI.ItemReferenceItemParam |
image_generation_call |
OpenAI.ImageGenToolCallItemParam |
code_interpreter_call |
OpenAI.CodeInterpreterToolCallItemParam |
local_shell_call |
OpenAI.LocalShellToolCallItemParam |
local_shell_call_output |
OpenAI.LocalShellToolCallOutputItemParam |
mcp_list_tools |
OpenAI.MCPListToolsItemParam |
mcp_approval_request |
OpenAI.MCPApprovalRequestItemParam |
mcp_approval_response |
OpenAI.MCPApprovalResponseItemParam |
mcp_call |
OpenAI.MCPCallItemParam |
memory_search_call |
MemorySearchToolCallItemParam |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ItemType | Sì |
OpenAI.ItemReferenceItemParam
Identificatore interno di un elemento a cui fare riferimento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | L'ID generato dal servizio relativo all'elemento di risposta precedentemente creato a cui si fa riferimento. | Sì | |
| type | enum | 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:
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| creato_da | oggetto | NO | ||
| └* agente | AgentId | Agente che ha creato l'elemento. | NO | |
| └response_id | corda | Risposta in base alla quale viene creato l'elemento. | NO | |
| id | corda | Sì | ||
| type | OpenAI.ItemType | Sì |
OpenAI.ItemType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | messagefile_search_callfunction_callfunction_call_outputcomputer_callcomputer_call_outputweb_search_callreasoningitem_referenceimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callstructured_outputsworkflow_actionmemory_search_calloauth_consent_request |
OpenAI.ListFineTuningJobCheckpointsResponse
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data | array | Sì | ||
| first_id | corda | NO | ||
| ha_di_piu | boolean | Sì | ||
| last_id | corda | NO | ||
| oggetto | enum | Valori possibili: list |
Sì |
OpenAI.ListFineTuningJobEventsResponse
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data | array | Sì | ||
| ha_di_piu | boolean | Sì | ||
| oggetto | enum | Valori possibili: list |
Sì |
OpenAI.ListPaginatedFineTuningJobsResponse
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| data | array | Sì | ||
| ha_di_piu | boolean | Sì | ||
| oggetto | enum | Valori possibili: list |
Sì |
OpenAI.LocalShellExecAction
Eseguire un comando della shell nel server.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| command | array | Il comando da eseguire. | Sì | |
| Env | oggetto | Variabili di ambiente da impostare per il comando. | Sì | |
| timeout_ms | numero intero | Timeout facoltativo in millisecondi per il comando. | NO | |
| type | enum | Tipo dell'azione della shell locale. Sempre exec.Valori possibili: exec |
Sì | |
| utente | corda | Utente facoltativo con cui eseguire il comando. | NO | |
| working_directory | corda | Directory di lavoro facoltativa in cui eseguire il comando. | NO |
OpenAI.LocalShellTool
Strumento che consente al modello di eseguire comandi della shell in un ambiente locale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo dello strumento shell locale. Sempre local_shell.Valori possibili: local_shell |
Sì |
OpenAI.LocalShellToolCallItemParam
Chiamata allo strumento per eseguire un comando nella shell locale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | OpenAI.LocalShellExecAction | Eseguire un comando della shell nel server. | Sì | |
| call_id | corda | ID univoco della chiamata allo strumento shell locale generata dal modello. | Sì | |
| type | enum | Valori possibili: local_shell_call |
Sì |
OpenAI.LocalShellToolCallItemResource
Chiamata allo strumento per eseguire un comando nella shell locale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | OpenAI.LocalShellExecAction | Eseguire un comando della shell nel server. | Sì | |
| call_id | corda | ID univoco della chiamata allo strumento shell locale generata dal modello. | Sì | |
| stato | enum | Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Valori possibili: local_shell_call |
Sì |
OpenAI.LocalShellToolCallOutputItemParam
Output di una chiamata allo strumento shell locale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| output | corda | Stringa JSON dell'output della chiamata allo strumento shell locale. | Sì | |
| type | enum | Valori possibili: local_shell_call_output |
Sì |
OpenAI.LocalShellToolCallOutputItemResource
Output di una chiamata allo strumento shell locale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| output | corda | Stringa JSON dell'output della chiamata allo strumento shell locale. | Sì | |
| stato | enum | Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Valori possibili: local_shell_call_output |
Sì |
OpenAI.Location
Discriminare per OpenAI.Location
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
approximate |
OpenAI.ApproximateLocation |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.LocationType | Sì |
OpenAI.LocationType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | approximate |
OpenAI.LogProb
Probabilità di log di un token.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| bytes | array | Sì | ||
| logprob | numero | Sì | ||
| token | corda | Sì | ||
| top_logprobs | array | Sì |
OpenAI.MCPApprovalRequestItemParam
Richiesta di approvazione umana di una chiamata a uno strumento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Stringa JSON di argomenti per lo strumento. | Sì | |
| nome | corda | Nome dello strumento da eseguire. | Sì | |
| etichetta del server | corda | Etichetta del server MCP che effettua la richiesta. | Sì | |
| type | enum | Valori possibili: mcp_approval_request |
Sì |
OpenAI.MCPApprovalRequestItemResource
Richiesta di approvazione umana di una chiamata a uno strumento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Stringa JSON di argomenti per lo strumento. | Sì | |
| nome | corda | Nome dello strumento da eseguire. | Sì | |
| etichetta del server | corda | Etichetta del server MCP che effettua la richiesta. | Sì | |
| type | enum | Valori possibili: mcp_approval_request |
Sì |
OpenAI.MCPApprovalResponseItemParam
Risposta a una richiesta di approvazione MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| approval_request_id | corda | ID della richiesta di approvazione a cui si sta rispondendo. | Sì | |
| approve | boolean | Indica se la richiesta è stata approvata. | Sì | |
| reason | corda | Motivo facoltativo della decisione. | NO | |
| type | enum | Valori possibili: mcp_approval_response |
Sì |
OpenAI.MCPApprovalResponseItemResource
Risposta a una richiesta di approvazione MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| approval_request_id | corda | ID della richiesta di approvazione a cui si sta rispondendo. | Sì | |
| approve | boolean | Indica se la richiesta è stata approvata. | Sì | |
| reason | corda | Motivo facoltativo della decisione. | NO | |
| type | enum | Valori possibili: mcp_approval_response |
Sì |
OpenAI.MCPCallItemParam
Chiamata di uno strumento in un server MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Stringa JSON degli argomenti passati allo strumento. | Sì | |
| Errore | corda | Errore della chiamata allo strumento, se presente. | NO | |
| nome | corda | Nome dello strumento eseguito. | Sì | |
| output | corda | Risultato della chiamata allo strumento. | NO | |
| etichetta del server | corda | Etichetta del server MCP che esegue lo strumento. | Sì | |
| type | enum | Valori possibili: mcp_call |
Sì |
OpenAI.MCPCallItemResource
Chiamata di uno strumento in un server MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Stringa JSON degli argomenti passati allo strumento. | Sì | |
| Errore | corda | Errore della chiamata allo strumento, se presente. | NO | |
| nome | corda | Nome dello strumento eseguito. | Sì | |
| output | corda | Risultato della chiamata allo strumento. | NO | |
| etichetta del server | corda | Etichetta del server MCP che esegue lo strumento. | Sì | |
| type | enum | Valori possibili: mcp_call |
Sì |
OpenAI.MCPListToolsItemParam
Elenco di strumenti disponibili in un server MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | corda | Messaggio di errore se il server non è riuscito ad elencare gli strumenti. | NO | |
| etichetta del server | corda | Etichetta del server MCP. | Sì | |
| strumenti | array | Strumenti disponibili nel server. | Sì | |
| type | enum | Valori possibili: mcp_list_tools |
Sì |
OpenAI.MCPListToolsItemResource
Elenco di strumenti disponibili in un server MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | corda | Messaggio di errore se il server non è riuscito ad elencare gli strumenti. | NO | |
| etichetta del server | corda | Etichetta del server MCP. | Sì | |
| strumenti | array | Strumenti disponibili nel server. | Sì | |
| type | enum | Valori possibili: mcp_list_tools |
Sì |
OpenAI.MCPListToolsTool
Strumento disponibile in un server MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| annotazioni | Annotazioni aggiuntive sullo strumento. | NO | ||
| descrizione | corda | Descrizione dello strumento. | NO | |
| input_schema | Schema JSON che descrive l'input dello strumento. | Sì | ||
| nome | corda | Nome dello strumento. | Sì |
OpenAI.MCPTool
Concedere al modello l'accesso a strumenti aggiuntivi tramite server MCP (Model Context Protocol) remoti. Scopri di più su MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| strumenti consentiti | oggetto | NO | ||
| └tool_names | array | Elenco dei nomi degli strumenti consentiti. | NO | |
| headers | oggetto | Intestazioni HTTP facoltative da inviare al server MCP. Usare per l'autenticazione o altri scopi. |
NO | |
| project_connection_id | corda | L'ID di connessione nel progetto 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) | Specificare quale degli strumenti del server MCP richiede l'approvazione. | NO | |
| etichetta del server | corda | Etichetta per questo server MCP, usata per identificarla nelle chiamate degli strumenti. | Sì | |
| URL del server | corda | URL del server MCP. | Sì | |
| type | enum | Tipo dello strumento MCP. Sempre mcp.Valori possibili: mcp |
Sì |
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.Prompt
Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| id | corda | Identificatore univoco del modello di richiesta da utilizzare. | Sì | |
| variabili | oggetto | 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 | corda | Versione facoltativa del modello di richiesta. | NO |
OpenAI.OpzioniDiClassifica
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| classificatore | enum | Ranker da usare per la ricerca di file. Valori possibili: auto, default-2024-11-15 |
NO | |
| soglia_punteggio | numero | Soglia del punteggio per la ricerca di file, un numero compreso tra 0 e 1. I numeri più vicini a 1 tenteranno di restituire solo i risultati più rilevanti, ma potrebbero restituire meno risultati. | NO |
OpenAI.Reasoning
Solo modelli di serie o
Opzioni di configurazione per i modelli di ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| effort | oggetto | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| generate_summary | enum |
Deprecato: utilizzare summary al suo posto. Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| summary | enum | Riepilogo del ragionamento eseguito dal modello. Può trattarsi di utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO |
OpenAI.SforzoDiRagionamento
Vincola il lavoro sul ragionamento per i modelli di ragionamento.
I valori attualmente supportati sono none, minimal, low, medium e high.
La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta.
gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1.
Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno.
Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento.
| Proprietà | Value |
|---|---|
| Descrizione | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
| Tipo | corda |
| Valori | noneminimallowmediumhigh |
OpenAI.ReasoningItemParam
Descrizione della catena di pensiero usata da un modello di ragionamento durante la generazione di una risposta. Assicurati di includere questi elementi nell'API input Risposte per i turni successivi di una conversazione se gestisci manualmente lo stato della conversazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| encrypted_content | corda | Contenuto crittografato dell'elemento di ragionamento, popolato quando una risposta è inviata generato con reasoning.encrypted_content nel include parametro . |
NO | |
| summary | array | Contenuti del testo di ragionamento. | Sì | |
| type | enum | Valori possibili: reasoning |
Sì |
OpenAI.ReasoningItemResource
Descrizione della catena di pensiero usata da un modello di ragionamento durante la generazione di una risposta. Assicurati di includere questi elementi nell'API input Risposte per i turni successivi di una conversazione se gestisci manualmente lo stato della conversazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| encrypted_content | corda | Contenuto crittografato dell'elemento di ragionamento, popolato quando una risposta è inviata generato con reasoning.encrypted_content nel include parametro . |
NO | |
| summary | array | Contenuti del testo di ragionamento. | Sì | |
| type | enum | Valori possibili: reasoning |
Sì |
OpenAI.ReasoningItemSummaryPart
Discriminante per OpenAI.ReasoningItemSummaryPart
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
summary_text |
OpenAI.ReasoningItemSummaryTextPart |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ReasoningItemSummaryPartType | Sì |
OpenAI.ReasoningItemSummaryPartType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | summary_text |
OpenAI.ReasoningItemSummaryTextPart
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Testo | corda | Sì | ||
| type | enum | Valori possibili: summary_text |
Sì |
OpenAI.Response
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| agent | oggetto | NO | ||
| └> nome | corda | Nome dell'agente. | NO | |
| └─ Tipo | enum | Valori possibili: agent_id |
NO | |
| └─ versione | corda | Identificatore della versione dell'agente. | NO | |
| sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| conversazione | oggetto | Sì | ||
| └* id | corda | NO | ||
| creato_il | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | Sì | |
| Errore | oggetto | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | Sì | |
| └─ codice | OpenAI.ResponseErrorCode | Codice di errore per la risposta. | NO | |
| └* messaggio | corda | Descrizione leggibile dell'errore. | NO | |
| id | corda | Identificatore univoco per questa risposta. | Sì | |
| incomplete_details | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | Sì | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| instructions | stringa o matrice | Sì | ||
| max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| metadata | oggetto | 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 | corda | 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ì | |
| output | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
Sì | |
| output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| chiamate_parallele_agli_strumenti | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | Sì | Vero |
| previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| prompt | oggetto | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* id | corda | Identificatore univoco del modello di richiesta da utilizzare. | NO | |
| ** └─ Variabili | OpenAI.ResponsePromptVariables | 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 | |
| └─ versione | corda | Versione facoltativa del modello di richiesta. | NO | |
| reasoning | oggetto |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └* sforzo | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| └─ genera_sommario | enum |
Deprecato: utilizzare summary al suo posto. Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| └─ Riepilogo | enum | Riepilogo del ragionamento eseguito dal modello. Può trattarsi di utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| livello_servizio | oggetto | Specifica il tipo di elaborazione utilizzato per gestire la richiesta. * Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurata nelle impostazioni del progetto. Se non diversamente configurato, il progetto userà 'default'. * Se impostato su "default", la richiesta verrà elaborata con lo standard prezzi e prestazioni per il modello selezionato. * Se impostato su 'flex' o "priorità", la richiesta verrà elaborata con il servizio corrispondente livello. Per altre informazioni sull'elaborazione priorità, contattare le vendite. * Quando non è impostato, il comportamento predefinito è 'auto'. Quando il service_tier parametro è impostato, il corpo della risposta includerà service_tiervalore basato sulla modalità di elaborazione effettivamente utilizzata per gestire la richiesta. Questo valore della 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 | |
| structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
Sì | |
| Testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| tool_choice | oggetto | Controlla quale strumento (se presente) viene chiamato dal modello.none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno opiù strumenti required indica che il modello deve chiamare uno o più strumenti. |
NO | |
| └─ Tipo | OpenAI.ToolChoiceObjectType | Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti. |
NO | |
| strumenti | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
Sì | |
| truncation | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. Valori possibili: auto, disabled |
NO | |
| usage | 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | Sì |
OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
Generato quando un frammento di codice parziale viene trasmesso dall'interprete del codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| delta | corda | Frammento di codice parziale trasmesso dall'interprete di codice. | Sì | |
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete di codice. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella risposta per cui viene trasmesso il codice. | 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 del codice.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Output finale del frammento di codice generato dall'interprete di codice. | Sì | |
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete di codice. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella risposta per cui viene finalizzato il codice. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete di codice. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella risposta per cui viene completata la chiamata all'interprete di codice. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete di codice. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella risposta per cui è in corso la chiamata dell'interprete di codice. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento dell'interprete di codice. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella risposta per cui l'interprete di codice interpreta il codice. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| response | oggetto | Sì | ||
| └* agente | AgentId | Agente usato per questa risposta | NO | |
| └* sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| └* conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| └created_at | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | NO | |
| └─ Errore | OpenAI.ResponseError | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | NO | |
| └* id | corda | Identificatore univoco per questa risposta. | NO | |
| └dettagli_incompleti | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | NO | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| └* istruzioni | stringa o matrice | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| └ max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| └' max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| └─ metadati | oggetto | 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 | corda | 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 |
NO | |
| └─ uscita | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
NO | |
| └output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| └parallel_tool_calls | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| └─previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| └* prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* ragionamento | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └service_tier | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | 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 | |
| └structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | |
| └─ testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| └tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| Strumenti └* | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| └ top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | |
| └─ troncamento | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO | |
| type | enum | Tipo di evento. Sempre response.completed.Valori possibili: response.completed |
Sì |
OpenAI.ResponseContentPartAddedEvent
Generato quando viene aggiunta una nuova parte di contenuto.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte di contenuto aggiunta. | Sì | |
| item_id | corda | ID dell'elemento di output a cui è stata aggiunta la parte di contenuto. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui è stata aggiunta la parte di contenuto. | Sì | |
| part | oggetto | Sì | ||
| └─ Tipo | OpenAI.ItemContentType | Contenuti di input e output multimodali. | NO | |
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte di contenuto eseguita. | Sì | |
| item_id | corda | ID dell'elemento di output a cui è stata aggiunta la parte di contenuto. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui è stata aggiunta la parte di contenuto. | Sì | |
| part | oggetto | Sì | ||
| └─ Tipo | OpenAI.ItemContentType | Contenuti di input e output multimodali. | NO | |
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| response | oggetto | Sì | ||
| └* agente | AgentId | Agente usato per questa risposta | NO | |
| └* sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| └* conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| └created_at | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | NO | |
| └─ Errore | OpenAI.ResponseError | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | NO | |
| └* id | corda | Identificatore univoco per questa risposta. | NO | |
| └dettagli_incompleti | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | NO | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| └* istruzioni | stringa o matrice | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| └ max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| └' max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| └─ metadati | oggetto | 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 | corda | 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 |
NO | |
| └─ uscita | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
NO | |
| └output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| └parallel_tool_calls | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| └─previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| └* prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* ragionamento | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └service_tier | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | 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 | |
| └structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | |
| └─ testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| └tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| Strumenti └* | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| └ top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | |
| └─ troncamento | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO | |
| type | enum | Tipo di evento. Sempre response.created.Valori possibili: response.created |
Sì |
OpenAI.ResponseError
Oggetto di errore restituito quando il modello non riesce a generare una risposta.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | OpenAI.ResponseErrorCode | Codice di errore per la risposta. | Sì | |
| message | corda | Descrizione leggibile dell'errore. | Sì |
OpenAI.ResponseErrorCode
Codice di errore per la risposta.
| Proprietà | Value |
|---|---|
| Descrizione | Codice di errore per la risposta. |
| Tipo | corda |
| Valori | server_errorrate_limit_exceededinvalid_promptvector_store_timeoutinvalid_imageinvalid_image_formatinvalid_base64_imageinvalid_image_urlimage_too_largeimage_too_smallimage_parse_errorimage_content_policy_violationinvalid_image_modeimage_file_too_largeunsupported_image_media_typeempty_image_filefailed_to_download_imageimage_file_not_found |
OpenAI.ResponseErrorEvent
Generato quando si verifica un errore.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| codice | corda | Codice di errore. | Sì | |
| message | corda | Messaggio di errore. | Sì | |
| param | corda | Parametro di errore. | Sì | |
| type | enum | Tipo di evento. Sempre error.Valori possibili: error |
Sì |
OpenAI.ResponseFailedEvent
Evento generato quando una risposta ha esito negativo.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| response | oggetto | Sì | ||
| └* agente | AgentId | Agente usato per questa risposta | NO | |
| └* sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| └* conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| └created_at | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | NO | |
| └─ Errore | OpenAI.ResponseError | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | NO | |
| └* id | corda | Identificatore univoco per questa risposta. | NO | |
| └dettagli_incompleti | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | NO | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| └* istruzioni | stringa o matrice | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| └ max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| └' max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| └─ metadati | oggetto | 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 | corda | 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 |
NO | |
| └─ uscita | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
NO | |
| └output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| └parallel_tool_calls | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| └─previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| └* prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* ragionamento | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └service_tier | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | 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 | |
| └structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | |
| └─ testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| └tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| Strumenti └* | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| └ top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | |
| └─ troncamento | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO | |
| 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).
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | ID dell'elemento di output avviato dalla chiamata di ricerca file. | Sì | |
| output_index | numero intero | Indice dell'elemento di output avviato dalla chiamata di ricerca file. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | ID dell'elemento di output avviato dalla chiamata di ricerca file. | Sì | |
| output_index | numero intero | Indice dell'elemento di output avviato dalla chiamata di ricerca file. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | ID dell'elemento di output avviato dalla chiamata di ricerca file. | Sì | |
| output_index | numero intero | L'indice dell'elemento di output che la chiamata di ricerca file sta cercando. | Sì | |
| type | enum | Tipo di evento. Sempre response.file_search_call.searching.Valori possibili: response.file_search_call.searching |
Sì |
OpenAI.ResponseFormat
Discriminare per OpenAI.ResponseFormat
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
json_object |
OpenAI.ResponseFormatJsonObject |
json_schema |
OpenAI.ResponseFormatJsonSchema |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: text, json_object, json_schema |
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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di formato di risposta definito. Sempre json_object.Valori possibili: json_object |
Sì |
OpenAI.ResponseFormatJsonSchema
Schema per il formato di risposta, descritto come oggetto Schema JSON. Informazioni su come creare schemi JSON qui. Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Altre informazioni sugli output strutturati.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| json_schema | oggetto | Opzioni di configurazione degli output strutturati, incluso uno schema JSON. | Sì | |
| └* descrizione | corda | Descrizione del formato di risposta, usato dal modello per decidere come rispondere al formato. |
NO | |
| └> nome | corda | 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. |
NO | |
| └─ Schema | oggetto | NO | ||
| └─ rigoroso | boolean | Indica se abilitare una rigorosa conformità allo schema durante la generazione dell'output. Se impostato su true, il modello seguirà sempre lo schema esatto definito nel schema campo. Quando è supportato solo un subset di schema JSONstrict è true. Per altre informazioni, vedere Output strutturatiguida. |
NO | Falso |
| type | enum | Tipo di formato di risposta definito. Sempre json_schema.Valori possibili: json_schema |
Sì |
OpenAI.ResponseFormatText
Formato di risposta predefinito. Usato per generare risposte di testo.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| delta | corda | Delta degli argomenti di chiamata di funzione aggiunto. | Sì | |
| item_id | corda | ID dell'elemento di output a cui viene aggiunto il delta degli argomenti di chiamata di funzione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui viene aggiunto il delta degli argomenti di chiamata di funzione. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | corda | Argomenti di chiamata di funzione. | Sì | |
| item_id | corda | ID dell'elemento. | Sì | |
| output_index | numero intero | Indice dell'elemento di output. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | 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).
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di generazione dell'immagine in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | Sì | |
| partial_image_b64 | corda | Dati di immagine parziali codificati in Base64, adatti per il rendering come immagine. | Sì | |
| partial_image_index | numero intero | Indice in base 0 per l'immagine parziale (il back-end è basato su 1, ma questo è basato su 0 per l'utente). | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| response | oggetto | Sì | ||
| └* agente | AgentId | Agente usato per questa risposta | NO | |
| └* sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| └* conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| └created_at | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | NO | |
| └─ Errore | OpenAI.ResponseError | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | NO | |
| └* id | corda | Identificatore univoco per questa risposta. | NO | |
| └dettagli_incompleti | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | NO | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| └* istruzioni | stringa o matrice | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| └ max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| └' max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| └─ metadati | oggetto | 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 | corda | 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 |
NO | |
| └─ uscita | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
NO | |
| └output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| └parallel_tool_calls | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| └─previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| └* prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* ragionamento | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └service_tier | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | 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 | |
| └structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | |
| └─ testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| └tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| Strumenti └* | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| └ top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | |
| └─ troncamento | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO | |
| type | enum | Tipo di evento. Sempre response.in_progress.Valori possibili: response.in_progress |
Sì |
OpenAI.ResponseIncompleteEvent
L'evento che viene emesso quando una risposta si conclude come incompleta.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| response | oggetto | Sì | ||
| └* agente | AgentId | Agente usato per questa risposta | NO | |
| └* sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| └* conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| └created_at | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | NO | |
| └─ Errore | OpenAI.ResponseError | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | NO | |
| └* id | corda | Identificatore univoco per questa risposta. | NO | |
| └dettagli_incompleti | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | NO | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| └* istruzioni | stringa o matrice | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| └ max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| └' max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| └─ metadati | oggetto | 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 | corda | 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 |
NO | |
| └─ uscita | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
NO | |
| └output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| └parallel_tool_calls | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| └─previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| └* prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* ragionamento | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └service_tier | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | 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 | |
| └structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | |
| └─ testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| └tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| Strumenti └* | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| └ top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | |
| └─ troncamento | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO | |
| type | enum | Tipo di evento. Sempre response.incomplete.Valori possibili: response.incomplete |
Sì |
OpenAI.ResponseMCPCallArgumentsDeltaEvent
Generato quando è presente un delta (aggiornamento parziale) agli argomenti di una chiamata allo strumento MCP.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| delta | Aggiornamento parziale degli argomenti per la chiamata allo strumento MCP. | Sì | ||
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| arguments | Argomenti finali per la chiamata allo strumento MCP. | Sì | ||
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento di chiamata dello strumento MCP in fase di elaborazione. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| oggetto | oggetto | Elemento di contenuto usato per generare una risposta. | Sì | |
| └created_by | Creato da | Informazioni sull'autore dell'elemento | NO | |
| └* id | corda | NO | ||
| └─ Tipo | OpenAI.ItemType | NO | ||
| output_index | numero intero | Indice dell'elemento di output aggiunto. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| oggetto | oggetto | Elemento di contenuto usato per generare una risposta. | Sì | |
| └created_by | Creato da | Informazioni sull'autore dell'elemento | NO | |
| └* id | corda | NO | ||
| └─ Tipo | OpenAI.ItemType | NO | ||
| output_index | numero intero | Indice dell'elemento di output contrassegnato come completato. | Sì | |
| type | enum | Tipo di evento. Sempre response.output_item.done.Valori possibili: response.output_item.done |
Sì |
OpenAI.ResponsePromptVariables
Mappa facoltativa di 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| response | oggetto | Sì | ||
| └* agente | AgentId | Agente usato per questa risposta | NO | |
| └* sfondo | boolean | Indica se eseguire la risposta del modello in background. Altre informazioni sulle risposte in background. |
NO | Falso |
| └* conversazione | oggetto | NO | ||
| └* id | corda | NO | ||
| └created_at | numero intero | Timestamp Unix (in secondi) di quando è stata creata questa risposta. | NO | |
| └─ Errore | OpenAI.ResponseError | Oggetto di errore restituito quando il modello non riesce a generare una risposta. | NO | |
| └* id | corda | Identificatore univoco per questa risposta. | NO | |
| └dettagli_incompleti | oggetto | Informazioni dettagliate sul motivo per cui la risposta è incompleta. | NO | |
| └* motivo | enum | Motivo per cui la risposta è incompleta. Valori possibili: max_output_tokens, content_filter |
NO | |
| └* istruzioni | stringa o matrice | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. Quando si utilizza insieme a previous_response_id, le istruzioni della fase precedentela risposta non verrà portata alla risposta successiva. In questo modo è semplice per sostituire i messaggi di sistema (o sviluppatore) nelle nuove risposte. |
NO | |
| └ max_output_tokens | numero intero | Limite superiore per il numero di token che possono essere generati per una risposta, inclusi i token di output visibili e i token di ragionamento. | NO | |
| └' max_tool_calls | numero intero | Numero massimo di chiamate totali agli strumenti predefiniti che possono essere elaborati in una risposta. Questo numero massimo si applica a tutte le chiamate di strumenti predefinite, non a ogni singolo strumento. Eventuali altri tentativi di chiamare uno strumento da parte del modello verranno ignorati. | NO | |
| └─ metadati | oggetto | 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 | corda | 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 |
NO | |
| └─ uscita | array | Matrice di elementi di contenuto generati dal modello. - La lunghezza e l'ordine degli elementi nella output matrice dipendonosulla risposta del modello. - Anziché accedere al primo elemento nella matrice output epresupponendo che si tratti di un assistant messaggio con il contenuto generato dail modello, è consigliabile usare la proprietà output_text sesupportato negli SDK. |
NO | |
| └output_text | corda | Proprietà pratica di SDK che contiene l'output di testo aggregato da tutti gli output_text elementi nella output matrice, se presenti.Supportato negli SDK Python e JavaScript. |
NO | |
| └parallel_tool_calls | boolean | Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo. | NO | Vero |
| └─previous_response_id | corda | ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni gestione dello stato della conversazione. |
NO | |
| └* prompt | OpenAI.Prompt | Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni. |
NO | |
| └* ragionamento | OpenAI.Reasoning |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └service_tier | OpenAI.ServiceTier | Nota: service_tier non è applicabile ad Azure OpenAI. | 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 | |
| └structured_inputs | oggetto | Input strutturati per la risposta che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta. | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | |
| └─ testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Possono essere dati JSON strutturati o semplice testo. Vedere Input e output di testo e output strutturati |
NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| └tool_choice | OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject | Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione una risposta. Vedere il tools parametro per vedere come specificare gli strumentiil modello può chiamare. |
NO | |
| Strumenti └* | array | Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il tool_choice parametro .Le due categorie di strumenti che è possibile fornire al modello sono: * Strumenti integrati: strumenti forniti da OpenAI che estendono funzionalità del modello, ad esempio la ricerca Web o ricerca di file. Altre informazioni strumenti predefiniti. * Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, abilitazione del modello a chiamare il proprio codice. Altre informazioni chiamata di funzione. |
NO | |
| └ top_logprobs | numero intero | Un numero intero compreso tra 0 e 20 che specifica il numero di token più probabili da restituire in ogni posizione del token, ognuno con una probabilità di log associata. | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | |
| └─ troncamento | enum | Strategia di troncamento da usare per la risposta del modello. - auto: se il contesto di questa risposta e quelli precedenti superala dimensione della finestra di contesto del modello, il modello troncherà la risposta per adattare la finestra di contesto eliminando gli elementi di input nel nel mezzo della conversazione - disabled (impostazione predefinita): se una risposta del modello supera la finestra di contestodimensione per un modello, la richiesta fallirà con un errore 400. 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 | corda | Altre informazioni sulle procedure consigliate per la sicurezza. | NO | |
| type | enum | Tipo di evento. Sempre 'response.queued'. Valori possibili: response.queued |
Sì |
OpenAI.ResponseReasoningDeltaEvent
Generato quando è presente un delta (aggiornamento parziale) al contenuto di ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte del contenuto di ragionamento all'interno dell'elemento di output. | Sì | |
| delta | Aggiornamento parziale al contenuto di ragionamento. | Sì | ||
| item_id | corda | Identificatore univoco dell'elemento per il quale viene aggiornato il motivo. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | Sì | |
| type | enum | Tipo di evento. Sempre 'response.reasoning.delta'. Valori possibili: response.reasoning.delta |
Sì |
OpenAI.ResponseReasoningDoneEvent
Generato quando il contenuto di ragionamento viene finalizzato per un elemento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte del contenuto di ragionamento all'interno dell'elemento di output. | Sì | |
| item_id | corda | Identificatore univoco dell'elemento per il quale viene finalizzato il ragionamento. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | Sì | |
| Testo | corda | Testo di ragionamento completato. | Sì | |
| type | enum | Tipo di evento. Sempre 'response.reasoning.done'. Valori possibili: response.reasoning.done |
Sì |
OpenAI.ResponseReasoningSummaryDeltaEvent
Generato quando è presente un delta (aggiornamento parziale) al contenuto di riepilogo del ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| delta | Aggiornamento parziale al contenuto di riepilogo del ragionamento. | Sì | ||
| item_id | corda | Identificatore univoco dell'elemento per il quale viene aggiornato il riepilogo dei motivi. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | Sì | |
| summary_index | numero intero | Indice della parte di riepilogo all'interno dell'elemento di output. | Sì | |
| type | enum | Tipo di evento. Sempre "response.reasoning_summary.delta". Valori possibili: response.reasoning_summary.delta |
Sì |
OpenAI.ResponseReasoningSummaryDoneEvent
Generato quando il contenuto di riepilogo del ragionamento viene finalizzato per un elemento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | Identificatore univoco dell'elemento per il quale viene finalizzato il riepilogo del ragionamento. | Sì | |
| output_index | numero intero | Indice dell'elemento di output nella matrice di output della risposta. | Sì | |
| summary_index | numero intero | Indice della parte di riepilogo all'interno dell'elemento di output. | Sì | |
| Testo | corda | Testo di riepilogo del ragionamento conclusivo. | Sì | |
| type | enum | Tipo di evento. Sempre 'response.reasoning_summary.done'. Valori possibili: response.reasoning_summary.done |
Sì |
OpenAI.ResponseReasoningSummaryPartAddedEvent
Generato quando viene aggiunta una nuova parte di riepilogo del ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | L'ID dell'elemento a cui è associata questa parte di riepilogo. | Sì | |
| output_index | numero intero | L'indice dell'elemento di output a cui è associata questa parte di riepilogo. | Sì | |
| part | oggetto | Sì | ||
| └─ Tipo | OpenAI.ReasoningItemSummaryPartType | NO | ||
| summary_index | numero intero | Indice della parte di sintesi all'interno del riepilogo del ragionamento. | Sì | |
| type | enum | Tipo di evento. Sempre response.reasoning_summary_part.added.Valori possibili: response.reasoning_summary_part.added |
Sì |
OpenAI.ResponseReasoningSummaryPartDoneEvent
Generato quando viene completata una parte di riepilogo del ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | L'ID dell'elemento a cui è associata questa parte di riepilogo. | Sì | |
| output_index | numero intero | L'indice dell'elemento di output a cui è associata questa parte di riepilogo. | Sì | |
| part | oggetto | Sì | ||
| └─ Tipo | OpenAI.ReasoningItemSummaryPartType | NO | ||
| summary_index | numero intero | Indice della parte di sintesi all'interno del riepilogo del ragionamento. | Sì | |
| type | enum | Tipo di evento. Sempre response.reasoning_summary_part.done.Valori possibili: response.reasoning_summary_part.done |
Sì |
OpenAI.ResponseReasoningSummaryTextDeltaEvent
Generato quando un delta viene aggiunto a un testo di riepilogo del ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| delta | corda | Delta del testo aggiunto al riepilogo. | Sì | |
| item_id | corda | L'ID dell'elemento a cui è associato questo delta del testo di riepilogo. | Sì | |
| output_index | numero intero | L'indice dell'elemento di output a cui è associato questo delta del testo di riepilogo. | Sì | |
| summary_index | numero intero | Indice della parte di sintesi all'interno del riepilogo del ragionamento. | Sì | |
| type | enum | Tipo di evento. Sempre response.reasoning_summary_text.delta.Valori possibili: response.reasoning_summary_text.delta |
Sì |
OpenAI.ResponseReasoningSummaryTextDoneEvent
Generato quando viene completato un testo di riepilogo del ragionamento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | L'ID dell'elemento a cui è associato questo testo di riepilogo. | Sì | |
| output_index | numero intero | L'indice dell'elemento di output a cui è associato questo testo di riepilogo. | Sì | |
| summary_index | numero intero | Indice della parte di sintesi all'interno del riepilogo del ragionamento. | Sì | |
| Testo | corda | 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.ResponseRefusalDeltaEvent
Emesso quando è presente un testo di rifiuto parziale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte del contenuto a cui viene aggiunto il testo di rifiuto. | Sì | |
| delta | corda | Testo di rifiuto aggiunto. | Sì | |
| item_id | corda | ID dell'elemento di output a cui viene aggiunto il testo di rifiuto. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui viene aggiunto il testo di rifiuto. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte del contenuto in cui viene finalizzato il testo di rifiuto. | Sì | |
| item_id | corda | ID dell'elemento di output in cui viene finalizzato il testo di rifiuto. | Sì | |
| output_index | numero intero | Indice dell'elemento di output in cui viene finalizzato il testo di rifiuto. | Sì | |
| refusal | corda | Il testo di rifiuto completato. | Sì | |
| type | enum | Tipo di evento. Sempre response.refusal.done.Valori possibili: response.refusal.done |
Sì |
OpenAI.ResponseStreamEvent
Discriminatorio per OpenAI.ResponseStreamEvent
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| sequence_number | numero intero | Numero di sequenza per questo evento. | Sì | |
| type | OpenAI.ResponseStreamEventType | Sì |
OpenAI.ResponseStreamEventType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | response.audio.deltaresponse.audio.doneresponse.audio_transcript.deltaresponse.audio_transcript.doneresponse.code_interpreter_call_code.deltaresponse.code_interpreter_call_code.doneresponse.code_interpreter_call.completedresponse.code_interpreter_call.in_progressresponse.code_interpreter_call.interpretingresponse.completedresponse.content_part.addedresponse.content_part.doneresponse.createderrorresponse.file_search_call.completedresponse.file_search_call.in_progressresponse.file_search_call.searchingresponse.function_call_arguments.deltaresponse.function_call_arguments.doneresponse.in_progressresponse.failedresponse.incompleteresponse.output_item.addedresponse.output_item.doneresponse.refusal.deltaresponse.refusal.doneresponse.output_text.annotation.addedresponse.output_text.deltaresponse.output_text.doneresponse.reasoning_summary_part.addedresponse.reasoning_summary_part.doneresponse.reasoning_summary_text.deltaresponse.reasoning_summary_text.doneresponse.web_search_call.completedresponse.web_search_call.in_progressresponse.web_search_call.searchingresponse.image_generation_call.completedresponse.image_generation_call.generatingresponse.image_generation_call.in_progressresponse.image_generation_call.partial_imageresponse.mcp_call.arguments_deltaresponse.mcp_call.arguments_doneresponse.mcp_call.completedresponse.mcp_call.failedresponse.mcp_call.in_progressresponse.mcp_list_tools.completedresponse.mcp_list_tools.failedresponse.mcp_list_tools.in_progressresponse.queuedresponse.reasoning.deltaresponse.reasoning.doneresponse.reasoning_summary.deltaresponse.reasoning_summary.done |
OpenAI.ResponseTextDeltaEvent
Generato quando è presente un delta di testo aggiuntivo.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte di contenuto a cui è stato aggiunto il delta del testo. | Sì | |
| delta | corda | Delta del testo aggiunto. | Sì | |
| item_id | corda | ID dell'elemento di output a cui è stato aggiunto il delta del testo. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui è stato aggiunto il delta del testo. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| content_index | numero intero | Indice della parte del contenuto in cui viene finalizzato il contenuto del testo. | Sì | |
| item_id | corda | ID dell'elemento di output in cui viene finalizzato il contenuto del testo. | Sì | |
| output_index | numero intero | Indice dell'elemento di output in cui viene finalizzato il contenuto del testo. | Sì | |
| Testo | corda | Contenuto di testo finalizzato. | Sì | |
| type | enum | Tipo di evento. Sempre response.output_text.done.Valori possibili: response.output_text.done |
Sì |
OpenAI.ResponseTextFormatConfiguration
Discriminatore per OpenAI.ResponseTextFormatConfiguration
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
text |
OpenAI.ResponseTextFormatConfigurationText |
json_object |
OpenAI.ResponseTextFormatConfigurationJsonObject |
json_schema |
OpenAI.ResponseTextFormatConfigurationJsonSchema |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ResponseTextFormatConfigurationType | 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 la 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, chegarantisce che il messaggio generato dal modello sia JSON valido. Utilizzo di json_schemaè preferibile per i modelli che lo supportano. |
Sì |
OpenAI.ResponseTextFormatConfigurationJsonObject
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: json_object |
Sì |
OpenAI.ResponseTextFormatConfigurationJsonSchema
Formato di risposta dello schema JSON. Usato per generare risposte JSON strutturate. Altre informazioni sugli output strutturati.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione del formato di risposta, usato dal modello per decidere come rispondere al formato. |
NO | |
| nome | corda | 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 | oggetto | Sì | ||
| rigido | boolean | Indica se abilitare una rigorosa conformità allo schema durante la generazione dell'output. Se impostato su true, il modello seguirà sempre lo schema esatto definito nel schema campo. Quando è supportato solo un subset di schema JSONstrict è true. Per altre informazioni, vedere Output strutturatiguida. |
NO | Falso |
| type | enum | Tipo di formato di risposta definito. Sempre json_schema.Valori possibili: json_schema |
Sì |
OpenAI.ResponseTextFormatConfigurationText
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: text |
Sì |
OpenAI.ResponseTextFormatConfigurationType
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 la
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. L'uso json_schema è preferibile per i modelli che lo supportano.
| Proprietà | Value |
|---|---|
| Descrizione | 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 la
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. L'uso json_schema è preferibile per i modelli che lo supportano. | | Tipo | string | | Valori | textjson_schemajson_object |
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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| input_tokens | numero intero | Numero di token di input. | Sì | |
| input_tokens_details | oggetto | Dettaglio dei token di input. | Sì | |
| └cached_tokens | numero intero | Numero di token recuperati dalla cache. Altre informazioni sulla memorizzazione nella cache dei prompt. |
NO | |
| output_tokens | numero intero | Numero di token in uscita. | Sì | |
| output_tokens_details | oggetto | Dettaglio dei token di output. | Sì | |
| └─ token_di_ragionamento | numero intero | Numero di token di ragionamento. | NO | |
| total_tokens | numero intero | Numero totale di token usati. | Sì |
OpenAI.ResponseWebSearchCallCompletedEvent
Nota: web_search non è ancora disponibile tramite Azure OpenAI.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | ID univoco per l'elemento di output associato alla chiamata di ricerca Web. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui è associata la chiamata di ricerca Web. | Sì | |
| type | enum | Tipo di evento. Sempre response.web_search_call.completed.Valori possibili: response.web_search_call.completed |
Sì |
OpenAI.ResponseWebSearchCallInProgressEvent
Nota: web_search non è ancora disponibile tramite Azure OpenAI.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | ID univoco per l'elemento di output associato alla chiamata di ricerca Web. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui è associata la chiamata di ricerca Web. | Sì | |
| type | enum | Tipo di evento. Sempre response.web_search_call.in_progress.Valori possibili: response.web_search_call.in_progress |
Sì |
OpenAI.ResponseWebSearchCallSearchingEvent
Nota: web_search non è ancora disponibile tramite Azure OpenAI.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| item_id | corda | ID univoco per l'elemento di output associato alla chiamata di ricerca Web. | Sì | |
| output_index | numero intero | Indice dell'elemento di output a cui è associata la chiamata di ricerca Web. | Sì | |
| type | enum | Tipo di evento. Sempre response.web_search_call.searching.Valori possibili: response.web_search_call.searching |
Sì |
OpenAI.ResponsesAssistantMessageItemParam
Elemento del parametro del messaggio con il ruolo assistant.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | stringa o matrice | Sì | ||
| ruolo | enum | Ruolo del messaggio, che è sempre assistant.Valori possibili: assistant |
Sì |
OpenAI.ResponsesAssistantMessageItemResource
Elemento della risorsa messaggio con il ruolo assistant.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | array | Contenuto associato al messaggio. | Sì | |
| ruolo | enum | Ruolo del messaggio, che è sempre assistant.Valori possibili: assistant |
Sì |
OpenAI.ResponsesDeveloperMessageItemParam
Elemento del parametro del messaggio con il ruolo developer.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | stringa o matrice | Sì | ||
| ruolo | enum | Ruolo del messaggio, che è sempre developer.Valori possibili: developer |
Sì |
OpenAI.ResponsesDeveloperMessageItemResource
Elemento della risorsa messaggio con il ruolo developer.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | array | Contenuto associato al messaggio. | Sì | |
| ruolo | enum | Ruolo del messaggio, che è sempre developer.Valori possibili: developer |
Sì |
OpenAI.ResponsesMessageItemParam
Elemento del messaggio di risposta, che rappresenta un ruolo e un contenuto, come specificato come parametri di richiesta client.
Discriminatorio per OpenAI.ResponsesMessageItemParam
Questo componente usa la proprietà role per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
user |
OpenAI.ResponsesUserMessageItemParam |
system |
OpenAI.ResponsesSystemMessageItemParam |
developer |
OpenAI.ResponsesDeveloperMessageItemParam |
assistant |
OpenAI.ResponsesAssistantMessageItemParam |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ruolo | oggetto | Raccolta di ruoli validi per le risposte agli elementi del messaggio. | Sì | |
| type | enum | Tipo dell'elemento delle risposte, che è sempre "message". Valori possibili: message |
Sì |
OpenAI.ResponsesMessageItemResource
Elemento della risorsa del messaggio di risposta, che rappresenta un ruolo e un contenuto, come specificato nelle risposte del servizio.
Discriminare per OpenAI.ResponsesMessageItemResource
Questo componente usa la proprietà role per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
user |
OpenAI.ResponsesUserMessageItemResource |
system |
OpenAI.ResponsesSystemMessageItemResource |
developer |
OpenAI.ResponsesDeveloperMessageItemResource |
assistant |
OpenAI.ResponsesAssistantMessageItemResource |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| ruolo | oggetto | Raccolta di ruoli validi per le risposte agli elementi del messaggio. | Sì | |
| stato | enum | Stato dell'elemento. Uno di in_progress, completed, oincomplete. Popolato quando gli elementi vengono restituiti tramite l'API.Valori possibili: in_progress, completed, incomplete |
Sì | |
| type | enum | Tipo dell'elemento delle risposte, che è sempre "message". Valori possibili: message |
Sì |
OpenAI.ResponsesMessageRole
Raccolta di ruoli validi per le risposte agli elementi del messaggio.
| Proprietà | Value |
|---|---|
| Descrizione | Raccolta di ruoli validi per le risposte agli elementi del messaggio. |
| Tipo | corda |
| Valori | systemdeveloperuserassistant |
OpenAI.ResponsesSystemMessageItemParam
Elemento del parametro del messaggio con il ruolo system.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | stringa o matrice | Sì | ||
| ruolo | enum | Ruolo del messaggio, che è sempre system.Valori possibili: system |
Sì |
OpenAI.ResponsesSystemMessageItemResource
Elemento della risorsa messaggio con il ruolo system.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | array | Contenuto associato al messaggio. | Sì | |
| ruolo | enum | Ruolo del messaggio, che è sempre system.Valori possibili: system |
Sì |
OpenAI.ResponsesUserMessageItemParam
Elemento del parametro del messaggio con il ruolo user.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | stringa o matrice | Sì | ||
| ruolo | enum | Ruolo del messaggio, che è sempre user.Valori possibili: user |
Sì |
OpenAI.ResponsesUserMessageItemResource
Elemento della risorsa messaggio con il ruolo user.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| contenuto | array | Contenuto associato al messaggio. | Sì | |
| ruolo | enum | Ruolo del messaggio, che è sempre user.Valori possibili: user |
Sì |
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 progetto 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. Per altre informazioni sull'elaborazione priorità, contattare le vendite.
- 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 |
|---|---|
| Descrizione | Specifica il tipo di elaborazione utilizzato per gestire la richiesta. * Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurata nelle impostazioni del progetto. Se non diversamente configurato, il progetto userà 'default'. * Se impostato su "default", la richiesta verrà elaborata con lo standard prezzi e prestazioni per il modello selezionato. * Se impostato su 'flex' o "priorità", la richiesta verrà elaborata con il servizio corrispondente livello. Per altre informazioni sull'elaborazione priorità, contattare le vendite. * Quando non è impostato, il comportamento predefinito è 'auto'. Quando il service_tier parametro è impostato, il corpo della risposta includerà service_tiervalore basato sulla modalità di elaborazione effettivamente utilizzata per gestire la richiesta. Questo valore della risposta può essere diverso dal valore impostato nel parametro . |
| Tipo | corda |
| Valori | autodefaultflexscalepriority |
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 la
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. 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 tipo | Schema |
|---|
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | corda | Sì |
OpenAI.Tool
Discriminatore per OpenAI.Tool
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
function |
OpenAI.FunctionTool |
file_search |
OpenAI.FileSearchTool |
computer_use_preview |
OpenAI.ComputerUsePreviewTool |
web_search_preview |
OpenAI.WebSearchPreviewTool |
code_interpreter |
OpenAI.CodeInterpreterTool |
image_generation |
OpenAI.ImageGenTool |
local_shell |
OpenAI.LocalShellTool |
mcp |
OpenAI.MCPTool |
bing_grounding |
BingGroundingAgentTool |
fabric_dataagent_preview |
MicrosoftFabricAgentTool |
sharepoint_grounding_preview |
SharepointAgentTool |
azure_ai_search |
AzureAISearchAgentTool |
openapi |
OpenApiAgentTool |
bing_custom_search_preview |
BingCustomSearchAgentTool |
browser_automation_preview |
BrowserAutomationAgentTool |
azure_function |
AzureFunctionAgentTool |
capture_structured_outputs |
CaptureStructuredOutputsTool |
a2a_preview |
A2ATool |
memory_search |
MemorySearchTool |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ToolType | Strumento che può essere usato per generare una risposta. | Sì |
OpenAI.ToolChoiceObject
Discriminante per OpenAI.ToolChoiceObject
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
file_search |
OpenAI.ToolChoiceObjectFileSearch |
computer_use_preview |
OpenAI.ToolChoiceObjectComputer |
web_search_preview |
OpenAI.ToolChoiceObjectWebSearch |
image_generation |
OpenAI.ToolChoiceObjectImageGen |
code_interpreter |
OpenAI.ToolChoiceObjectCodeInterpreter |
function |
OpenAI.ToolChoiceObjectFunction |
mcp |
OpenAI.ToolChoiceObjectMCP |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.ToolChoiceObjectType | Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti. |
Sì |
OpenAI.ToolChoiceObjectCodeInterpreter
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: code_interpreter |
Sì |
OpenAI.ToolChoiceObjectComputer
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: computer_use_preview |
Sì |
OpenAI.ToolChoiceObjectFileSearch
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: file_search |
Sì |
OpenAI.ToolChoiceObjectFunction
Usare questa opzione per forzare il modello a chiamare una funzione specifica.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Nome della funzione da chiamare. | Sì | |
| type | enum | Per la chiamata di funzione, il tipo è sempre function.Valori possibili: function |
Sì |
OpenAI.ToolChoiceObjectImageGen
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: image_generation |
Sì |
OpenAI.ToolChoiceObjectMCP
Usare questa opzione per forzare il modello a chiamare uno strumento specifico in un server MCP remoto.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nome | corda | Nome dello strumento da chiamare sul server. | NO | |
| etichetta del server | corda | Etichetta del server MCP da utilizzare. | Sì | |
| type | enum | Per gli strumenti MCP, il tipo è sempre mcp.Valori possibili: mcp |
Sì |
OpenAI.ToolChoiceObjectType
Indica che il modello deve usare uno strumento predefinito per generare una risposta. Altre informazioni sugli strumenti predefiniti.
| Proprietà | Value |
|---|---|
| Descrizione | Indica che il modello deve usare uno strumento predefinito per generare una risposta. |
| Altre informazioni sugli strumenti predefiniti. | |
| Tipo | corda |
| Valori | file_searchfunctioncomputer_use_previewweb_search_previewimage_generationcode_interpretermcp |
OpenAI.ToolChoiceObjectWebSearch
Nota: web_search non è ancora disponibile tramite Azure OpenAI.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: web_search_preview |
Sì |
OpenAI.ToolChoiceOptions
Controlla quale strumento (se presente) viene chiamato dal modello.
none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.
auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno o più strumenti.
required indica che il modello deve chiamare uno o più strumenti.
| Proprietà | Value |
|---|---|
| Descrizione | Controlla quale strumento (se presente) viene chiamato dal modello.none indica che il modello non chiamerà alcuno strumento e genera invece un messaggio.auto indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno opiù strumenti required indica che il modello deve chiamare uno o più strumenti. |
| Tipo | corda |
| Valori | noneautorequired |
OpenAI.ToolType
Strumento che può essere usato per generare una risposta.
| Proprietà | Value |
|---|---|
| Descrizione | Strumento che può essere usato per generare una risposta. |
| Tipo | corda |
| Valori | file_searchfunctioncomputer_use_previewweb_search_previewmcpcode_interpreterimage_generationlocal_shellbing_groundingbrowser_automation_previewfabric_dataagent_previewsharepoint_grounding_previewazure_ai_searchopenapibing_custom_search_previewcapture_structured_outputsa2a_previewazure_functionmemory_search |
OpenAI.TopLogProb
Probabilità di log superiore di un token.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| bytes | array | Sì | ||
| logprob | numero | Sì | ||
| token | corda | Sì |
OpenAI.UpdateConversationRequest
Aggiornare una conversazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| metadata | oggetto | 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.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.WebSearchAction
Discriminatore per OpenAI.WebSearchAction
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
find |
OpenAI.WebSearchActionFind |
open_page |
OpenAI.WebSearchActionOpenPage |
search |
OpenAI.WebSearchActionSearch |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | OpenAI.WebSearchActionType | Sì |
OpenAI.WebSearchActionFind
Tipo di azione "find": cerca un criterio all'interno di una pagina caricata.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| pattern | corda | Modello o testo da cercare all'interno della pagina. | Sì | |
| type | enum | Tipo di azione. Valori possibili: find |
Sì | |
| URL. | corda | URL della pagina in cui è stata eseguita la ricerca del modello. | Sì |
OpenAI.WebSearchActionOpenPage
Tipo di azione "open_page" - Apre un URL specifico dai risultati della ricerca.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Tipo di azione. Valori possibili: open_page |
Sì | |
| URL. | corda | URL aperto dal modello. | Sì |
OpenAI.WebSearchActionSearch
Tipo di azione "search" - Esegue una query di ricerca Web.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| query | corda | Query di ricerca. | Sì | |
| Fonti | array | Le fonti utilizzate nella ricerca. | NO | |
| type | enum | Tipo di azione. Valori possibili: search |
Sì |
OpenAI.WebSearchActionSearchSources
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | enum | Valori possibili: url |
Sì | |
| URL. | corda | Sì |
OpenAI.WebSearchActionType
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | searchopen_pagefind |
OpenAI.WebSearchPreviewTool
Nota: web_search non è ancora disponibile tramite Azure OpenAI.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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 tra web_search_preview e web_search_preview_2025_03_11.Valori possibili: web_search_preview |
Sì | |
| posizione_utente | oggetto | NO | ||
| └─ Tipo | OpenAI.LocationType | NO |
OpenAI.WebSearchToolCallItemParam
I risultati di una chiamata a uno strumento di ricerca Web. Per ulteriori informazioni, consulta la guida alla ricerca sul Web .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | oggetto | Sì | ||
| └─ Tipo | OpenAI.WebSearchActionType | NO | ||
| type | enum | Valori possibili: web_search_call |
Sì |
OpenAI.WebSearchToolCallItemResource
I risultati di una chiamata a uno strumento di ricerca Web. Per ulteriori informazioni, consulta la guida alla ricerca sul Web .
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| azione | oggetto | Sì | ||
| └─ Tipo | OpenAI.WebSearchActionType | NO | ||
| stato | enum | Stato della chiamata dello strumento di ricerca Web. Valori possibili: in_progress, searching, completed, failed |
Sì | |
| type | enum | Valori possibili: web_search_call |
Sì |
OpenAI.integer
Tipo: integer
Formato: int64
OpenAI.numeric
Tipo: numero
Formato: double
OpenApiAgentTool
Informazioni sulla definizione di input per uno strumento OpenAPI usato per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| openapi | oggetto | Informazioni sulla definizione di input per una funzione openapi. | Sì | |
| └* Autenticazione | OpenApiAuthDetails | Aprire i dettagli di autenticazione dell'API | NO | |
| └default_params | array | Elenco dei parametri della specifica OpenAPI che useranno le impostazioni predefinite fornite dall'utente | NO | |
| └* descrizione | corda | Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. | NO | |
| └* funzioni | array | Elenco delle definizioni di funzione utilizzate dallo strumento OpenApi | NO | |
| └> nome | corda | Nome della funzione che deve essere chiamata. | NO | |
| └* specifica | La forma della funzione openapi, descritta come oggetto Schema JSON. | NO | ||
| type | enum | Il tipo di oggetto, che è sempre 'openapi'. Valori possibili: openapi |
Sì |
OpenApiAnonymousAuthDetails
Dettagli di sicurezza per l'autenticazione anonima OpenApi
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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 tipo | Schema |
|---|---|
anonymous |
OpenApiAnonymousAuthDetails |
project_connection |
OpenApiProjectConnectionAuthDetails |
managed_identity |
OpenApiManagedAuthDetails |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono: - Anonimo (nessuna autenticazione necessaria) - Connessione progetto (richiede project_connection_id all'endpoint, come configurazione in 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 Connection (richiede project_connection_id all'endpoint, come configurazione in Foundry)
- Managed_Identity (richiede un pubblico per l'autenticazione basata sull'identità)
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | anonymousproject_connectionmanaged_identity |
OpenApiFunctionDefinition
Informazioni sulla definizione di input per una funzione openapi.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| auth | oggetto | dettagli di autenticazione per OpenApiFunctionDefinition | Sì | |
| └─ Tipo | OpenApiAuthType | Il tipo di autenticazione deve essere anonimo/project_connection/managed_identity | NO | |
| default_params | array | Elenco dei parametri della specifica OpenAPI che useranno le impostazioni predefinite fornite dall'utente | NO | |
| descrizione | corda | Descrizione delle operazioni della funzione, usate dal modello per scegliere quando e come chiamare la funzione. | NO | |
| functions | array | Elenco delle definizioni di funzione utilizzate dallo strumento OpenApi | NO | |
| nome | corda | Nome della funzione che deve essere chiamata. | Sì | |
| spec | La forma della funzione openapi, descritta come oggetto Schema JSON. | Sì |
OpenApiManagedAuthDetails
Dettagli di sicurezza per l'autenticazione managed_identity OpenApi
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| security_scheme | oggetto | Schema di sicurezza per l'autenticazione managed_identity OpenApi | Sì | |
| Gruppo di destinatari └* | corda | Ambito di autenticazione per managed_identity tipo di autenticazione | NO | |
| type | enum | Tipo di oggetto, che è sempre "managed_identity". Valori possibili: managed_identity |
Sì |
OpenApiManagedSecurityScheme
Schema di sicurezza per l'autenticazione managed_identity OpenApi
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| audience | corda | Ambito di autenticazione per managed_identity tipo di autenticazione | Sì |
OpenApiProjectConnectionAuthDetails
Dettagli di sicurezza per l'autenticazione della connessione al progetto OpenApi
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| security_scheme | oggetto | Schema di sicurezza per l'autenticazione managed_identity OpenApi | Sì | |
| └project_connection_id | corda | ID connessione progetto per il tipo di autenticazione connessione progetto | NO | |
| type | enum | Il tipo di oggetto, che è sempre 'project_connection'. Valori possibili: project_connection |
Sì |
OpenApiProjectConnectionSecurityScheme
Schema di sicurezza per l'autenticazione managed_identity OpenApi
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| project_connection_id | corda | ID connessione progetto per il tipo di autenticazione connessione progetto | Sì |
PagedConnection
Raccolta di paging degli elementi di connessione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Gli elementi di connessione in questa pagina | Sì |
PagedDatasetVersion
Raccolta di paging di elementi DatasetVersion
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi DatasetVersion in questa pagina | Sì |
PagedDeployment
Raccolta di paging di elementi di distribuzione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi di distribuzione in questa pagina | Sì |
PagedEvaluationRule
Raccolta di elementi Paged di EvaluationRule
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi EvaluationRule in questa pagina | Sì |
PagedEvaluationTaxonomy
Raccolta di pagine di elementi EvaluationTaxonomy
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi EvaluationTaxonomy in questa pagina | Sì |
PagedEvaluatorVersion
Raccolta di pagine di elementi EvaluatorVersion
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi Di analizzatoreVersion in questa pagina | Sì |
PagedIndex
Raccolta di pagine di elementi dell'indice
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Gli elementi dell'indice in questa pagina | Sì |
PagedInsight
Raccolta di elementi Insight in pagine
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi di Informazioni dettagliate in questa pagina | Sì |
PagedRedTeam
Raccolta di elementi RedTeam di pagine
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Gli articoli di RedTeam in questa pagina | Sì |
PagedSchedule
Raccolta di paging degli elementi della pianificazione
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi pianificati in questa pagina | Sì |
PagedScheduleRun
Insieme di paging di elementi ScheduleRun
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| nextLink | corda | Collegamento alla pagina successiva di elementi | NO | |
| valore | array | Elementi ScheduleRun in questa pagina | Sì |
PendingUploadRequest
Rappresenta una richiesta di caricamento in sospeso.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| connectionName | corda | 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 | corda | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| blobReference | oggetto | Dettagli di riferimento BLOB. | Sì | |
| └* blobUri | corda | Percorso URI BLOB per il caricamento dei dati da parte del client. Esempio: https://blob.windows.core.net/Container/Path |
NO | |
| └* credenziali | SasCredential | Informazioni sulle credenziali per accedere all'account di archiviazione. | NO | |
| └\ storageAccountArmId | corda | ID ARM dell'account di archiviazione da usare. | NO | |
| pendingUploadId | corda | ID per questa richiesta di caricamento. | Sì | |
| pendingUploadType | enum | BlobReference è l'unico tipo supportato Valori possibili: BlobReference |
Sì | |
| version | corda | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| instructions | corda | Messaggio di sistema (o sviluppatore) inserito nel contesto del modello. | NO | |
| tipo/gentile | enum | Valori possibili: prompt |
Sì | |
| model | corda | Distribuzione del modello da utilizzare per l'agente. | Sì | |
| reasoning | oggetto |
Solo modelli di serie o Opzioni di configurazione per i modelli di ragionamento. |
NO | |
| └* sforzo | Sforzo di Ragionamento OpenAI | Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, low, medium e high. La riduzione del lavoro di ragionamento può tradursi in risposte più veloci e in un minor numero di token usati per il ragionamento in una risposta. gpt-5.1 per impostazione predefinita non è nessuno, che non esegue il ragionamento. I valori di ragionamento supportati per gpt-5.1 none, low, medium e high. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. Tutti i modelli precedenti a gpt-5.1 per impostazione predefinita sono operazioni di ragionamento medio e non supportano nessuno. Per impostazione predefinita, il modello gpt-5-pro è (e supporta solo) un elevato sforzo di ragionamento. |
NO | |
| └─ genera_sommario | enum |
Deprecato: utilizzare summary al suo posto. Riepilogo del ragionamento eseguito dal modello. Ciò può essere utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| └─ Riepilogo | enum | Riepilogo del ragionamento eseguito dal modello. Può trattarsi di utile per eseguire il debug e comprendere il processo di ragionamento del modello. Uno tra auto, concise e detailed.Valori possibili: auto, concise, detailed |
NO | |
| structured_inputs | oggetto | 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 si consiglia di modificare questo valore o top_p ma non entrambi. |
NO | 1 |
| Testo | oggetto | Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati. | NO | |
| └* formato | OpenAI.ResponseTextFormatConfiguration | NO | ||
| strumenti | array | 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 si consiglia di modificare questo valore o temperature ma non entrambi. |
NO | 1 |
PromptBasedEvaluatorDefinition
Analizzatore basato su prompt
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| prompt_text | corda | Il 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| protocol | oggetto | Sì | ||
| version | corda | La 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).
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| rai_policy_name | corda | Il nome della polizza 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 tipo | Schema |
|---|---|
Hourly |
HourlyRecurrenceSchedule |
Daily |
DailyRecurrenceSchedule |
Weekly |
WeeklyRecurrenceSchedule |
Monthly |
MonthlyRecurrenceSchedule |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | Tipo di ricorrenza. | Sì |
RecurrenceTrigger
Trigger basato sulla ricorrenza.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| endTime | corda | Ora di fine per la pianificazione della ricorrenza in formato ISO 8601. | NO | |
| interval | numero intero | Intervallo per la pianificazione della ricorrenza. | Sì | |
| Orario | oggetto | Modello di pianificazione delle ricorrenze. | Sì | |
| └─ Tipo | RecurrenceType | Tipo di ricorrenza per la pianificazione della ricorrenza. | NO | |
| startTime | corda | Ora di inizio per la pianificazione delle ricorrenze in formato ISO 8601. | NO | |
| timeZone | corda | 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. |
| Tipo | corda |
| Valori | HourlyDailyWeeklyMonthly |
RedTeam
Dettagli della squadra rossa.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| applicationScenario | corda | Scenario applicativo per l'operazione red team, per generare attacchi specifici dello scenario. | NO | |
| attackStrategies | array | Elenco di strategie di attacco o elenchi nidificati di strategie di attacco. | NO | |
| nome visualizzato | corda | Nome della corsa della squadra rossa. | NO | |
| id | corda | Identificatore della corsa della squadra rossa. | Sì | |
| numTurns | numero intero | Numero di round di simulazione. | NO | |
| proprietà | oggetto | Proprietà della squadra rossa. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà. | NO | |
| riskCategories | array | Elenco delle categorie di rischio per cui generare obiettivi di attacco. | NO | |
| simulationOnly | boolean | Solo simulazione o Simulazione + Valutazione. Impostazione predefinita: false, se true la scansione restituisce la conversazione, non il risultato della valutazione. | NO | Falso |
| stato | corda | Stato della squadra rossa. Viene impostato dal servizio ed è di sola lettura. | NO | |
| tags | oggetto | Tag della squadra rossa. A differenza delle proprietà, i tag sono completamente modificabili. | NO | |
| target | oggetto | Classe astratta per la configurazione del target. | Sì | |
| └─ Tipo | corda | Tipo di configurazione del modello. | NO |
RedTeamItemGenerationParams
Rappresenta i parametri per la generazione di elementi red team.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| attack_strategies | array | Raccolta di strategie di attacco da usare. | Sì | |
| num_turns | numero intero | Numero di turni consentiti nel gioco. | Sì | |
| type | enum | Tipo di parametri di generazione di elementi, sempre red_team.Valori possibili: red_team |
Sì |
RiskCategory
Categoria di rischio per l'obiettivo dell'attacco.
| Proprietà | Value |
|---|---|
| Descrizione | Categoria di rischio per l'obiettivo dell'attacco. |
| Tipo | corda |
| Valori | HateUnfairnessViolenceSexualSelfHarmProtectedMaterialCodeVulnerabilityUngroundedAttributesProhibitedActionsSensitiveDataLeakageTaskAdherence |
SasCredentials
Definizione delle credenziali di firma di accesso condiviso
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| SAS | corda | Token della firma di accesso condiviso | NO | |
| type | enum | Tipo di credenziale Valori possibili: SAS |
Sì |
SampleType
Il tipo di campione utilizzato nell'analisi.
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | EvaluationResultSample |
SasCredential
Definizione delle credenziali di firma di accesso condiviso
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| sasUri | corda | URI SAS | Sì | |
| type | enum | Tipo di credenziale Valori possibili: SAS |
Sì |
Calendario
Modello di pianificazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione della pianificazione. | NO | |
| nome visualizzato | corda | Nome della pianificazione. | NO | |
| enabled | boolean | Stato abilitato della pianificazione. | Sì | |
| id | corda | Identificatore della pianificazione. | Sì | |
| proprietà | oggetto | Proprietà del programma. A differenza dei tag, le proprietà sono solo aggiuntive. Una volta aggiunta, non è possibile rimuovere una proprietà. | NO | |
| provisioningStatus | oggetto | Pianificare lo stato del provisioning. | NO | |
| dati di sistema | oggetto | Metadati di sistema per la risorsa. | Sì | |
| tags | oggetto | Tag del programma. A differenza delle proprietà, i tag sono completamente modificabili. | NO | |
| compito | oggetto | Modello di attività di pianificazione. | Sì | |
| Configurazione di └* | oggetto | Configurazione per l'attività. | NO | |
| └─ Tipo | ScheduleTaskType | Tipo dell'attività. | NO | |
| trigger | oggetto | Modello base per il Trigger del programma. | Sì | |
| └─ Tipo | TriggerType | Tipo di trigger. | NO |
ScheduleProvisioningStatus
Pianificare lo stato del provisioning.
| Proprietà | Value |
|---|---|
| Descrizione | Pianificare lo stato del provisioning. |
| Tipo | corda |
| Valori | CreatingUpdatingDeletingSucceededFailed |
ScheduleRun
Pianificare il modello di esecuzione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Errore | corda | Informazioni sull'errore per l'esecuzione della pianificazione. | NO | |
| id | corda | Identificatore dell'esecuzione della pianificazione. | Sì | |
| proprietà | oggetto | Proprietà dell'esecuzione della pianificazione. | Sì | |
| scheduleId | corda | Identificatore della pianificazione. | Sì | |
| successo | boolean | Attiva lo stato di esito positivo dell'esecuzione della pianificazione. | Sì | |
| triggerTime | corda | 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 tipo | Schema |
|---|---|
Evaluation |
EvaluationScheduleTask |
Insight |
InsightScheduleTask |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| configuration | oggetto | Configurazione per l'attività. | NO | |
| type | oggetto | Tipo dell'attività. | Sì |
ScheduleTaskType
Tipo dell'attività.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo dell'attività. |
| Tipo | corda |
| Valori | EvaluationInsight |
SeedPromptsRedTeamItemGenerationParams
Rappresenta i parametri per la generazione di elementi red team con prompt di inizializzazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| attack_strategies | array | Raccolta di strategie di attacco da usare. | Sì | |
| num_turns | numero intero | Numero di turni consentiti nel gioco. | Sì | |
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └* id | corda | Identificatore del file. | NO | |
| └─ Tipo | enum | Tipo di origine JSONL. Sempre file_id.Valori possibili: file_id |
NO | |
| type | enum | Tipo di parametri di generazione di elementi, sempre red_team.Valori possibili: red_team_seed_prompts |
Sì |
SharepointAgentTool
Informazioni sulla definizione di input per uno strumento di SharePoint usato per configurare un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| sharepoint_grounding_preview | oggetto | Parametri dello strumento di messa a terra di SharePoint. | Sì | |
| └project_connections | array | Le connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. |
NO | |
| type | enum | Tipo di oggetto, che è sempre "sharepoint_grounding". Valori possibili: sharepoint_grounding_preview |
Sì |
SharepointGroundingToolParameters
Parametri dello strumento di messa a terra di SharePoint.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| project_connections | array | Le connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. |
NO |
Sku
Informazioni sullo SKU
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| capacità | numero intero | Capacità sku | Sì | |
| family | corda | Famiglia Sku | Sì | |
| nome | corda | Nome SKU | Sì | |
| size | corda | Dimensioni sku | Sì | |
| tier | corda | Livello SKU | Sì |
StructuredInputDefinition
Input strutturato che può partecipare alle sostituzioni di modelli di prompt e all'associazione di argomenti dello strumento.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| default_value | Valore predefinito per l'input se non viene fornito alcun valore di runtime. | NO | ||
| descrizione | corda | Una descrizione leggibile dell'input. | NO | |
| required | boolean | Indica se la proprietà di input è necessaria quando viene richiamato l'agente. | NO | Falso |
| schema | Lo schema JSON per l'input strutturato (facoltativo). | NO |
StructuredOutputDefinition
Output strutturato che può essere prodotto dall'agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione dell'output da emettere. Utilizzato dal modello per determinare quando generare l'output. | Sì | |
| nome | corda | Nome dell'output strutturato. | Sì | |
| schema | Schema JSON per l'output strutturato. | Sì | ||
| rigido | boolean | Se applicare una convalida rigorosa. Valore predefinito true. |
Sì |
StructuredOutputsItemResource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| output | Output strutturato acquisito durante la risposta. | Sì | ||
| type | enum | Valori possibili: structured_outputs |
Sì |
Obiettivo
Classe base per bersagli con supporto per discriminatore.
Discriminare per target
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
azure_ai_model |
AzureAIModelTarget |
azure_ai_agent |
AzureAIAgentTarget |
azure_ai_assistant |
AzureAIAssistantTarget |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | corda | Tipo di destinazione. | Sì |
TargetCompletions
Rappresenta un'origine dati per la configurazione di valutazione del completamento basata su destinazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| messaggi di input | oggetto | NO | ||
| └item_reference | corda | NO | ||
| └─ Tipo | enum | Valori possibili: item_reference |
NO | |
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └* id | corda | Identificatore del file. | NO | |
| └─ Tipo | enum | Tipo di origine JSONL. Sempre file_id.Valori possibili: file_id |
NO | |
| target | oggetto | Classe base per bersagli con supporto per discriminatore. | Sì | |
| └─ Tipo | corda | Tipo di destinazione. | NO | |
| type | enum | Tipo di origine dati, sempre TargetCompletions.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 tipo | Schema |
|---|---|
AzureOpenAIModel |
AzureOpenAIModelConfiguration |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | corda | Tipo di 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 tipo | Schema |
|---|---|
azure_ai_model |
AzureAIModelTargetUpdate |
azure_ai_assistant |
AzureAIAssistantTargetUpdate |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | corda | Tipo di destinazione. | Sì |
TassonomiaCategory
Definizione della categoria di tassonomia.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione della categoria della tassonomia. | NO | |
| id | corda | Identificatore univoco della categoria della tassonomia. | Sì | |
| nome | corda | Nome della categoria della tassonomia. | Sì | |
| proprietà | oggetto | Proprietà aggiuntive per la categoria tassonomia. | NO | |
| riskCategory | oggetto | Categoria di rischio per l'obiettivo dell'attacco. | Sì | |
| Sottocategorie | array | Elenco delle sottocategorie di tassonomia. | Sì |
TaxonomyRedTeamItemGenerationParams
Rappresenta i parametri per la generazione di elementi red team con prompt di inizializzazione.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| attack_strategies | array | Raccolta di strategie di attacco da usare. | Sì | |
| num_turns | numero intero | Numero di turni consentiti nel gioco. | Sì | |
| source | oggetto | Sì | ||
| └> contenuto | array | Contenuto del file jsonl. | NO | |
| └* id | corda | Identificatore del file. | NO | |
| └─ Tipo | enum | Tipo di origine JSONL. Sempre file_id.Valori possibili: file_id |
NO | |
| type | enum | Tipo di parametri di generazione di elementi, sempre red_team.Valori possibili: red_team_taxonomy |
Sì |
TassonomiaSubCategory
Definizione della sottocategoria della tassonomia.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Descrizione della sottocategoria della tassonomia. | NO | |
| enabled | boolean | Elenco degli elementi della tassonomia in questa sottocategoria. | Sì | |
| id | corda | Identificatore univoco della sottocategoria della tassonomia. | Sì | |
| nome | corda | Nome della sottocategoria della tassonomia. | Sì | |
| proprietà | oggetto | Proprietà aggiuntive per la sottocategoria della tassonomia. | NO |
ToolDescription
Descrizione di uno strumento che può essere utilizzato da un agente.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una breve descrizione dello scopo dello strumento. | NO | |
| nome | corda | Nome dello strumento. | NO |
ToolProjectConnection
Una risorsa di connessione al progetto.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| project_connection_id | corda | Una connessione di progetto in un oggetto ToolProjectConnectionList collegato a questo strumento. | Sì |
TracesEvalRunDataSource
Rappresenta un'origine dati per le esecuzioni di valutazione che operano sulle tracce di Agent archiviate in Application Insights.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| lookback_hours | numero intero | Finestra di lookback (in ore) applicata durante il recupero di tracce da Application Insights. | NO | 168 |
| trace_ids | array | Raccolta di identificatori di traccia dell'agente da valutare. | Sì | |
| type | enum | Tipo di origine dati, sempre azure_ai_traces.Valori possibili: azure_ai_traces |
Sì |
TreatmentEffectType
Tipo di effetto del trattamento.
| Proprietà | Value |
|---|---|
| Tipo | corda |
| Valori | TooFewSamplesInconclusiveChangedImprovedDegraded |
Attivatore
Modello base per il Trigger del programma.
Discriminante per trigger
Questo componente usa la proprietà type per distinguere tra tipi diversi:
| Valore tipo | Schema |
|---|---|
Cron |
CronTrigger |
Recurrence |
RicorrenzaTrigger |
OneTime |
OneTimeTrigger |
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| type | oggetto | Tipo di trigger. | Sì |
TriggerType
Tipo di trigger.
| Proprietà | Value |
|---|---|
| Descrizione | Tipo di trigger. |
| Tipo | corda |
| Valori | CronRecurrenceOneTime |
UpdateAgentFromManifestRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| manifest_id | corda | ID manifesto da cui importare la versione dell'agente. | Sì | |
| metadata | oggetto | 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 | oggetto | Input al manifesto che genererà un agente completamente materializzato. | Sì |
UpdateAgentRequest
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| Definizione | oggetto | Sì | ||
| └* tipo | AgentKind | NO | ||
| └rai_config | RaiConfig | Configurazione per il filtraggio dei contenuti e le funzioni di sicurezza RAI (Responsible AI). | NO | |
| descrizione | corda | Una descrizione leggibile dell'agente. | NO | |
| metadata | oggetto | 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
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| 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. |
NO | |
| nome | corda | NO | ||
| proprietà | oggetto | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| tipo/gentile | enum | Il tipo di elemento della memoria. Valori possibili: user_profile |
Sì |
WeeklyRecurrenceSchedule
Pianificazione della ricorrenza settimanale.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| daysOfWeek | array | Giorni della settimana per la pianificazione della ricorrenza. | Sì | |
| type | enum | Tipo di ricorrenza settimanale. Valori possibili: Weekly |
Sì |
WorkflowActionOutputItemResource
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| action_id | corda | Identificatore univoco per l'azione. | Sì | |
| tipo/gentile | corda | Tipo di azione CSDL, ad esempio 'SetVariable', 'InvokeAzureAgent'. | Sì | |
| parent_action_id | corda | ID dell'azione padre se si tratta di un'azione nidificata. | NO | |
| previous_action_id | corda | ID dell'azione precedente se questa azione segue un'altra azione. | 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.
| Nome | TIPO | Descrzione | Obbligatorio | Default |
|---|---|---|---|---|
| tipo/gentile | enum | Valori possibili: workflow |
Sì | |
| flusso di lavoro | corda | Definizione YAML CSDL del flusso di lavoro. | NO |
numero intero
Tipo: integer
Formato: int64