Microsoft Foundry - agenti

Versione API: v1

Server:{endpoint} — Microsoft Foundry

Variabili del server:

Variabile	Predefinito	Descrizione
endpoint		Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"

Authentication

OAuth2Auth (OAuth 2.0)

Flusso: implicito

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

Ambiti:

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

Requisiti di sicurezza

Tutti gli endpoint richiedono OAuth2Auth (ambiti: https://ai.azure.com/.default).

Agenti - Creare l'agente

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

Crea l'agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Descrizione
endpoint	server	Yes	corda	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versione-api	query	Yes	corda	Versione dell'API da usare per questa operazione. Serializzazione: esplode: falso

Intestazione della richiesta

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

Organismo Richiedente

Content-Type: application/json

Name	Type	Descrizione	Obbligatorio
Definizione	AgentDefinition		Yes
└* tipo	AgentKind		Yes
└rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
nome	corda	Nome univoco che identifica l'agente. Il nome può essere usato per recuperare,aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Yes

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - elencare gli agenti

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

Restituisce l'elenco di tutti gli agenti.

Parametri dell'URI

Name	In	Obbligatorio	Type	Descrizione
endpoint	server	Yes	corda	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
kind	query	No	corda Valori possibili: `prompt`, `hosted`, `workflow`	Filtra gli agenti per tipo. Se non specificato, vengono restituiti tutti gli agenti. Serializzazione: esplode: falso
limit	query	No	intero (int32)	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. Serializzazione: esplode: falso
order	query	No	corda Valori possibili: `asc`, `desc`	Ordinare l'ordinamento in base al `created_at` timestamp degli oggetti. `asc` per l'ordine crescente e`desc` per ordine decrescente. Serializzazione: esplode: falso
dopo	query	No	corda	Cursore da usare nella paginazione. `after` è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, allora il La chiamata successiva può contenere after=obj_foo per ottenere la pagina successiva dell'elenco. Serializzazione: esplode: falso
before	query	No	corda	Cursore da usare nella paginazione. `before` è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, allora il la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco. Serializzazione: esplode: falso
versione-api	query	Yes	corda	Versione dell'API da usare per questa operazione. Serializzazione: esplode: falso

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

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

Name	Type	Descrizione	Obbligatorio
Dati	array di AgentObject	La lista richiesta degli articoli.	Yes
first_id	corda	Il primo ID rappresentato in questa lista.	No
ha_di_piu	boolean	Un valore che indica se ci sono valori aggiuntivi disponibili non catturati in questa lista.	Yes
last_id	corda	L'ultimo ID rappresentato in questa lista.	No

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Ottenere l'agente

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

Recupera l'agente.

Parametri dell'URI

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

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Agente di aggiornamento

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

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

Parametri dell'URI

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

Intestazione della richiesta

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

Organismo Richiedente

Content-Type: application/json

Name	Type	Descrizione	Obbligatorio
Definizione	AgentDefinition		Yes
└* tipo	AgentKind		Yes
└rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Eliminare l'agente

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

Elimina un agente.

Parametri dell'URI

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

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteAgentResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti : aggiornare l'agente dal manifesto

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

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

Parametri dell'URI

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

Organismo Richiedente

Content-Type: application/json

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	corda	ID manifesto da cui importare la versione dell'agente.	Yes
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Yes

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti : creare la versione dell'agente

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

Creare una nuova versione dell'agente.

Parametri dell'URI

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

Intestazione della richiesta

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

Organismo Richiedente

Content-Type: application/json

Name	Type	Descrizione	Obbligatorio
Definizione	AgentDefinition		Yes
└* tipo	AgentKind		Yes
└rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentVersionObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Elencare le versioni degli agenti

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

Restituisce l'elenco delle versioni di un agente.

Parametri dell'URI

Name	In	Obbligatorio	Type	Descrizione
endpoint	server	Yes	corda	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	corda	Nome dell'agente per cui recuperare le versioni.
limit	query	No	intero (int32)	Limite al numero di oggetti da restituire. Il limite può variare tra 1 e 100 e il valore predefinito è 20. Serializzazione: esplode: falso
order	query	No	corda Valori possibili: `asc`, `desc`	Ordinare l'ordinamento in base al `created_at` timestamp degli oggetti. `asc` per l'ordine crescente e`desc` per ordine decrescente. Serializzazione: esplode: falso
dopo	query	No	corda	Cursore da usare nella paginazione. `after` è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, allora il La chiamata successiva può contenere after=obj_foo per ottenere la pagina successiva dell'elenco. Serializzazione: esplode: falso
before	query	No	corda	Cursore da usare nella paginazione. `before` è un ID oggetto che definisce la posizione nell'elenco. Ad esempio, se si effettua una richiesta di elenco e si ricevono 100 oggetti, terminando con obj_foo, allora il la chiamata successiva può includere before=obj_foo per recuperare la pagina precedente dell'elenco. Serializzazione: esplode: falso
versione-api	query	Yes	corda	Versione dell'API da usare per questa operazione. Serializzazione: esplode: falso

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

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

Name	Type	Descrizione	Obbligatorio
Dati	array di AgentVersionObject	La lista richiesta degli articoli.	Yes
first_id	corda	Il primo ID rappresentato in questa lista.	No
ha_di_piu	boolean	Un valore che indica se ci sono valori aggiuntivi disponibili non catturati in questa lista.	Yes
last_id	corda	L'ultimo ID rappresentato in questa lista.	No

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Ottenere la versione dell'agente

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

Recupera una versione specifica di un agente.

Parametri dell'URI

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

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentVersionObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti - Eliminare la versione dell'agente

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

Elimina una versione specifica di un agente.

Parametri dell'URI

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

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	DeleteAgentVersionResponse

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti : creare la versione dell'agente dal manifesto

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

Creare una nuova versione dell'agente da un manifesto.

Parametri dell'URI

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

Organismo Richiedente

Content-Type: application/json

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	corda	ID manifesto da cui importare la versione dell'agente.	Yes
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Yes

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentVersionObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Agenti: creare l'agente dal manifesto

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

Crea un agente da un manifesto.

Parametri dell'URI

Name	In	Obbligatorio	Type	Descrizione
endpoint	server	Yes	corda	Foundry Project endpoint nel formato "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{nome-progetto}". Se nell'hub Foundry è presente un solo Project o per impostare come destinazione il Project predefinito nell'hub usare il modulo "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
versione-api	query	Yes	corda	Versione dell'API da usare per questa operazione. Serializzazione: esplode: falso

Organismo Richiedente

Content-Type: application/json

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	corda	ID manifesto da cui importare la versione dell'agente.	Yes
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
nome	corda	Nome univoco che identifica l'agente. Il nome può essere usato per recuperare,aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Yes
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Yes

Responses

Codice di stato: 200

Descrizione: la richiesta ha avuto esito positivo.

Tipo di contenuto	Type	Descrizione
application/json	AgentObject

Codice di stato: impostazione predefinita

Descrizione: risposta di errore imprevista.

Tipo di contenuto	Type	Descrizione
application/json	ApiErrorResponse

Components

A2APreviewTool

Agente che implementa il protocollo A2A.

Name	Type	Descrizione	Obbligatorio
agent_card_path	corda	Percorso della scheda dell'agente rispetto all'oggetto `base_url`. Se non viene specificato, il valore predefinito è `/.well-known/agent-card.json`	No
base_url	stringa (uri)	URL di base dell'agente.	No
project_connection_id	corda	ID connessione nel progetto per il server A2A. La connessione archivia l'autenticazione e altri dettagli di connessione necessari per connettersi al server A2A.	No
type	enum	Tipo dello strumento. Sempre `"a2a_preview`. Valori possibili: `a2a_preview`	Yes

AISearchIndexResource

Risorsa indice di ricerca di intelligenza artificiale.

Name	Type	Descrizione	Obbligatorio
filter	corda	stringa di filtro per la risorsa di ricerca. Altre informazioni sono disponibili qui.	No
index_asset_id	corda	ID risorsa di indicizzazione 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 dell'indice in un oggetto IndexResource associato a questo agente.	No
Query_type	AzureAISearchQueryType	Tipi di query disponibili per Azure AI Search strumento.	No
top_k	intero (int32)	Numero di documenti da recuperare dalla ricerca e presenti al modello.	No

AgentDefinition

Discriminante per AgentDefinition

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

Valore del tipo	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition

Name	Type	Descrizione	Obbligatorio
kind	AgentKind		Yes
rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
└rai_policy_name	corda	Nome del criterio RAI da applicare.	Yes

AgentDefinitionOptInKeys

Chiavi di opt-in per funzionalità per operazioni di definizione di agenti che supportano agenti ospitati o workflow.

Proprietà	Value
Type	corda
Valori	`HostedAgents=V1Preview` `WorkflowAgents=V1Preview`

AgentKind

Proprietà	Value
Type	corda
Valori	`prompt` `hosted` `workflow`

AgentObject

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

AgentProtocol

Proprietà	Value
Type	corda
Valori	`activity_protocol` `responses`

AgentVersionObject

Name	Type	Descrizione	Obbligatorio
creato_il	FoundryTimestamp		Yes
Definizione	AgentDefinition		Yes
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
id	corda	Identificatore univoco della versione dell'agente.	Yes
metadata	oggetto (nullable)	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	Yes
nome	corda	Nome dell'agente. Il nome può essere usato per recuperare,aggiornare/eliminare l'agente. Vincoli: maxLength: 256	Yes
object	enum	Tipo di oggetto, che è sempre 'agent.version'. Valori possibili: `agent.version`	Yes
version	corda	Identificatore della versione dell'agente. Gli agenti non sono modificabili e ogni aggiornamento crea una nuova versione mantenendo lo stesso nome.	Yes

ApiErrorResponse

Risposta di errore per gli errori dell'API.

Name	Type	Descrizione	Obbligatorio	Predefinito
error	OpenAI.Error		Yes

AzureAISearchQueryType

Tipi di query disponibili per Azure AI Search strumento.

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

AzureAISearchTool

Informazioni sulla definizione di input per uno strumento di ricerca di intelligenza artificiale Azure usato per configurare un agente.

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

AzureAISearchToolResource

Set di risorse di indice usate dallo azure_ai_search strumento.

Name	Type	Descrizione	Obbligatorio	Predefinito
indici	matrice di AISearchIndexResource	Indici associati all'agente. Può essere presente un massimo di 1 indice risorsa collegata all'agente. Vincoli: maxItems: 1	Yes

AzureFunctionBinding

Struttura per mantenere il nome e l'URI della coda di archiviazione.

Name	Type	Descrizione	Obbligatorio
storage_queue	AzureFunctionStorageQueue	Struttura per mantenere il nome e l'URI della coda di archiviazione.	Yes
└queue_name	corda	Nome di una coda di archiviazione della funzione Azure.	Yes
└queue_service_endpoint	corda	URI per il servizio di accodamento Archiviazione di Azure che consente di modificare una coda.	Yes
type	enum	Tipo di associazione, che è sempre "storage_queue". Valori possibili: `storage_queue`	Yes

AzureFunctionDefinition

Definizione della funzione Azure.

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

AzureFunctionStorageQueue

Struttura per mantenere il nome e l'URI della coda di archiviazione.

Name	Type	Descrizione	Obbligatorio	Predefinito
queue_name	corda	Nome di una coda di archiviazione della funzione Azure.	Yes
queue_service_endpoint	corda	URI per il servizio di accodamento Archiviazione di Azure che consente di modificare una coda.	Yes

AzureFunctionTool

Informazioni sulla definizione di input per uno strumento funzione Azure, come usato per configurare un agente.

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

BingCustomSearchConfiguration

Configurazione di ricerca personalizzata Bing.

Name	Type	Descrizione	Obbligatorio
count	intero (int64)	Numero di risultati della ricerca da restituire nella risposta dell'API Bing	No
freshness	corda	Filtrare 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.	Yes
Mercato	corda	Il mercato da cui provengono i risultati.	No
project_connection_id	corda	Project ID connessione per l'uso di base con ricerca Bing	Yes
set_lang	corda	Lingua da usare per le stringhe dell'interfaccia utente quando si chiama l'API Bing.	No

BingCustomSearchPreviewTool

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

Name	Type	Descrizione	Obbligatorio
bing_custom_search_preview	BingCustomSearchToolParameters	Parametri dello strumento di ricerca personalizzata Bing.	Yes
└search_configurations	matrice di BingCustomSearchConfiguration	Connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	Yes
type	enum	Tipo di oggetto, che è sempre "bing_custom_search_preview". Valori possibili: `bing_custom_search_preview`	Yes

BingCustomSearchToolParameters

Parametri dello strumento di ricerca personalizzata Bing.

Name	Type	Descrizione	Obbligatorio	Predefinito
search_configurations	matrice di BingCustomSearchConfiguration	Connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	Yes

BingGroundingSearchConfiguration

Configurazione di ricerca per Bing Grounding

Name	Type	Descrizione	Obbligatorio
count	intero (int64)	Numero di risultati della ricerca da restituire nella risposta dell'API Bing	No
freshness	corda	Filtrare 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	Project ID connessione per l'uso di base con ricerca Bing	Yes
set_lang	corda	Lingua da usare per le stringhe dell'interfaccia utente quando si chiama l'API Bing.	No

BingGroundingSearchToolParameters

Parametri dello strumento di ricerca a terra bing.

Name	Type	Descrizione	Obbligatorio	Predefinito
search_configurations	matrice di BingGroundingSearchConfiguration	Configurazioni di ricerca associate a questo strumento. Può essere presente un massimo di 1 risorsa di configurazione di ricerca collegata allo strumento. Vincoli: maxItems: 1	Yes

BingGroundingTool

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

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

BrowserAutomationPreviewTool

Informazioni sulla definizione di input per uno strumento di automazione browser, come usato per configurare un agente.

Name	Type	Descrizione	Obbligatorio
browser_automation_preview	BrowserAutomationToolParameters	Definizione dei parametri di input per lo strumento di automazione browser.	Yes
Connessione └*	BrowserAutomationToolConnectionParameters	Parametri di connessione del progetto associati allo strumento di automazione browser.	Yes
type	enum	Tipo di oggetto, che è sempre "browser_automation_preview". Valori possibili: `browser_automation_preview`	Yes

BrowserAutomationToolConnectionParameters

Definizione dei parametri di input per la connessione usata dallo strumento di automazione browser.

Name	Type	Descrizione	Obbligatorio	Predefinito
project_connection_id	corda	ID della connessione del progetto alla risorsa playwright Azure.	Yes

BrowserAutomationToolParameters

Definizione dei parametri di input per lo strumento di automazione browser.

Name	Type	Descrizione	Obbligatorio	Predefinito
connessione	BrowserAutomationToolConnectionParameters	Definizione dei parametri di input per la connessione usata dallo strumento di automazione browser.	Yes
└project_connection_id	corda	ID della connessione del progetto alla risorsa playwright Azure.	Yes

CaptureStructuredOutputsTool

Strumento per l'acquisizione di output strutturati

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

CreateAgentFromManifestRequest

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	corda	ID manifesto da cui importare la versione dell'agente.	Yes
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
nome	corda	Nome univoco che identifica l'agente. Il nome può essere usato per recuperare,aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Yes
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Yes

CreateAgentRequest

Name	Type	Descrizione	Obbligatorio
Definizione	AgentDefinition		Yes
└* tipo	AgentKind		Yes
└rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
nome	corda	Nome univoco che identifica l'agente. Il nome può essere usato per recuperare,aggiornare/eliminare l'agente. - Deve iniziare e terminare con caratteri alfanumerici, - Può contenere trattini al centro - Non deve superare i 63 caratteri. Vincoli: maxLength: 63	Yes

CreateAgentVersionFromManifestRequest

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	corda	ID manifesto da cui importare la versione dell'agente.	Yes
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Yes

CreateAgentVersionRequest

Name	Type	Descrizione	Obbligatorio
Definizione	AgentDefinition		Yes
└* tipo	AgentKind		Yes
└rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

DeleteAgentResponse

Oggetto dell'agente eliminato

Name	Type	Descrizione	Obbligatorio
cancellato	boolean	Indica se l'agente è stato eliminato correttamente.	Yes
nome	corda	Nome dell'agente.	Yes
object	enum	Tipo dell'oggetto. Sempre 'agent.deleted'. Valori possibili: `agent.deleted`	Yes

DeleteAgentVersionResponse

Oggetto versione dell'agente eliminato

Name	Type	Descrizione	Obbligatorio
cancellato	boolean	Indica se l'agente è stato eliminato correttamente.	Yes
nome	corda	Nome dell'agente.	Yes
object	enum	Tipo dell'oggetto. Sempre 'agent.version.deleted'. Valori possibili: `agent.version.deleted`	Yes
version	corda	Identificatore della versione dell'agente.	Yes

FabricDataAgentToolParameters

Parametri dello strumento dell'agente dati dell'infrastruttura.

Name	Type	Descrizione	Obbligatorio	Predefinito
project_connections	matrice di ToolProjectConnection	Connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	No

FoundryTimestamp

Tipo: integer

Formato: unixtime

HostedAgentDefinition

Definizione dell'agente ospitato.

Name	Type	Descrizione	Obbligatorio
container_protocol_versions	matrice di ProtocolVersionRecord	Protocolli supportati dall'agente per la comunicazione in ingresso dei contenitori.	Yes
cpu	corda	Configurazione della CPU per l'agente ospitato.	Yes
environment_variables	object	Variabili di ambiente da impostare nel contenitore dell'agente ospitato.	No
image	corda	ID immagine per l'agente, applicabile agli agenti ospitati basati su immagini.	No
kind	enum	Valori possibili: `hosted`	Yes
memory	corda	Configurazione della memoria per l'agente ospitato.	Yes
rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
└rai_policy_name	corda	Nome del criterio RAI da applicare.	Yes
Strumenti	matrice di OpenAI.Tool	Una matrice 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

MemorySearchOptions

Opzioni di ricerca della memoria.

Name	Type	Descrizione	Obbligatorio	Predefinito
max_memories	intero (int32)	Numero massimo di elementi di memoria da restituire.	No

MemorySearchPreviewTool

Strumento per l'integrazione dei ricordi nell'agente.

Name	Type	Descrizione	Obbligatorio	Predefinito
memory_store_name	corda	Nome dell'archivio di memoria da usare.	Yes
scope	corda	Spazio dei nomi usato per raggruppare e isolare i ricordi, ad esempio un ID utente. Limiti che è possibile recuperare o aggiornare le memorie. Usare una variabile `{{$userId}}` speciale per definire l'ambito delle memorie all'utente connesso corrente.	Yes
search_options	MemorySearchOptions	Opzioni di ricerca della memoria.	No
└max_memories	intero (int32)	Numero massimo di elementi di memoria da restituire.	No
type	enum	Tipo dello strumento. Sempre `memory_search_preview`. Valori possibili: `memory_search_preview`	Yes
update_delay	intero (int32)	Tempo di attesa prima dell'aggiornamento dei ricordi dopo l'inattività (secondi). Valore predefinito 300.	No	300

MicrosoftFabricPreviewTool

Informazioni sulla definizione di input per uno strumento di Microsoft Fabric usato per configurare un agente.

Name	Type	Descrizione	Obbligatorio
fabric_dataagent_preview	FabricDataAgentToolParameters	Parametri dello strumento dell'agente dati dell'infrastruttura.	Yes
└project_connections	matrice di ToolProjectConnection	Connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	No
type	enum	Tipo di oggetto, che è sempre "fabric_dataagent_preview". Valori possibili: `fabric_dataagent_preview`	Yes

OpenAI.ApplyPatchToolParam

Applica lo strumento di patch

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Tipo dello strumento. Sempre `apply_patch`. Valori possibili: `apply_patch`	Yes	apply_patch

OpenAI.PosizioneApprossimativa

Name	Type	Descrizione	Obbligatorio	Predefinito
city	stringa (nullabile)		No
country	stringa (nullabile)		No
region	stringa (nullabile)		No
timezone	stringa (nullabile)		No
type	enum	Tipo di approssimazione della posizione. Sempre `approximate`. Valori possibili: `approximate`	Yes	approssimativa

OpenAI.AutoCodeInterpreterToolParam

Parametri dello strumento Automatic Code Interpreter

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

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

OpenAI.CodeInterpreterTool

Interprete di codice

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

Name	Type	Descrizione	Obbligatorio	Predefinito
container	o OpenAI.AutoCodeInterpreterToolParam	Contenitore dell'interprete di codice. Può essere un ID contenitore o un oggetto che specifica gli ID file caricati per rendere disponibile il codice, insieme a un impostazione facoltativa `memory_limit` . Se non viene specificato, il servizio presuppone l'auto.	No
type	enum	Tipo dello strumento dell'interprete di codice. Sempre `code_interpreter`. Valori possibili: `code_interpreter`	Yes

OpenAI.ComparisonFilter

Filtro di confronto

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

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

OpenAI.CompoundFilter

Filtro composto

Combinare più filtri usando and o or.

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

OpenAI.ComputerEnvironment

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

OpenAI.ComputerUsePreviewTool

Anteprima dell'uso del computer

Strumento che controlla un computer virtuale.

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

OpenAI.ContainerAutoParam

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

OpenAI.ContainerMemoryLimit

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

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Type	Descrizione	Obbligatorio	Predefinito
allowed_domains	matrice di valori string	Un elenco di domini consentiti quando il tipo è `allowlist`. Vincoli: minOggetti: 1	Yes
domain_secrets	array di OpenAI.ContainerNetworkPolicyDomainSecretParam	Segreti opzionali con ambito di dominio per domini consentiti. Vincoli: minOggetti: 1	No
type	enum	Consentire l'accesso alla rete in uscita solo a domini specifici. Sempre `allowlist`. Valori possibili: `allowlist`	Yes	allowlist

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Disabilita l'accesso alla rete in uscita. Sempre `disabled`. Valori possibili: `disabled`	Yes	disattivato

OpenAI.ContainerNetworkPolicyDomainSecretParam

Name	Type	Descrizione	Obbligatorio
domain	corda	Il dominio associato al segreto. Vincoli: minLength: 1	Yes
nome	corda	Il nome del segreto da iniettare per il dominio. Vincoli: minLength: 1	Yes
value	corda	Il valore segreto da iniettare per il dominio. Vincoli: minLunghezza: 1, maxLunghezza: 10485760	Yes

OpenAI.ContainerNetworkPolicyParam

Politica di accesso alla rete per il container.

Discriminatore per OpenAI.ContainerNetworkPolicyParam

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

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.ContainerNetworkPolicyParamType		Yes

OpenAI.ContainerNetworkPolicyParamType

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

OpenAI.ContainerSkill

Discriminatore per OpenAI.ContainerSkill

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

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.ContainerSkillType		Yes

OpenAI.ContainerSkillType

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

OpenAI.CustomGrammarFormatParam

Formato grammaticale

Grammatica definita dall'utente.

Name	Type	Descrizione	Obbligatorio	Predefinito
Definizione	corda	Definizione della grammatica.	Yes
Sintassi	OpenAI.GrammarSyntax1		Yes
type	enum	Formato grammaticale. Sempre `grammar`. Valori possibili: `grammar`	Yes	Grammatica

OpenAI.CustomTextFormatParam

Formato testo

Testo in formato libero senza vincoli.

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Formato di testo non vincolato. Sempre `text`. Valori possibili: `text`	Yes	text

OpenAI.CustomToolParam

Strumento personalizzato

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

Name	Type	Descrizione	Obbligatorio	Predefinito
description	corda	Descrizione facoltativa dello strumento personalizzato, usata per fornire più contesto.	No
format	OpenAI.CustomToolParamFormat	Formato di input per lo strumento personalizzato. Il valore predefinito è testo non vincolato.	No
└─ Tipo	OpenAI.CustomToolParamFormatType		Yes
nome	corda	Nome dello strumento personalizzato, usato per identificarlo nelle chiamate degli strumenti.	Yes
type	enum	Tipo dello strumento personalizzato. Sempre `custom`. Valori possibili: `custom`	Yes	custom

OpenAI.CustomToolParamFormat

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

Discriminare per OpenAI.CustomToolParamFormat

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

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

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

OpenAI.Error

Name	Type	Obbligatorio
informazioni aggiuntive	object	No
codice	stringa (nullabile)	Yes
debugInfo	object	No
details	matrice di OpenAI.Error	No
message	corda	Yes
param	stringa (nullabile)	No
type	corda	No

OpenAI.FileSearchTool

Ricerca di file

Strumento che cerca il contenuto pertinente dai file caricati.

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

OpenAI.Filters

Tipo: OpenAI.ComparisonFilter o OpenAI.CompoundFilter

OpenAI.FunctionShellToolParam

Strumento a guscio

Strumento che consente al modello di eseguire comandi della shell.

Name	Type	Descrizione	Obbligatorio	Predefinito
environment	OpenAI.FunctionShellToolParamEnvironment (nullabile)		No
└─ Tipo	OpenAI.FunctionShellToolParamEnvironmentType		Yes
type	enum	Tipo dello strumento shell. Sempre `shell`. Valori possibili: `shell`	Yes	shell

OpenAI.FunctionShellToolParamEnvironment

Discriminatore per OpenAI.FunctionShellToolParamEnvironment

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

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.FunctionShellToolParamEnvironmentType		Yes

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

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

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

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

OpenAI.FunctionShellToolParamEnvironmentType

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

OpenAI.FunctionTool

Funzione

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

Name	Type	Descrizione	Obbligatorio	Predefinito
description	stringa (nullabile)		No
nome	corda	Il nome della funzione da chiamare.	Yes
parameters	oggetto (nullable)		Yes
rigido	booleano (nullable)		Yes
type	enum	Tipo di strumento funzionale. Sempre `function`. Valori possibili: `function`	Yes	funzione

OpenAI.GrammarSyntax1

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

OpenAI.HybridSearchOptions

Name	Type	Descrizione	Obbligatorio	Predefinito
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageGenActionEnum

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

OpenAI.ImageGenTool

Strumento di generazione immagini

Strumento che genera immagini usando i modelli di immagine GPT.

Modelli validi:

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

Name	Type	Descrizione	Obbligatorio	Predefinito
action	OpenAI.ImageGenActionEnum		No
sfondo	enum	Tipo di sfondo per l'immagine generata. Uno di `transparent`, `opaque`, o `auto`. Impostazione predefinita: `auto`. Valori possibili: `transparent`, `opaque`, `auto`	No	auto
fedeltà dell'input	OpenAI.InputFidelity (nullabile)	Controllare quanto sforzo il modello eserciterà per corrispondere allo stile e alle caratteristiche, in particolare quelle facciali, delle immagini di ingresso. Questo parametro è supportato solo per `gpt-image-1` e `gpt-image-1.5` e modelli successivi, non supportati per `gpt-image-1-mini`. Supporti `high` e `low`. Di default è `low`.	No
input_image_mask	OpenAI.ImageGenToolInputImageMask		No
└ file_id	corda		No
└ image_url	stringa (uri)		No
model	string (vedere modelli validi di seguito)		No
Moderazione	enum	Livello di moderazione per l'immagine generata. Impostazione predefinita: `auto`. Valori possibili: `auto`, `low`	No	auto
Compressione dell'output	OpenAI.integer	Vincoli: min: 0, max: 100	No	100
formato_di_output	enum	Formato di output dell'immagine generata. Uno di `png`, `webp`, o `jpeg`. Impostazione predefinita: `png`. Valori possibili: `png`, `webp`, `jpeg`	No	png
immagini parziali	OpenAI.integer	Vincoli: min: 0, max: 3	No
qualità	enum	Qualità dell'immagine generata. Uno di `low`, `medium`, `high`, , o `auto`. Impostazione predefinita: `auto`. Valori possibili: `low`, `medium`, `high`, `auto`	No	auto
size	enum	Dimensioni dell'immagine generata. Uno di `1024x1024`, `1024x1536`, `1536x1024`, o `auto`. Impostazione predefinita: `auto`. Valori possibili: `1024x1024`, `1024x1536`, `1536x1024`, `auto`	No	auto
type	enum	Tipo dello strumento di generazione di immagini. Sempre `image_generation`. Valori possibili: `image_generation`	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Type	Descrizione	Obbligatorio	Predefinito
ID del file	corda		No
image_url	stringa (uri)		No

OpenAI.InlineSkillParam

Name	Type	Descrizione	Obbligatorio	Predefinito
description	corda	La descrizione dell'abilità.	Yes
nome	corda	Il nome dell'abilità.	Yes
origine	OpenAI.InlineSkillSourceParam	Carico utile per abilità in linea	Yes
└* dati	corda	Pacchetto zip di abilità codificato in base64. Vincoli: minLunghezza: 1, maxLunghezza: 70254592	Yes
└─ media_type	enum	Il tipo di media del payload inline di competenza. Deve essere `application/zip`. Valori possibili: `application/zip`	Yes	application/zip
└─ Tipo	enum	Il tipo di fonte di abilità inline. Deve essere `base64`. Valori possibili: `base64`	Yes	base64
type	enum	Definisce una competenza inline per questa richiesta. Valori possibili: `inline`	Yes	inline

OpenAI.InlineSkillSourceParam

Carico utile per abilità in linea

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

OpenAI.InputFidelity

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

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

OpenAI.LocalShellToolParam

Strumento a guscio locale

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Tipo dello strumento della shell locale. Sempre `local_shell`. Valori possibili: `local_shell`	Yes	local_shell

OpenAI.LocalSkillParam

Name	Type	Descrizione	Obbligatorio
description	corda	La descrizione dell'abilità.	Yes
nome	corda	Il nome dell'abilità.	Yes
path	corda	Il percorso verso la directory che contiene l'abilità.	Yes

OpenAI.MCPTool

Strumento MCP

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

Name	Type	Descrizione	Obbligatorio
strumenti consentiti	matrice di stringhe o OpenAI.MCPToolFilter		No
authorization	corda	Token di accesso OAuth che può essere usato con un server MCP remoto, con un URL del server MCP personalizzato o un connettore di servizi. Applicazione deve gestire il flusso di autorizzazione OAuth e fornire il token qui.	No
connector_id	enum	Identificatore per i connettori del servizio, ad esempio quelli disponibili in ChatGPT. Uno dei `server_url` o `connector_id` deve essere fornito. Altre informazioni sul servizio Qui connettori. I valori attualmente supportati `connector_id` sono: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Google Calendar: `connector_googlecalendar` - Google Drive: `connector_googledrive` - Microsoft Teams: `connector_microsoftteams` - Calendario di Outlook: `connector_outlookcalendar` - Posta elettronica di Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Valori possibili: `connector_dropbox`, `connector_gmail`, `connector_googlecalendarconnector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , `connector_outlookemailconnector_sharepoint`	No
headers	oggetto (nullable)		No
project_connection_id	corda	ID connessione nel progetto per il server MCP. La connessione archivia l'autenticazione e altri dettagli di connessione necessari per connettersi al server MCP.	No
richiedere_approvazione	OpenAI.MCPToolRequireApproval o stringa		No
server_description	corda	Descrizione facoltativa del server MCP, usata per fornire più contesto.	No
etichetta del server	corda	Etichetta per questo server MCP, usata per identificarla nelle chiamate degli strumenti.	Yes
URL del server	stringa (uri)	URL del server MCP. Uno di `server_url` o `connector_id` deve essere Fornito.	No
type	enum	Tipo dello strumento MCP. Sempre `mcp`. Valori possibili: `mcp`	Yes

OpenAI.MCPToolFilter

Filtro utensile MCP

Oggetto filtro per specificare gli strumenti consentiti.

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

OpenAI.MCPToolRequireApproval

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

OpenAI.RankerVersionType

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

OpenAI.OpzioniDiClassifica

Name	Type	Descrizione	Obbligatorio
hybrid_search	OpenAI.HybridSearchOptions		No
└embedding_weight	OpenAI.numeric	Peso dell'incorporamento nella fusione di rango reciproca.	Yes
└text_weight	OpenAI.numeric	Peso del testo nella fusione di rango reciproco.	Yes
classificatore	OpenAI.RankerVersionType		No
soglia_punteggio	OpenAI.numeric		No

OpenAI.Reasoning

Reasoning

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

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

Sforzo di Ragionamento OpenAI

Vincola il lavoro sul ragionamento per i modelli di ragionamento. I valori attualmente supportati sono none, minimal, lowmedium, , highe xhigh. La riduzione del lavoro di ragionamento può comportare risposte più veloci e un minor numero di token usati per il ragionamento in una risposta.

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

Proprietà	Value
Type	corda
Annullabile	Yes
Valori	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ResponseFormatJsonSchemaSchema

Schema JSON

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

Tipo: oggetto

OpenAI.SearchContextSize

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

OpenAI.SkillReferenceParam

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

OpenAI.SpecificApplyPatchParam

Scelta dello strumento specifico per la patch

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Strumento da chiamare. Sempre `apply_patch`. Valori possibili: `apply_patch`	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Scelta specifica dello strumento shell

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Strumento da chiamare. Sempre `shell`. Valori possibili: `shell`	Yes	shell

OpenAI.TextResponseFormatConfiguration

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

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

Discriminare per OpenAI.TextResponseFormatConfiguration

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

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Oggetto JSON

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Tipo di formato di risposta definito. Sempre `json_object`. Valori possibili: `json_object`	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Tipo di formato di risposta definito. Sempre `text`. Valori possibili: `text`	Yes

OpenAI.TextResponseFormatConfigurationType

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

OpenAI.TextResponseFormatJsonSchema

Schema JSON

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

Name	Type	Descrizione	Obbligatorio
description	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.	Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	Lo schema per il formato di risposta, descritto come un oggetto JSON Schema. Informazioni su come creare schemi JSON qui.	Yes
rigido	booleano (nullable)		No
type	enum	Tipo di formato di risposta definito. Sempre `json_schema`. Valori possibili: `json_schema`	Yes

OpenAI.Tool

Strumento che può essere usato per generare una risposta.

Discriminatore per OpenAI.Tool

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

Valore del tipo	Schema
`bing_grounding`	BingGroundingTool
`fabric_dataagent_preview`	MicrosoftFabricPreviewTool
`sharepoint_grounding_preview`	SharepointPreviewTool
`azure_ai_search`	AzureAISearchTool
`openapi`	OpenApiTool
`bing_custom_search_preview`	BingCustomSearchPreviewTool
`browser_automation_preview`	BrowserAutomationPreviewTool
`azure_function`	AzureFunctionTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2APreviewTool
`memory_search_preview`	MemorySearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Strumenti consentiti

Vincola gli strumenti disponibili al modello a un set predefinito.

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

OpenAI.ToolChoiceCodeInterpreter

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Valori possibili: `code_interpreter`	Yes

OpenAI.ToolChoiceComputerUsePreview

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Valori possibili: `computer_use_preview`	Yes

OpenAI.ToolChoiceCustom

Strumento personalizzato

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

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

OpenAI.ToolChoiceFileSearch

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Valori possibili: `file_search`	Yes

OpenAI.ToolChoiceFunction

Strumento funzionale

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

Name	Type	Descrizione	Obbligatorio	Predefinito
nome	corda	Il nome della funzione da chiamare.	Yes
type	enum	Per la chiamata di funzione, il tipo è sempre `function`. Valori possibili: `function`	Yes

OpenAI.ToolChoiceImageGeneration

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Valori possibili: `image_generation`	Yes

OpenAI.ToolChoiceMCP

Strumento MCP

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

Name	Type	Descrizione	Obbligatorio
nome	stringa (nullabile)		No
etichetta del server	corda	Etichetta del server MCP da usare.	Yes
type	enum	Per gli strumenti MCP, il tipo è sempre `mcp`. Valori possibili: `mcp`	Yes

OpenAI.ToolChoiceParam

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

Discriminante per OpenAI.ToolChoiceParam

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

Valore del tipo	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`function`	OpenAI.ToolChoiceFunction
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Proprietà	Value
Type	corda
Valori	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Valori possibili: `web_search_preview`	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

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

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Valori possibili: `web_search_preview_2025_03_11`	Yes

OpenAI.ToolType

Proprietà Value

Type corda

Valori function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

OpenAI.WebSearchApproximateLocation

Ricerca web posizione approssimativa

Posizione approssimativa dell'utente.

Name	Type	Descrizione	Obbligatorio	Predefinito
city	stringa (nullabile)		No
country	stringa (nullabile)		No
region	stringa (nullabile)		No
timezone	stringa (nullabile)		No
type	enum	Tipo di approssimazione della posizione. Sempre `approximate`. Valori possibili: `approximate`	Yes	approssimativa

OpenAI.WebSearchPreviewTool

Anteprima della ricerca web

Questo strumento cerca nel Web i risultati pertinenti da usare in una risposta. Altre informazioni sullo strumento di ricerca Web.

Name	Type	Descrizione	Obbligatorio	Predefinito
dimensione_del_contesto_di_ricerca	OpenAI.SearchContextSize		No
type	enum	Tipo dello strumento di ricerca Web. Uno di `web_search_preview` o `web_search_preview_2025_03_11`. Valori possibili: `web_search_preview`	Yes	web_search_preview
posizione_utente	OpenAI.ApproximateLocation (nullabile)		No
└* città	stringa (nullabile)		No
└* paese	stringa (nullabile)		No
└* area geografica	stringa (nullabile)		No
└* fuso orario	stringa (nullabile)		No
└─ Tipo	enum	Tipo di approssimazione della posizione. Sempre `approximate`. Valori possibili: `approximate`	Yes	approssimativa

OpenAI.WebSearchTool

Ricerca Web

Cercare le origini relative al prompt in Internet. Scopri di più sullo strumento di ricerca web.

Name	Type	Descrizione	Obbligatorio	Predefinito
custom_search_configuration	WebSearchConfiguration	Configurazione di ricerca Web per la ricerca personalizzata Bing	No
└instance_name	corda	Nome dell'istanza di configurazione personalizzata assegnata alla configurazione.	Yes
└project_connection_id	corda	Project ID connessione per l'uso di base con ricerca personalizzata Bing	Yes
filters	OpenAI.WebSearchToolFilters (nullabile)		No
└allowed_domains	matrice di string (nullable)		No
dimensione_del_contesto_di_ricerca	enum	Linee guida generali per la quantità di spazio della finestra di contesto da usare per la ricerca. Uno tra `low`, `medium` e `high`. `medium` è l'impostazione predefinita. Valori possibili: `low`, `medium`, `high`	No	medium
type	enum	Tipo dello strumento di ricerca Web. Uno di `web_search` o `web_search_2025_08_26`. Valori possibili: `web_search`	Yes	ricerca sul web
posizione_utente	OpenAI.WebSearchApproximateLocation (nullabile)	Posizione approssimativa dell'utente.	No
└* città	stringa (nullabile)		No
└* paese	stringa (nullabile)		No
└* area geografica	stringa (nullabile)		No
└* fuso orario	stringa (nullabile)		No
└─ Tipo	enum	Tipo di approssimazione della posizione. Sempre `approximate`. Valori possibili: `approximate`	Yes	approssimativa

OpenAI.WebSearchToolFilters

Name	Type	Descrizione	Obbligatorio	Predefinito
allowed_domains	matrice di string (nullable)		No

OpenAI.integer

Tipo: integer

Formato: int64

OpenAI.numeric

Tipo: numero

Formato: double

OpenApiAnonymousAuthDetails

Dettagli di sicurezza per l'autenticazione anonima OpenApi

Name	Type	Descrizione	Obbligatorio	Predefinito
type	enum	Tipo di oggetto, che è sempre "anonimo". Valori possibili: `anonymous`	Yes

OpenApiAuthDetails

dettagli di autenticazione per OpenApiFunctionDefinition

Discriminare per OpenApiAuthDetails

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

Valore del tipo	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Name	Type	Descrizione	Obbligatorio	Predefinito
type	OpenApiAuthType	Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono: - Anonimo (nessuna autenticazione necessaria) - Project Connessione (richiede project_connection_id all'endpoint, come configurazione in AI Foundry) - Managed_Identity (richiede destinatari per l'autenticazione basata sull'identità)	Yes

OpenApiAuthType

Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono:

Anonimo (nessuna autenticazione necessaria)
Project Connessione (richiede project_connection_id all'endpoint, come configurazione in AI Foundry)
Managed_Identity (richiede destinatari per l'autenticazione basata sull'identità)

Proprietà	Value
Descrizione	Tipo di autenticazione per l'endpoint OpenApi. I tipi consentiti sono: - Anonimo (nessuna autenticazione necessaria) - Project Connessione (richiede project_connection_id all'endpoint, come configurazione in AI Foundry) - Managed_Identity (richiede destinatari per l'autenticazione basata sull'identità)
Type	corda
Valori	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Informazioni sulla definizione di input per una funzione openapi.

Name	Type	Descrizione	Obbligatorio
autenticazione	OpenApiAuthDetails	dettagli di autenticazione per OpenApiFunctionDefinition	Yes
└─ Tipo	OpenApiAuthType	Il tipo di autenticazione deve essere anonimo/project_connection/managed_identity	Yes
default_params	matrice di valori string	Elenco dei parametri della specifica OpenAPI che useranno le impostazioni predefinite fornite dall'utente	No
description	corda	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
functions	matrice di oggetti (sola lettura)	Elenco delle definizioni di funzione usate dallo strumento OpenApi	No
nome	corda	Nome della funzione che deve essere chiamata.	Yes
spec	object	La forma della funzione openapi, descritta come oggetto Schema JSON.	Yes

OpenApiManagedAuthDetails

Dettagli di sicurezza per l'autenticazione managed_identity OpenApi

Name	Type	Descrizione	Obbligatorio
security_scheme	OpenApiManagedSecurityScheme	Schema di sicurezza per l'autenticazione managed_identity OpenApi	Yes
Gruppo di destinatari └*	corda	Ambito di autenticazione per managed_identity tipo di autenticazione	Yes
type	enum	Tipo di oggetto, che è sempre "managed_identity". Valori possibili: `managed_identity`	Yes

OpenApiManagedSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

Name	Type	Descrizione	Obbligatorio	Predefinito
gruppo di destinatari	corda	Ambito di autenticazione per managed_identity tipo di autenticazione	Yes

OpenApiProjectConnectionAuthDetails

Dettagli di sicurezza per l'autenticazione della connessione al progetto OpenApi

Name	Type	Descrizione	Obbligatorio
security_scheme	OpenApiProjectConnectionSecurityScheme	Schema di sicurezza per l'autenticazione managed_identity OpenApi	Yes
└project_connection_id	corda	Project ID connessione per Project tipo di autenticazione della connessione	Yes
type	enum	Tipo di oggetto, che è sempre "project_connection". Valori possibili: `project_connection`	Yes

OpenApiProjectConnectionSecurityScheme

Schema di sicurezza per l'autenticazione managed_identity OpenApi

Name	Type	Descrizione	Obbligatorio	Predefinito
project_connection_id	corda	Project ID connessione per Project tipo di autenticazione della connessione	Yes

OpenApiTool

Informazioni sulla definizione di input per uno strumento OpenAPI usato per configurare un agente.

Name	Type	Descrizione	Obbligatorio
openapi	OpenApiFunctionDefinition	Informazioni sulla definizione di input per una funzione openapi.	Yes
└* Autenticazione	OpenApiAuthDetails	Aprire i dettagli di autenticazione dell'API	Yes
└default_params	matrice di valori string	Elenco dei parametri della specifica OpenAPI che useranno le impostazioni predefinite fornite dall'utente	No
└* descrizione	corda	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
└* funzioni	matrice di oggetti (sola lettura)	Elenco delle definizioni di funzione usate dallo strumento OpenApi	No
└* descrizione	corda	Una descrizione di ciò che fa la funzione, usata dal modello per scegliere quando e come chiamarla.	No
└> nome	corda	Nome della funzione che deve essere chiamata.	Yes
└─ Parametri	object	I parametri che le funzioni accettano, descritti come un oggetto JSON Schema.	Yes
└> nome	corda	Nome della funzione che deve essere chiamata.	Yes
└* specifica	object	La forma della funzione openapi, descritta come oggetto Schema JSON.	Yes
type	enum	Tipo di oggetto, che è sempre 'openapi'. Valori possibili: `openapi`	Yes

PageOrder

Proprietà	Value
Type	corda
Valori	`asc` `desc`

PromptAgentDefinition

Definizione dell'agente di richiesta

Name	Type	Descrizione	Obbligatorio	Predefinito
instructions	stringa (nullabile)	Messaggio di sistema (o sviluppatore) inserito nel contesto del modello.	No
kind	enum	Valori possibili: `prompt`	Yes
model	corda	Distribuzione del modello da usare per questo agente.	Yes
rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
└rai_policy_name	corda	Nome del criterio RAI da applicare.	Yes
reasoning	OpenAI.Reasoning (nullabile)	Solo modelli gpt-5 e serie O Opzioni di configurazione per ragionamento dei modelli.	No
└* sforzo	Sforzo di Ragionamento OpenAI	Vincola lo sforzo sul ragionamento per ragionamento dei modelli. I valori attualmente supportati sono `none`, `minimal`, `lowmedium`, , `high`e `xhigh`. Ridurre l'impegno di ragionamento può comportare risposte più veloci e meno token usati sul ragionamento in una risposta. - `gpt-5.1` il valore predefinito è `none`, che non esegue il ragionamento. I valori di ragionamento supportati per `gpt-5.1` sono `none`, `low`, `medium`e `high`. Le chiamate agli strumenti sono supportate per tutti i valori di ragionamento in gpt-5.1. - Tutti i modelli prima `gpt-5.1` di eseguire il ragionamento per impostazione predefinita `medium` e non supportano `none`. - Il `gpt-5-pro` modello usa per impostazione predefinita (e supporta solo) `high` il ragionamento. - `xhigh` è supportato per tutti i modelli dopo `gpt-5.1-codex-max`.	No
└─ genera_sommario	enum (nullabile)	Valori possibili: `auto`, `concise`, `detailed`	No
└─ Riepilogo	enum (nullabile)	Valori possibili: `auto`, `concise`, `detailed`	No
structured_inputs	object	Set di input strutturati che possono partecipare alle associazioni di argomenti del modello o sostituzione del modello di richiesta.	No
Temperatura	Numero (float) (nullabile)	Quale temperatura di campionamento usare, 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. Generalmente consigliamo di modificare questo o `top_p` , ma non entrambi. Vincoli: minimo: 0, max: 2	No	1
text	PromptAgentDefinitionTextOptions	Opzioni di configurazione per una risposta di testo dal modello. Può essere un testo normale o dati JSON strutturati.	No
└* formato	OpenAI.TextResponseFormatConfiguration	Oggetto che specifica il formato che il modello deve restituire. La configurazione `{ "type": "json_schema" }` abilita output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere Il formato predefinito è `{ "type": "text" }` senza opzioni aggiuntive. Non consigliato per i modelli gpt-4o e versioni successive: L'impostazione su `{ "type": "json_object" }` abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. Utilizzo di `json_schema` è preferibile per i modelli che lo supportano.	No
tool_choice	string o OpenAI.ToolChoiceParam	Come il modello deve selezionare quale strumento (o strumenti) usare durante la generazione di una risposta. Vedere il `tools` parametro per informazioni su come specificare gli strumenti che il modello può chiamare.	No
Strumenti	matrice di OpenAI.Tool	Una matrice di strumenti che il modello può chiamare durante la generazione di una risposta. Tu può specificare quale strumento usare impostando il `tool_choice` parametro .	No
top_p	Numero (float) (nullabile)	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. Generalmente consigliamo di modificare questo o `temperature` , ma non entrambi. Vincoli: min: 0, max: 1	No	1

PromptAgentDefinitionTextOptions

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

Name	Type	Descrizione	Obbligatorio	Predefinito
format	OpenAI.TextResponseFormatConfiguration	Oggetto che specifica il formato che il modello deve restituire. La configurazione `{ "type": "json_schema" }` abilita output strutturati, che garantisce che il modello corrisponda allo schema JSON fornito. Per altre informazioni, vedere Il formato predefinito è `{ "type": "text" }` senza opzioni aggiuntive. Non consigliato per i modelli gpt-4o e versioni successive: L'impostazione su `{ "type": "json_object" }` abilita la modalità JSON precedente, che garantisce che il messaggio generato dal modello sia JSON valido. Utilizzo di `json_schema` è preferibile per i modelli che lo supportano.	No

ProtocolVersionRecord

Mapping di record per un singolo protocollo e la relativa versione.

Name	Type	Descrizione	Obbligatorio	Predefinito
protocol	AgentProtocol		Yes
version	corda	Stringa di versione per il protocollo, ad esempio 'v0.1.1'.	Yes

RaiConfig

Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).

Name	Type	Descrizione	Obbligatorio	Predefinito
rai_policy_name	corda	Nome del criterio RAI da applicare.	Yes

SharepointGroundingToolParameters

Parametri dello strumento di base di SharePoint.

Name	Type	Descrizione	Obbligatorio	Predefinito
project_connections	matrice di ToolProjectConnection	Connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	No

SharepointPreviewTool

Informazioni sulla definizione di input per uno strumento di SharePoint usato per configurare un agente.

Name	Type	Descrizione	Obbligatorio
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parametri dello strumento di base di SharePoint.	Yes
└project_connections	matrice di ToolProjectConnection	Connessioni di progetto collegate a questo strumento. Può essere presente un massimo di 1 connessione risorsa collegata allo strumento. Vincoli: maxItems: 1	No
type	enum	Tipo di oggetto, che è sempre "sharepoint_grounding_preview". Valori possibili: `sharepoint_grounding_preview`	Yes

StructuredInputDefinition

Input strutturato che può partecipare alle sostituzioni dei modelli di richiesta e all'associazione di argomenti dello strumento.

Name	Type	Descrizione	Obbligatorio	Predefinito
default_value		Valore predefinito per l'input se non viene specificato alcun valore di run-time.	No
description	corda	Descrizione leggibile dell'input.	No
required	boolean	Indica se la proprietà di input è necessaria quando viene richiamato l'agente.	No	Falso
schema	object	Schema JSON per l'input strutturato (facoltativo).	No

StructuredOutputDefinition

Output strutturato che può essere prodotto dall'agente.

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione dell'output da generare. Usato dal modello per determinare quando generare l'output.	Yes
nome	corda	Nome dell'output strutturato.	Yes
schema	object	Schema JSON per l'output strutturato.	Yes
rigido	booleano (nullable)	Indica se applicare la convalida rigorosa. Valore predefinito `true`.	Yes

ToolProjectConnection

Una risorsa di connessione al progetto.

Name	Type	Descrizione	Obbligatorio	Predefinito
project_connection_id	corda	Una connessione di progetto in uno ToolProjectConnectionList collegato a questo strumento.	Yes

UpdateAgentFromManifestRequest

Name	Type	Descrizione	Obbligatorio
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
manifest_id	corda	ID manifesto da cui importare la versione dell'agente.	Yes
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No
parameter_values	object	Input al manifesto che genererà un agente completamente materializzato.	Yes

UpdateAgentRequest

Name	Type	Descrizione	Obbligatorio
Definizione	AgentDefinition		Yes
└* tipo	AgentKind		Yes
└rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
description	corda	Descrizione leggibile dell'agente. Vincoli: maxLength: 512	No
metadata	object	Set di 16 coppie chiave-valore che possono essere collegate a un oggetto . Può trattarsi di utile per archiviare informazioni aggiuntive sull'oggetto in un oggetto strutturato formattare ed eseguire query per gli oggetti tramite l'API o il dashboard. Le chiavi sono stringhe con una lunghezza massima di 64 caratteri. I valori sono stringhe con una lunghezza massima di 512 caratteri.	No

WebSearchConfiguration

Configurazione di ricerca Web per la ricerca personalizzata Bing

Name	Type	Descrizione	Obbligatorio	Predefinito
instance_name	corda	Nome dell'istanza di configurazione personalizzata assegnata alla configurazione.	Yes
project_connection_id	corda	Project ID connessione per l'uso di base con ricerca personalizzata Bing	Yes

WorkflowAgentDefinition

Definizione dell'agente del flusso di lavoro.

Name	Type	Descrizione	Obbligatorio
kind	enum	Valori possibili: `workflow`	Yes
rai_config	RaiConfig	Configurazione per funzionalità di filtro e sicurezza dei contenuti per l'intelligenza artificiale responsabile (RAI).	No
└rai_policy_name	corda	Nome del criterio RAI da applicare.	Yes
flusso di lavoro	corda	Definizione YAML CSDL del flusso di lavoro.	No

Last updated on 2026-06-01