Visione personalizzata di Azure AI (anteprima)

Integrare facilmente Visione personalizzata di Azure AI funzionalità nei flussi di lavoro.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio Class Regions
Copilot Studio Normale Tutte le aree Power Automate ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Normale Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - aree Azure per enti pubblici
     - Azure cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Normale Tutte le aree Power Apps ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Normale Tutte le aree Power Automate ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome Microsoft
URL https://support.microsoft.com
Metadati del connettore
Publisher Microsoft
Sito web https://learn.microsoft.com/en-us/azure/ai-services/agents/
Informativa sulla privacy https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security
Categorie IA; Business intelligence

Azure servizio agente di intelligenza artificiale è un servizio completamente gestito progettato per consentire agli sviluppatori di creare, distribuire e ridimensionare in modo sicuro agenti di intelligenza artificiale di alta qualità ed estendibili senza dover gestire le risorse di calcolo e archiviazione sottostanti. Azure servizio agente di intelligenza artificiale integra modelli, strumenti e tecnologie e consente di estendere gli agenti con conoscenze provenienti da origini connesse (ad esempio Ricerca Bing, SharePoint, Fabric, archiviazione BLOB Azure e dati concessi in licenza) e azioni usando strumenti come App per la logica di Azure, Funzioni di Azure, strumenti e interprete del codice specificati openAPI 3.0

Prerequisiti

Ottenere le credenziali

Per autenticare le richieste API, è necessario l'endpoint per le risorse del servizio IA Agent Azure.

Per la risorsa del servizio agente di intelligenza artificiale Azure:

  1. Passare alla risorsa nel portale Azure.
  2. Nella pagina della risorsa selezionare Chiavi ed endpoint nel menu di spostamento a sinistra. Prendere nota delle credenziali. Si userà una delle chiavi e l'endpoint.

Problemi noti e limitazioni

  • Solo Azure servizio agente di intelligenza artificiale è supportato come servizio agente con questo connettore Power Platform solo per app per la logica. Non per power automate e power apps

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:
Identità gestita Creare una connessione usando un'identità gestita Solo LOGICAPPS Condivisibile
Microsoft Entra ID Account di accesso utente Accedere con credenziali di Microsoft Entra ID Tutte le aree Non condivisibile
Impostazione predefinita [DEPRECATO] Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti. Tutte le aree Non condivisibile

Identità gestita

ID autenticazione: managedIdentityAuth

Applicabile: solo LOGICAPPS

Creare una connessione usando un'identità gestita

Si tratta di una connessione condivisibile. Se l'app per l'alimentazione viene condivisa con un altro utente, anche la connessione viene condivisa. Per altre informazioni, vedere la panoramica di Connectors per le app canvas - Power Apps | Microsoft Docs

Nome TIPO Description Obbligatorio
Identità gestita Identità gestita Accedere con un'identità gestita Vero
endpoint Project di intelligenza artificiale Azure corda Nome dell'endpoint Project Azure di intelligenza artificiale, ad esempio https://{nome-account}.services.ai.azure. com/api/projects/{project-name} Vero

account di accesso utente Microsoft Entra ID

ID di autenticazione: entraIDUserLogin

Applicabile: tutte le aree

Accedere con credenziali di Microsoft Entra ID

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome TIPO Description Obbligatorio
endpoint Project di intelligenza artificiale Azure corda Nome dell'endpoint Project Azure di intelligenza artificiale, ad esempio https://{nome-account}.services.ai.azure. com/api/projects/{project-name} Vero

Impostazione predefinita [DEPRECATO]

Applicabile: tutte le aree

Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Limiti per la limitazione delle richieste

Nome Chiamate Periodo di rinnovo
Chiamate API per connessione 1000 60 secondi

Azioni

Abilitare l'agente ospitato

Abilita un endpoint dell'agente ospitato in modo che possa gestire le richieste.
Aggiornare il routing dell'agente ospitato

Aggiorna l'endpoint dell'agente ospitato per instradare il 100% del traffico a una versione specifica dell'agente attivo. Le versioni bozza non possono essere destinazioni di routing.
Caricare il file di sessione ospitata

Carica il contenuto del file non elaborato in una sessione ospitata. La dimensione massima del file è 50 MB.
Crea esecuzione

Crea esecuzione
Crea thread

Crea thread
Creare la versione dell'agente ospitato

Crea una nuova versione dell'agente ospitato da un'immagine del contenitore.
Creare la versione dell'agente prompt

Crea una nuova versione dell'agente prompt usando una distribuzione del modello, istruzioni e strumenti facoltativi.
Creare un agente ospitato

Crea un agente ospitato e la relativa versione iniziale da un'immagine del contenitore.
Creare una sessione ospitata

Crea una sessione dell'agente ospitato. Facoltativamente, selezionare una versione specifica dell'agente; in caso contrario, la configurazione di routing dell'agente ospitato seleziona la versione.
Disabilitare l'agente ospitato

Disabilita un endpoint dell'agente ospitato senza eliminare l'agente o le relative versioni.
Elenca agenti

Elenca agenti
Elenca messaggi

Elenca messaggi
Elencare gli agenti (servizio agente)

Elencare gli agenti dal servizio Agent
Elencare i file di sessione ospitati

Elenca file e directory in un percorso in una sessione ospitata.
Elencare le sessioni ospitate

Elenca le sessioni ospitate per un agente accessibile al chiamante.
Elencare le versioni dell'agente

Elenca le versioni di un agente.
Elimina agente

Elimina definitivamente un agente e tutte le relative versioni. Per gli agenti ospitati, le sessioni attive causano un conflitto a meno che l'eliminazione forzata non sia abilitata.
Elimina file di sessione ospitata

Elimina un file o una directory da una sessione ospitata.
Elimina sessione ospitata

Elimina una sessione dell'agente ospitato, termina la sandbox e rilascia le relative risorse.
Eliminare la versione dell'agente

Elimina definitivamente una versione specifica dell'agente. Per gli agenti ospitati, le sessioni attive causano un conflitto a meno che l'eliminazione forzata non sia abilitata.
Esegui

Esegui
Ottenere la versione dell'agente

Ottiene una versione specifica di un agente.
Ottenere una sessione ospitata

Ottiene una sessione dell'agente ospitato in base al relativo identificatore di sessione.
Ottieni l'agente

Ottiene un agente e la versione più recente.
Richiamare l'agente di richiesta

Richiama un agente di richiesta.
Richiamare l'agente ospitato (chiamate)

Richiama un agente ospitato che espone il protocollo Chiamate. Il codice JSON di richiesta e risposta è definito dall'implementazione dell'agente ospitato.
Richiamare l'agente ospitato (risposte)

Richiama un agente ospitato che espone il protocollo Responses. L'azione usa risposte JSON non in streaming.
Scaricare il file di sessione ospitata

Scarica il contenuto binario di un file da una sessione ospitata.

Abilitare l'agente ospitato

ID operazione:
EnableHostedAgent

Abilita un endpoint dell'agente ospitato in modo che possa gestire le richieste.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.

Aggiornare il routing dell'agente ospitato

ID operazione:
UpdateHostedAgentRouting

Aggiorna l'endpoint dell'agente ospitato per instradare il 100% del traffico a una versione specifica dell'agente attivo. Le versioni bozza non possono essere destinazioni di routing.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Versione agente
 agent_version True string

Versione dell'agente attiva e non bozza che riceve il traffico dell'endpoint.

Valori restituiti

Corpo
AgentRecord

Caricare il file di sessione ospitata

ID operazione:
UploadHostedSessionFile

Carica il contenuto del file non elaborato in una sessione ospitata. La dimensione massima del file è 50 MB.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
ID della sessione
 SessionId True string

Identificatore di sessione ospitato.
Percorso del file
 path True string

Percorso del file o della directory nella sessione ospitata.
Contenuto del file
 body True binary

Contenuto binario del file da caricare.

Valori restituiti

Corpo
HostedSessionFileUploadResponse

Crea esecuzione

ID operazione:
CreateRun

Crea esecuzione

Parametri

Nome Chiave Necessario Tipo Descrizione
Versione dell'API
 api-version True string

Versione dell'API
ID del thread per cui creare un messaggio.
 ThreadId True string

ID del thread per cui creare un messaggio.
assistant_id
 assistant_id True string

ID dell'assistente da usare per eseguire questa esecuzione.
model
 model string

Nome della distribuzione del modello da usare per eseguire questa esecuzione. Se specificato, esegue l'override del nome della distribuzione del modello dell'assistente.
instructions
 instructions string

Esegue l'override delle istruzioni dell'assistente. Utile per modificare il comportamento in base all'esecuzione.
additional_instructions
 additional_instructions string

Aggiunge istruzioni aggiuntive alla fine delle istruzioni per l'esecuzione.
ruolo
 role string

Ruolo dell'entità che crea il messaggio. Può essere utente o assistente. 'user' indica che il messaggio viene inviato da un utente effettivo e deve essere usato nella maggior parte dei casi per rappresentare i messaggi generati dall'utente. 'assistant' indica che il messaggio viene generato dall'assistente. Usare questo valore per inserire messaggi dall'assistente nella conversazione.
contenuto
 content string

Il contenuto del messaggio.
nome
 name string

Elenco di ID file o messaggi che possono essere usati nell'esecuzione.
metadata
 metadata object

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. Le chiavi possono essere lunghe al massimo 64 caratteri, mentre i valori al massimo 512 caratteri.
nome
 name string

Elenco di strumenti che possono essere usati nell'esecuzione.
metadata
 metadata object

Set di 16 coppie chiave-valore associate a un oggetto . Lunghezza massima chiavi: 64 caratteri, Lunghezza massima valori: 512 caratteri.
temperatura
 temperature number

Temperatura di campionamento (0-2). I valori più alti (ad esempio, 0,8) aumentano la casualità, i valori inferiori (ad esempio, 0,2) rendono l'output più deterministico.
top_p
 top_p number

Campionamento del nucleo alternativo alla temperatura. 0,1 indica che i primi 10% massa di probabilità viene considerata.
torrente
 stream boolean

Se true, restituisce un flusso di eventi durante l'esecuzione come eventi inviati dal server, terminando con un messaggio "data: [DONE]".
max_prompt_tokens
 max_prompt_tokens integer

Numero massimo di token di completamento che possono essere usati durante l'esecuzione. Se superato, l'esecuzione termina come incompleta.
max_completion_tokens
 max_completion_tokens integer

Numero massimo di token di completamento che possono essere usati durante l'esecuzione. Se superato, l'esecuzione termina come incompleta.
truncation_strategy
 truncation_strategy object

Controlla il modo in cui un thread viene troncato prima dell'esecuzione per gestire la finestra di contesto iniziale.
tool_choice
 tool_choice

Controlla quale strumento chiama il modello. L'impostazione predefinita è "auto", consentendo al modello di decidere. Può essere impostato su "nessuno" per disabilitare l'utilizzo degli strumenti.
formato_risposta
 response_format object

Specifica il formato di output. L'impostazione di { 'type': 'json_object' } abilita la modalità JSON per le risposte JSON valide.

Valori restituiti

Corpo
createRunResponse

Crea thread

ID operazione:
CreateThread

Crea thread

Parametri

Nome Chiave Necessario Tipo Descrizione
Versione dell'API
 api-version True string

Versione dell'API
ruolo
 role string

Ruolo dell'entità che crea il messaggio. Può essere utente o assistente. 'user' indica che il messaggio viene inviato da un utente effettivo e deve essere usato nella maggior parte dei casi per rappresentare i messaggi generati dall'utente. 'assistant' indica che il messaggio viene generato dall'assistente. Usare questo valore per inserire messaggi dall'assistente nella conversazione.
contenuto
 content string

Il contenuto del messaggio.
nome
 name string

Elenco di ID file o messaggi che possono essere usati nell'esecuzione.
metadata
 metadata object

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. Le chiavi possono essere lunghe al massimo 64 caratteri, mentre i valori al massimo 512 caratteri.
metadata
 metadata object

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. Le chiavi possono essere lunghe al massimo 64 caratteri, mentre i valori al massimo 512 caratteri.
tool_resources
 tool_resources object

Set di risorse rese disponibili per gli strumenti dell'assistente in questo thread. Le risorse sono specifiche del tipo di strumento. Ad esempio, lo strumento code_interpreter richiede un elenco di ID file, mentre lo strumento file_search richiede un elenco di ID archivio vettoriali.

Valori restituiti

Corpo
createThreadResponse

Creare la versione dell'agente ospitato

ID operazione:
CreateHostedAgentVersion

Crea una nuova versione dell'agente ospitato da un'immagine del contenitore.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Description
 description string

Descrizione leggibile della versione dell'agente ospitato.
Metadata
 metadata object

Metadati da associare alla versione dell'agente ospitato.
Crea come bozza
 draft boolean

Indica se creare una versione bozza. Le versioni bozza sono escluse dal normale routing e dalle liste.
Immagine del contenitore
 image True string

Riferimento completo all'immagine del contenitore, ad esempio myregistry.azurecr.io/my-agent:v1.
ID connessione del Registro di sistema
 registry_connection_id string

Identificatore di connessione del progetto Foundry per il registro contenitori, se necessario.
CPU (unità centrale di elaborazione)
 cpu True string

Numero di core CPU richiesti per il contenitore dell'agente ospitato, ad esempio 1.
Memory
 memory True string

Quantità di memoria richiesta per il contenitore dell'agente ospitato, ad esempio 2Gi.
Protocol
 protocol True string

Protocollo esposto dall'agente ospitato. Selezionare Risposte o Chiamate.
Variabili di ambiente
 environment_variables object

Variabili di ambiente passate al contenitore dell'agente ospitato.
Configurazione dell'intelligenza artificiale responsabile
 rai_config object

Configurazione facoltativa del filtro del contenuto per intelligenza artificiale responsabile.
Configurazione della telemetria
 telemetry_config object

Configurazione di telemetria facoltativa.
Configurazione della sessione
 session_configuration object

Configurazione della sessione dell'agente ospitato facoltativa.

Valori restituiti

Corpo
AgentVersionRecord

Creare la versione dell'agente prompt

ID operazione:
CreatePromptAgentVersion

Crea una nuova versione dell'agente prompt usando una distribuzione del modello, istruzioni e strumenti facoltativi.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Description
 description string

Descrizione leggibile della versione dell'agente di richiesta.
Metadata
 metadata object

Metadati da associare alla versione dell'agente di richiesta.
Crea come bozza
 draft boolean

Indica se creare una versione bozza.
Implementazione del modello
 model True string

Nome di una distribuzione del modello disponibile nel progetto Foundry corrente. I nomi dei modelli diretti di Foundry supportati possono anche essere immessi manualmente.
Instructions
 instructions string

Istruzioni di sistema che definiscono il comportamento dell'agente del prompt.
Tools
 Tools object
Scelta degli strumenti
 tool_choice

Controlla il modo in cui l'agente del prompt seleziona gli strumenti.
Temperatura
 temperature float

Temperatura di campionamento compresa tra 0 e 2.
P superiore
 top_p float

Probabilità di campionamento del nucleo compresa tra 0 e 1.
Configurazione del testo
 text object

Configurazione facoltativa di testo e output strutturato.
Configurazione del ragionamento
 reasoning object

Configurazione di ragionamento facoltativa per i modelli supportati.
Competenze
 Skills object
Input strutturati
 structured_inputs object

Definizioni di input strutturate facoltative.
Imbracatura
 harness object

Configurazione facoltativa dell'harness dell'agente.

Valori restituiti

Corpo
AgentVersionRecord

Creare un agente ospitato

ID operazione:
CreateHostedAgent

Crea un agente ospitato e la relativa versione iniziale da un'immagine del contenitore.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 name True string

Nome dell'agente ospitato.
Description
 description string

Descrizione leggibile dell'agente ospitato.
Metadata
 metadata object

Metadati da associare all'agente ospitato.
Immagine del contenitore
 image True string

Riferimento completo all'immagine del contenitore, ad esempio myregistry.azurecr.io/my-agent:v1.
ID connessione del Registro di sistema
 registry_connection_id string

Identificatore di connessione del progetto Foundry per il registro contenitori, se necessario.
CPU (unità centrale di elaborazione)
 cpu True string

Numero di core CPU richiesti per il contenitore dell'agente ospitato, ad esempio 1.
Memory
 memory True string

Quantità di memoria richiesta per il contenitore dell'agente ospitato, ad esempio 2Gi.
Protocol
 protocol True string

Protocollo esposto dall'agente ospitato. Selezionare Risposte o Chiamate.
Variabili di ambiente
 environment_variables object

Variabili di ambiente passate al contenitore dell'agente ospitato.
Configurazione dell'intelligenza artificiale responsabile
 rai_config object

Configurazione facoltativa del filtro del contenuto per intelligenza artificiale responsabile.
Configurazione della telemetria
 telemetry_config object

Configurazione di telemetria facoltativa.
Configurazione della sessione
 session_configuration object

Configurazione della sessione dell'agente ospitato facoltativa.

Valori restituiti

Corpo
AgentVersionRecord

Creare una sessione ospitata

ID operazione:
CreateHostedSession

Crea una sessione dell'agente ospitato. Facoltativamente, selezionare una versione specifica dell'agente; in caso contrario, la configurazione di routing dell'agente ospitato seleziona la versione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
Versione agente
 agent_version string

Versione specifica dell'agente ospitato per la sessione. Lasciare vuoto per usare la configurazione di routing dell'agente ospitato.

Valori restituiti

Corpo
HostedSession

Disabilitare l'agente ospitato

ID operazione:
DisableHostedAgent

Disabilita un endpoint dell'agente ospitato senza eliminare l'agente o le relative versioni.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.

Elenca agenti

ID operazione:
ListAgents

Elenca agenti

Parametri

Nome Chiave Necessario Tipo Descrizione
Versione dell'API
 api-version True string

Versione dell'API

Valori restituiti

Corpo
listAgentsResponse

Elenca messaggi

ID operazione:
ListMessages

Elenca messaggi

Parametri

Nome Chiave Necessario Tipo Descrizione
Versione dell'API
 api-version True string

Versione dell'API
ID del thread per cui creare un messaggio.
 ThreadId True string

ID del thread per cui creare un messaggio.

Valori restituiti

Corpo
listMessageResponse

Elencare gli agenti (servizio agente)

ID operazione:
ListAgentsFromService

Elencare gli agenti dal servizio Agent

Valori restituiti

Corpo
listAgentsServiceResponse

Elencare i file di sessione ospitati

ID operazione:
ListHostedSessionFiles

Elenca file e directory in un percorso in una sessione ospitata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
ID della sessione
 SessionId True string

Identificatore di sessione ospitato.
Percorso directory
 path string

Percorso della directory da elencare. Il valore predefinito è la directory corrente della sessione.

Valori restituiti

Corpo
HostedSessionFileListResponse

Elencare le sessioni ospitate

ID operazione:
ListHostedSessions

Elenca le sessioni ospitate per un agente accessibile al chiamante.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.

Valori restituiti

Corpo
HostedSessionListResponse

Elencare le versioni dell'agente

ID operazione:
ListAgentVersions

Elenca le versioni di un agente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Includi versioni bozza
 include_drafts boolean

Indica se includere versioni bozza. Il servizio esclude le bozze per impostazione predefinita.
Limit
 limit integer

Numero massimo di versioni da restituire.
Order
 order string

Ordinare l'ordinamento in base al timestamp created_at.
Dopo il cursore
 after string

Restituisce versioni successive a questo cursore.
Prima del cursore
 before string

Restituire versioni prima di questo cursore.

Valori restituiti

Corpo
AgentVersionListResponse

Elimina agente

ID operazione:
DeleteAgent

Elimina definitivamente un agente e tutte le relative versioni. Per gli agenti ospitati, le sessioni attive causano un conflitto a meno che l'eliminazione forzata non sia abilitata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Forza l'eliminazione
 force boolean

Per gli agenti ospitati, eliminare le sessioni attive associate all'agente o alla versione.

Elimina file di sessione ospitata

ID operazione:
DeleteHostedSessionFile

Elimina un file o una directory da una sessione ospitata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
ID della sessione
 SessionId True string

Identificatore di sessione ospitato.
Percorso del file
 path True string

Percorso del file o della directory nella sessione ospitata.

Elimina sessione ospitata

ID operazione:
DeleteHostedSession

Elimina una sessione dell'agente ospitato, termina la sandbox e rilascia le relative risorse.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
ID della sessione
 SessionId True string

Identificatore di sessione ospitato.

Eliminare la versione dell'agente

ID operazione:
DeleteAgentVersion

Elimina definitivamente una versione specifica dell'agente. Per gli agenti ospitati, le sessioni attive causano un conflitto a meno che l'eliminazione forzata non sia abilitata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Versione agente
 AgentVersion True string

Identificatore della versione dell'agente.
Forza l'eliminazione
 force boolean

Per gli agenti ospitati, eliminare le sessioni attive associate all'agente o alla versione.

Esegui

ID operazione:
GetRun

Esegui

Parametri

Nome Chiave Necessario Tipo Descrizione
Versione dell'API
 api-version True string

Versione dell'API
ID del thread per cui creare un messaggio.
 ThreadId True string

ID del thread per cui creare un messaggio.
ID dell'esecuzione.
 RunId True string

ID dell'esecuzione.

Valori restituiti

Corpo
getRunResponse

Ottenere la versione dell'agente

ID operazione:
GetAgentVersion

Ottiene una versione specifica di un agente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Versione agente
 AgentVersion True string

Identificatore della versione dell'agente.

Valori restituiti

Corpo
AgentVersionRecord

Ottenere una sessione ospitata

ID operazione:
GetHostedSession

Ottiene una sessione dell'agente ospitato in base al relativo identificatore di sessione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
ID della sessione
 SessionId True string

Identificatore di sessione ospitato.

Valori restituiti

Corpo
HostedSession

Ottieni l'agente

ID operazione:
GetAgentFromService

Ottiene un agente e la versione più recente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.

Valori restituiti

Corpo
AgentRecord

Richiamare l'agente di richiesta

ID operazione:
InvokeAgent

Richiama un agente di richiesta.

Parametri

Nome Chiave Necessario Tipo Descrizione
Versione dell'API
 api-version True string

Versione dell'API
metadata
 metadata object

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.
utente
 user string

Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. Ulteriori informazioni.
top_logprobs
 top_logprobs integer

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.
previous_response_id
 previous_response_id string

ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni sullo stato della conversazione.
sfondo
 background boolean

Indica se eseguire la risposta del modello in background. Ulteriori informazioni.
max_output_tokens
 max_output_tokens integer

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.
max_tool_calls
 max_tool_calls integer

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.
type
 type True string

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 Guida agli output strutturati.

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.
type
 type True string

Strumento che può essere usato per generare una risposta.
tool_choice
 tool_choice

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

Identificatore univoco del modello di richiesta da utilizzare.
version
 version string

Versione facoltativa del modello di richiesta.
variables
 variables object

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.
truncation
 truncation string

Strategia di troncamento da usare per la risposta del modello.

  • auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
  • disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
ingresso
 input

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

Ulteriori informazioni:
include
 include string

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 il store parametro è impostato su falseo quando un'organizzazione viene registrata nel programma di conservazione dei dati zero).
chiamate_parallele_agli_strumenti
 parallel_tool_calls boolean

Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.
store
 store boolean

Indica se archiviare la risposta del modello generata per il recupero successivo tramite API.
instructions
 instructions string

Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme a previous_response_id, le istruzioni di una risposta precedente non saranno trasferite alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.
ID conversazione
 id True string

ID conversazione. Selezionare "Crea nuova conversazione" per creare una nuova conversazione.
type
 type True string
nome
 name True string

Nome dell'agente.
version
 version True string

Identificatore della versione dell'agente.

Valori restituiti

Corpo
OpenAI.Response

Richiamare l'agente ospitato (chiamate)

ID operazione:
InvokeHostedAgentInvocations

Richiama un agente ospitato che espone il protocollo Chiamate. Il codice JSON di richiesta e risposta è definito dall'implementazione dell'agente ospitato.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
object

Payload JSON previsto dal gestore chiamate dell'agente ospitato.

Valori restituiti

response
object

Richiamare l'agente ospitato (risposte)

ID operazione:
InvokeHostedAgentResponses

Richiama un agente ospitato che espone il protocollo Responses. L'azione usa risposte JSON non in streaming.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Input
 input True

Testo, immagine, file o input strutturato per l'agente ospitato.
ID risposta precedente
 previous_response_id string

Identificatore di risposta precedente per continuare un'interazione a più turni.
Instructions
 instructions string

Istruzioni aggiuntive per questa risposta.
Risposta dell'archivio
 store boolean

Indica se archiviare la risposta per il recupero successivo.
Esecuzione in background
 background boolean

Indica se eseguire la risposta in background.
Numero massimo di token di output
 max_output_tokens integer

Numero massimo di token di output.
Metadata
 metadata object

Metadati da associare alla risposta.
User
 user string

Identificatore univoco per l'utente finale.

Valori restituiti

Corpo
OpenAI.Response

Scaricare il file di sessione ospitata

ID operazione:
DownloadHostedSessionFile

Scarica il contenuto binario di un file da una sessione ospitata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Nome agente
 AgentName True string

Nome dell'agente.
Chiave di isolamento utente
 x-ms-user-isolation-key string

Chiave di partizionamento facoltativa per gli agenti ospitati configurati con isolamento sessione basato su intestazione. Usare lo stesso valore per ogni operazione nella sessione. Questa chiave non fornisce l'autenticazione.
ID della sessione
 SessionId True string

Identificatore di sessione ospitato.
Percorso del file
 path True string

Percorso del file o della directory nella sessione ospitata.

Valori restituiti

Contenuto del file di sessione ospitato.

Contenuto del file
binary

Definizioni

listAgentsResponse

Nome Percorso Tipo Descrizione
oggetto
 object string

Dettagli del tipo di oggetto risposta.
data
 data array of Data

Elenco di messaggi restituiti dal servizio.
first_id
 first_id string

Dettagli del primo ID.
last_id
 last_id string

Dettagli dell'ultimo ID.
ha_di_piu
 has_more boolean

Indica se sono presenti più agenti.

listAgentsServiceResponse

Nome Percorso Tipo Descrizione
data
 data array of AgentServiceData

Elenco di agenti restituiti dal servizio.

AgentServiceData

Nome Percorso Tipo Descrizione
id
 id string

Identificatore univoco dell'agente.
nome
 name string

Nome dell'agente.
descrizione
 description string

Descrizione dell'agente.
version
 version string

Versione dell'agente.
createdAt
 createdAt date-time

Al momento della creazione dell'agente.

AgentRecord

Nome Percorso Tipo Descrizione
oggetto
 object string

Tipo dell'oggetto.
id
 id string

Identificatore univoco dell'agente.
nome
 name string

Nome dell'agente.
state
 state string

Lo stato operativo dell'agente.
configuration_state
 configuration_state string

Stato di configurazione dell'agente.
state_source
 state_source string

Origine dello stato corrente.
versions
 versions AgentRecordVersions
agent_endpoint
 agent_endpoint object

Configurazione dell'endpoint per l'agente.
digital_worker_type
 digital_worker_type string

Tipo di ruolo di lavoro digitale, se applicabile.
instance_identity
 instance_identity object

Identità dell'istanza dell'agente.
planimetria
 blueprint object

Identità del progetto dell'agente.
blueprint_reference
 blueprint_reference object

Il riferimento del progetto per l'agente.
agent_card
 agent_card object

Scheda agente, se disponibile.

AgentRecordVersions

Nome Percorso Tipo Descrizione
più recente
 latest AgentVersionRecord

AgentVersionRecord

Nome Percorso Tipo Descrizione
metadata
 metadata object

Metadati associati alla versione dell'agente.
oggetto
 object string

Tipo dell'oggetto.
id
 id string

Identificatore univoco della versione dell'agente.
nome
 name string

Nome dell'agente.
version
 version string

L'identificatore di versione.
descrizione
 description string

Descrizione leggibile della versione dell'agente.
creato_il
 created_at integer

Timestamp Unix, in secondi, quando è stata creata la versione dell'agente.
Definizione
 definition object

Definizione dell'agente.
draft
 draft boolean

Indica se si tratta di una versione bozza.
status
 status string

Lo stato di provisioning della versione agente.
instance_identity
 instance_identity object

Identità dell'istanza della versione dell'agente.
planimetria
 blueprint object

Identità del progetto della versione dell'agente.
blueprint_reference
 blueprint_reference object

Informazioni di riferimento sul progetto per la versione dell'agente.
agent_guid
 agent_guid string

L'identificatore GUID univoco dell'agente.

AgentVersionListResponse

Nome Percorso Tipo Descrizione
oggetto
 object string

Tipo dell'oggetto.
data
 data array of AgentVersionRecord

Elenco delle versioni dell'agente restituite dal servizio.
first_id
 first_id string

Primo identificatore dell'oggetto nella pagina.
last_id
 last_id string

Ultimo identificatore dell'oggetto nella pagina.
ha_di_piu
 has_more boolean

Indica se sono disponibili più risultati.

HostedSession

Nome Percorso Tipo Descrizione
agent_session_id
 agent_session_id string

Identificatore di sessione ospitato.
version_indicator
 version_indicator HostedSessionVersionIndicator
status
 status string

Stato della sessione corrente.
creato_il
 created_at integer

Timestamp Unix, in secondi, quando è stata creata la sessione.
last_accessed_at
 last_accessed_at integer

Timestamp Unix, in secondi, quando è stato eseguito l'ultimo accesso alla sessione.
scade_il
 expires_at integer

Timestamp Unix, espresso in secondi, alla scadenza della sessione.
stopped_at
 stopped_at integer

Timestamp Unix, espresso in secondi, quando la sessione è stata arrestata, se applicabile.

HostedSessionVersionIndicator

Nome Percorso Tipo Descrizione
type
 type string

Tipo di indicatore di selezione della versione.
agent_version
 agent_version string

Versione dell'agente ospitato assegnata alla sessione.

HostedSessionListResponse

Nome Percorso Tipo Descrizione
data
 data array of HostedSession

Sessioni ospitate restituite dal servizio.
first_id
 first_id string

Primo identificatore di sessione ospitato nella pagina.
last_id
 last_id string

Ultimo identificatore di sessione ospitata nella pagina.
ha_di_piu
 has_more boolean

Indica se sono disponibili più sessioni ospitate.

HostedSessionFileUploadResponse

Nome Percorso Tipo Descrizione
path
 path string

Percorso del file caricato.
bytes_written
 bytes_written integer

Numero di byte scritti.
esito positivo
 success boolean

Indica se il caricamento è riuscito.
tipo_sorgente
 source_type string

Tipo di origine utilizzato per il caricamento.

HostedSessionFileListResponse

Nome Percorso Tipo Descrizione
path
 path string

Percorso della directory elencato.
voci
 entries array of HostedSessionFileEntry

File e directory nel percorso richiesto.
ha_di_piu
 has_more boolean

Indica se sono disponibili più voci.

HostedSessionFileEntry

Nome Percorso Tipo Descrizione
nome
 name string

Nome del file o della directory.
size
 size integer

Dimensioni del file in byte.
is_directory
 is_directory boolean

Indica se l'elemento è una directory.
modified_time
 modified_time integer

Ora di modifica della voce, come indicato dalla sessione ospitata.

createThreadResponse

Nome Percorso Tipo Descrizione
id
 id string

Identificatore a cui è possibile fare riferimento negli endpoint API.
oggetto
 object string

Tipo di oggetto, che è sempre thread.
creato_il
 created_at integer

Timestamp Unix (in secondi) di quando è stato creato il thread.
metadata
 metadata object

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. Le chiavi possono essere lunghe al massimo 64 caratteri, mentre i valori al massimo 512 caratteri.

createRunResponse

Nome Percorso Tipo Descrizione
id
 id string

Identificatore a cui è possibile fare riferimento negli endpoint API.
oggetto
 object string

Tipo di oggetto, che è sempre thread.run.
creato_il
 created_at integer

Timestamp Unix (in secondi) di quando è stata creata l’enumerazione.
thread_id
 thread_id string

ID del thread eseguito in come parte di questa esecuzione.
assistant_id
 assistant_id string

ID dell'assistente utilizzato per l'esecuzione di questa esecuzione.
status
 status string

Stato dell'esecuzione, che può essere accodato, in_progress, requires_action, annullamento, annullato, non riuscito, completato o scaduto.
required_action
 required_action object

Dettagli sull'azione necessaria per continuare l'esecuzione. Sarà Null se non è necessaria alcuna azione.
errore_ultimo
 last_error object

Ultimo errore associato a questa esecuzione. Sarà Null se non sono presenti errori.
scade_il
 expires_at integer

Timestamp Unix (in secondi) di quando scadrà l’esecuzione.
started_at
 started_at integer

Timestamp Unix (in secondi) di quando è stata avviata l’esecuzione.
cancelled_at
 cancelled_at integer

Timestamp Unix (in secondi) per quando l'esecuzione è stata annullata.
failed_at
 failed_at integer

Timestamp Unix (in secondi) di quando è stato riscontrato un errore con l’esecuzione.
completed_at
 completed_at integer

Timestamp Unix (in secondi) di quando è stata completata l’esecuzione.
model
 model string

Nome della distribuzione del modello usato dall'assistente per questa esecuzione.
instructions
 instructions string

Le istruzioni che l’assistente ha utilizzato per questa esecuzione.
strumenti
 tools array of tools

L’elenco di strumenti che l’assistente ha utilizzato per questa esecuzione.
identificatori_di_file
 file_ids array of fileIds

Elenco di ID file usati dall'assistente per questa esecuzione.
metadata
 metadata object

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto. Le chiavi possono contenere un massimo di 64 caratteri e i valori possono contenere un massimo di 512 caratteri.
tool_choice
 tool_choice

Controlla quale strumento (se presente) viene chiamato dal modello. 'none' indica che il modello non chiamerà alcun strumento e genera invece un messaggio. "auto" indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno strumento. Specificando uno strumento come {'type': 'file_search'} o {'type': 'function', 'function': {'name': 'my_function'}} forza il modello a chiamare tale strumento.
max_prompt_tokens
 max_prompt_tokens number

Numero massimo di token di richiesta che devono essere usati durante l'esecuzione.
max_completion_tokens
 max_completion_tokens number

Numero massimo di token di completamento che devono essere usati durante l'esecuzione.
usage
 usage object

Statistiche di utilizzo relative all’esecuzione. Questo valore sarà Null se l'esecuzione non è in uno stato del terminale (ad esempio, in_progress, accodato).
truncation_strategy
 truncation_strategy object

Controlla il modo in cui un thread viene troncato prima dell'esecuzione.
formato_risposta
 response_format string

Formato che il modello deve restituire. Compatibile con GPT-4 Turbo e tutti i modelli GPT-3.5 Turbo da gpt-3.5-turbo-1106.

getRunResponse

Nome Percorso Tipo Descrizione
id
 id string

Identificatore a cui è possibile fare riferimento negli endpoint API.
oggetto
 object string

Tipo di oggetto, che è sempre thread.run.
creato_il
 created_at integer

Timestamp Unix (in secondi) di quando è stata creata l’enumerazione.
thread_id
 thread_id string

ID del thread eseguito in come parte di questa esecuzione.
assistant_id
 assistant_id string

ID dell'assistente utilizzato per l'esecuzione di questa esecuzione.
status
 status string

Stato dell'esecuzione, che può essere accodato, in_progress, requires_action, annullamento, annullato, non riuscito, completato o scaduto.
required_action
 required_action object

Dettagli sull'azione necessaria per continuare l'esecuzione. Sarà Null se non è necessaria alcuna azione.
errore_ultimo
 last_error object

Ultimo errore associato a questa esecuzione. Sarà Null se non sono presenti errori.
scade_il
 expires_at integer

Timestamp Unix (in secondi) di quando scadrà l’esecuzione.
started_at
 started_at integer

Timestamp Unix (in secondi) di quando è stata avviata l’esecuzione.
cancelled_at
 cancelled_at integer

Timestamp Unix (in secondi) per quando l'esecuzione è stata annullata.
failed_at
 failed_at integer

Timestamp Unix (in secondi) di quando è stato riscontrato un errore con l’esecuzione.
completed_at
 completed_at integer

Timestamp Unix (in secondi) di quando è stata completata l’esecuzione.
model
 model string

Nome della distribuzione del modello usato dall'assistente per questa esecuzione.
instructions
 instructions string

Le istruzioni che l’assistente ha utilizzato per questa esecuzione.
strumenti
 tools array of tools

L’elenco di strumenti che l’assistente ha utilizzato per questa esecuzione.
identificatori_di_file
 file_ids array of fileIds

Elenco di ID file usati dall'assistente per questa esecuzione.
metadata
 metadata object

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto. Le chiavi possono contenere un massimo di 64 caratteri e i valori possono contenere un massimo di 512 caratteri.
tool_choice
 tool_choice

Controlla quale strumento (se presente) viene chiamato dal modello. 'none' indica che il modello non chiamerà alcun strumento e genera invece un messaggio. "auto" indica che il modello può scegliere tra la generazione di un messaggio o la chiamata di uno strumento. Specificando uno strumento come {'type': 'file_search'} o {'type': 'function', 'function': {'name': 'my_function'}} forza il modello a chiamare tale strumento.
max_prompt_tokens
 max_prompt_tokens number

Numero massimo di token di richiesta che devono essere usati durante l'esecuzione.
max_completion_tokens
 max_completion_tokens number

Numero massimo di token di completamento che devono essere usati durante l'esecuzione.
usage
 usage object

Statistiche di utilizzo relative all’esecuzione. Questo valore sarà Null se l'esecuzione non è in uno stato del terminale (ad esempio, in_progress, accodato).
truncation_strategy
 truncation_strategy object

Controlla il modo in cui un thread viene troncato prima dell'esecuzione.
formato_risposta
 response_format string

Formato che il modello deve restituire. Compatibile con GPT-4 Turbo e tutti i modelli GPT-3.5 Turbo da gpt-3.5-turbo-1106.

listMessageResponse

Nome Percorso Tipo Descrizione
oggetto
 object string

Dettagli del tipo di oggetto risposta
data
 data array of Data

Elenco di messaggi restituiti dal servizio.
first_id
 first_id string

Dettagli del primo ID
last_id
 last_id string

Dettagli dell'ultimo ID
ha_di_piu
 has_more boolean

Indica se sono presenti più agenti

Data

Nome Percorso Tipo Descrizione
id
 id string

Identificatore a cui è possibile fare riferimento negli endpoint API.
oggetto
 object string

Tipo di oggetto, che è sempre assistente.
creato_il
 created_at integer

Timestamp Unix (in secondi) di quando è stato creato l’assistente.
nome
 name string

Il nome dell’argomento. La lunghezza massima consentita è di 256 caratteri.
descrizione
 description string

Descrizione dell'assistente. La lunghezza massima è di 512 caratteri.
model
 model string

Nome del nome della distribuzione del modello da usare.
instructions
 instructions string

Istruzioni di sistema usate dall'assistente. La lunghezza massima è di 32768 caratteri.
strumenti
 tools array of tools

Elenco degli strumenti abilitati nell'assistente. Può essere disponibile un massimo di 128 strumenti per assistente. Gli strumenti possono essere di tipi code_interpreter o funzione. Una descrizione della funzione può essere un massimo di 1.024 caratteri.
metadata
 metadata object

Set di 16 coppie chiave-valore che possono essere collegate a un oggetto. Utile per archiviare informazioni aggiuntive in un formato strutturato. Le chiavi possono contenere un massimo di 64 caratteri e i valori possono contenere un massimo di 512 caratteri.
temperatura
 temperature number

Il valore predefinito è 1. Determina la 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.
top_p
 top_p number

Il valore predefinito è 1. Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%.
formato_risposta
 response_format object

Specifica il formato che il modello deve restituire. L'impostazione di questo parametro su { 'type': 'json_object' } abilita la modalità JSON, verificando che il messaggio sia JSON valido.
tool_resources
 tool_resources object

Set di risorse usate dagli strumenti dell'assistente. Le risorse sono specifiche del tipo di strumento. Ad esempio, lo strumento code_interpreter richiede un elenco di ID file, mentre lo strumento file_search richiede un elenco di ID archivio vettoriali.

OpenAI.ServiceTier

Specifica il tipo di elaborazione utilizzato per gestire la richiesta.

  • Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni di Project. Se non diversamente configurato, il Project userà 'default'.
  • Se impostato su 'default', la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato.
  • Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. 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 .

Specifica il tipo di elaborazione utilizzato per gestire la richiesta.

  • Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni di Project. Se non diversamente configurato, il Project userà 'default'.
  • Se impostato su 'default', la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato.
  • Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. 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 .

string

OpenAI.Reasoning

Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.

Nome Percorso Tipo Descrizione
effort
 effort string
summary
 summary string

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.
generate_summary
 generate_summary string

Deprecato: usare summary invece.

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.

OpenAI.ResponseTextFormatConfiguration

Nome Percorso Tipo Descrizione
type
 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 Guida agli output strutturati.

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.

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 Guida agli output strutturati.

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.

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 Guida agli output strutturati.

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.

string

OpenAI.Tool

Nome Percorso Tipo Descrizione
type
 type OpenAI.ToolType

Strumento che può essere usato per generare una risposta.

OpenAI.ToolType

Strumento che può essere usato per generare una risposta.

Strumento che può essere usato per generare una risposta.

string

OpenAI.Prompt

Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni.

Nome Percorso Tipo Descrizione
id
 id string

Identificatore univoco del modello di richiesta da utilizzare.
version
 version string

Versione facoltativa del modello di richiesta.
variables
 variables 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.

OpenAI.Response

Nome Percorso Tipo Descrizione
metadata
 metadata object

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.
temperatura
 temperature float

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.
top_p
 top_p float

Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%.

In genere si consiglia di modificare questo valore o temperature ma non entrambi.
utente
 user string

Identificatore univoco che rappresenta l'utente finale, che consente a OpenAI di monitorare e rilevare gli abusi. Ulteriori informazioni.
livello_servizio
 service_tier OpenAI.ServiceTier

Specifica il tipo di elaborazione utilizzato per gestire la richiesta.

  • Se impostato su "auto", la richiesta verrà elaborata con il livello di servizio configurato nelle impostazioni di Project. Se non diversamente configurato, il Project userà 'default'.
  • Se impostato su 'default', la richiesta verrà elaborata con i prezzi e le prestazioni standard per il modello selezionato.
  • Se impostato su "flex" o "priority", la richiesta verrà elaborata con il livello di servizio corrispondente. 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 .
top_logprobs
 top_logprobs integer

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.
previous_response_id
 previous_response_id string

ID univoco della risposta precedente al modello. Usare questa opzione per creare conversazioni a più turni. Altre informazioni sullo stato della conversazione.
model
 model string

Il modello di distribuzione da utilizzare per la creazione di questa risposta.
reasoning
 reasoning OpenAI.Reasoning

Solo modelli di serie o

Opzioni di configurazione per i modelli di ragionamento.
sfondo
 background boolean

Indica se eseguire la risposta del modello in background. Ulteriori informazioni.
max_output_tokens
 max_output_tokens integer

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.
max_tool_calls
 max_tool_calls integer

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.
format
 text.format OpenAI.ResponseTextFormatConfiguration
strumenti
 tools array of OpenAI.Tool

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

Le due categorie di strumenti che è possibile fornire al modello sono:

  • Strumenti predefiniti: strumenti forniti da OpenAI che estendono le funzionalità del modello, ad esempio la ricerca Web o la ricerca di file. Altre informazioni sugli strumenti predefiniti.
  • Chiamate di funzione (strumenti personalizzati): funzioni definite dall'utente, consentendo al modello di chiamare il proprio codice. Altre informazioni sulla chiamata alle funzioni.
tool_choice
 tool_choice

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

Riferimento a un modello di richiesta e alle relative variabili. Ulteriori informazioni.
truncation
 truncation string

Strategia di troncamento da usare per la risposta del modello.

  • auto: se il contesto di questa risposta e quelli precedenti supera le dimensioni della finestra di contesto del modello, il modello tronca la risposta per adattarsi alla finestra di contesto eliminando gli elementi di input al centro della conversazione.
  • disabled (impostazione predefinita): se una risposta del modello supererà le dimensioni della finestra di contesto per un modello, la richiesta avrà esito negativo con un errore 400.
id
 id string

Identificatore univoco per questa risposta.
oggetto
 object string

Tipo di oggetto di questa risorsa: sempre impostato su response.
status
 status string

Stato della generazione della risposta. Uno tra completed, failed, in_progress, cancelled, queued o incomplete.
creato_il
 created_at unixtime

Timestamp Unix (in secondi) di quando è stata creata questa risposta.
Errore
 error OpenAI.ResponseError

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

Motivo per cui la risposta è incompleta.
output
 output array of OpenAI.ItemResource

Matrice di elementi di contenuto generati dal modello.

  • La lunghezza e l'ordine degli elementi nella output matrice dipendono dalla risposta del modello.
  • Invece di accedere al primo elemento nella output matrice e presupponendo che si tratti di un assistant messaggio con il contenuto generato dal modello, è consigliabile usare la output_text proprietà in cui è supportato negli SDK.
instructions
 instructions

Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.

Quando si usa insieme a previous_response_id, le istruzioni di una risposta precedente non saranno trasferite alla risposta successiva. In questo modo è semplice scambiare messaggi di sistema (o sviluppatore) in nuove risposte.
output_text
 output_text string

Proprietà utile solo SDK che contiene l'output di testo aggregato di tutti gli elementi output_text della matrice output, se presenti. Supportato negli SDK Python e JavaScript.
usage
 usage 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.
chiamate_parallele_agli_strumenti
 parallel_tool_calls boolean

Indica se consentire al modello di eseguire chiamate degli strumenti in parallelo.
id
 conversation.id string

ID conversazione per impostare la conversazione per questa risposta. Se viene fornita la "creazione di una nuova conversazione", verrà avviata una nuova conversazione con questa risposta come primo messaggio.
agente
 agent AgentId

OpenAI.ResponseError

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

Nome Percorso Tipo Descrizione
codice
 code OpenAI.ResponseErrorCode

Codice di errore per la risposta.
message
 message string

Descrizione leggibile dell'errore.

OpenAI.ResponseErrorCode

Codice di errore per la risposta.

Codice di errore per la risposta.

string

OpenAI.ItemResource

Elemento di contenuto usato per generare una risposta.

Nome Percorso Tipo Descrizione
type
 type OpenAI.ItemType
id
 id string

OpenAI.ItemType

string

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 Percorso Tipo Descrizione
input_tokens
 input_tokens integer

Numero di token di input.
cached_tokens
 input_tokens_details.cached_tokens integer

Numero di token recuperati dalla cache. Altre informazioni sulla memorizzazione nella cache dei prompt.
output_tokens
 output_tokens integer

Numero di token in uscita.
reasoning_tokens
 output_tokens_details.reasoning_tokens integer

Numero di token di ragionamento.
total_tokens
 total_tokens integer

Numero totale di token usati.

AgentId

Nome Percorso Tipo Descrizione
type
 type string
nome
 name string

Nome dell'agente.
version
 version string

Identificatore della versione dell'agente.

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.

Nome Percorso Tipo Descrizione
object

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.

strumenti

Nome Percorso Tipo Descrizione
nome
 name string

Elenco di strumenti che possono essere usati nell'esecuzione.

fileIds

Nome Percorso Tipo Descrizione
nome
 name string

Elenco di ID file che possono essere usati nell'esecuzione.

binary

Questo è il tipo di dati di base 'binario'.

oggetto

Si tratta del tipo 'object'.