Microsoft Foundry - agents

Version de l’API : v1

Server :{endpoint} — Microsoft Foundry

Variables serveur :

Variable	Par défaut	Description
endpoint		Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »

Authentification

OAuth2Auth (OAuth 2.0)

Flux : implicite

URL d’autorisation :https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues:

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

Spécifications de sécurité

Tous les points de terminaison nécessitent OAuth2Auth (portées : https://ai.azure.com/.default).

Agents - Créer un agent

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

Crée l’agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

En-tête de requête

Name	Obligatoire	Catégorie	Description
Foundry-Features	No	string Valeurs possibles : `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Un indicateur de fonctionnalité est obligatoire lors de l’utilisation d’opérations d’aperçu ou de modification des ressources d’aperçu persistantes.

Corps de la requête

Content-Type : application/json

Name	Catégorie	Description	Obligatoire
Définition	AgentDefinition		Yes
Type └	AgentKind		Yes
└rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
nom	string	Nom unique qui identifie l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. - Doit commencer et se terminer par des caractères alphanumériques, - Peut contenir des traits d’union au milieu - Ne doit pas dépasser 63 caractères. Contraintes : maxLength : 63	Yes

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - répertorier les agents

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

Retourne la liste de tous les agents.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
kind	query	No	string Valeurs possibles : `prompt`, , `hostedworkflow`	Filtrez les agents par type. S’il n’est pas fourni, tous les agents sont retournés. Sérialisation : exploser : faux
limit	query	No	entier (int32)	Une limite au nombre d’objets à retourner. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20. Sérialisation : exploser : faux
order	query	No	string Valeurs possibles : `asc`, `desc`	Triez l’ordre en fonction de l’horodatage `created_at` des objets. `asc` pour l’ordre croissant et`desc` dans l’ordre décroissant. Sérialisation : exploser : faux
Après	query	No	string	Un curseur pour la pagination. `after` est un identifiant d’objet qui définit votre place dans la liste. Par exemple, si vous envoyez une requête de liste et vous recevez 100 objets qui se terminent par obj_foo, votre Un appel ultérieur peut inclure after=obj_foo afin de récupérer la page suivante de la liste. Sérialisation : exploser : faux
before	query	No	string	Un curseur pour la pagination. `before` est un identifiant d’objet qui définit votre place dans la liste. Par exemple, si vous envoyez une requête de liste et vous recevez 100 objets qui se terminent par obj_foo, votre l'appel suivant peut inclure before=obj_foo afin de récupérer la page précédente de la liste. Sérialisation : exploser : faux
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Objet	Données de réponse pour une liste d’éléments demandée.

Name	Catégorie	Description	Obligatoire
data	tableau d’AgentObject	La liste des articles demandés.	Yes
premier_identifiant	string	Le premier ID représenté dans cette liste.	No
has_more	booléen	Une valeur indiquant s’il existe des valeurs supplémentaires disponibles non capturées dans cette liste.	Yes
last_id	string	Le dernier ID représenté dans cette liste.	No

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - obtenir un agent

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

Récupère l’agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent à récupérer.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - Mettre à jour l’agent

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

Met à jour l’agent en ajoutant une nouvelle version s’il existe des modifications apportées à la définition de l’agent. Si aucune modification n’est apportée, retourne la version de l’agent existante.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent à récupérer.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

En-tête de requête

Name	Obligatoire	Catégorie	Description
Foundry-Features	No	string Valeurs possibles : `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Un indicateur de fonctionnalité est obligatoire lors de l’utilisation d’opérations d’aperçu ou de modification des ressources d’aperçu persistantes.

Corps de la requête

Content-Type : application/json

Name	Catégorie	Description	Obligatoire
Définition	AgentDefinition		Yes
Type └	AgentKind		Yes
└rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - Supprimer l’agent

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

Supprime un agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent à supprimer.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DeleteAgentResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - Mettre à jour l’agent à partir du manifeste

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

Met à jour l’agent à partir d’un manifeste en ajoutant une nouvelle version s’il existe des modifications apportées à la définition de l’agent. Si aucune modification n’est apportée, retourne la version de l’agent existante.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent à mettre à jour.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Corps de la requête

Content-Type : application/json

Name	Catégorie	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Yes
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Yes

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - créer une version de l’agent

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

Créez une version de l’agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom unique qui identifie l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. - Doit commencer et se terminer par des caractères alphanumériques, - Peut contenir des traits d’union au milieu - Ne doit pas dépasser 63 caractères.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

En-tête de requête

Name	Obligatoire	Catégorie	Description
Foundry-Features	No	string Valeurs possibles : `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	Un indicateur de fonctionnalité est obligatoire lors de l’utilisation d’opérations d’aperçu ou de modification des ressources d’aperçu persistantes.

Corps de la requête

Content-Type : application/json

Name	Catégorie	Description	Obligatoire
Définition	AgentDefinition		Yes
Type └	AgentKind		Yes
└rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentVersionObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - répertorier les versions de l’agent

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

Retourne la liste des versions d’un agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent pour lequel récupérer des versions.
limit	query	No	entier (int32)	Une limite au nombre d’objets à retourner. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20. Sérialisation : exploser : faux
order	query	No	string Valeurs possibles : `asc`, `desc`	Triez l’ordre en fonction de l’horodatage `created_at` des objets. `asc` pour l’ordre croissant et`desc` dans l’ordre décroissant. Sérialisation : exploser : faux
Après	query	No	string	Un curseur pour la pagination. `after` est un identifiant d’objet qui définit votre place dans la liste. Par exemple, si vous envoyez une requête de liste et vous recevez 100 objets qui se terminent par obj_foo, votre Un appel ultérieur peut inclure after=obj_foo afin de récupérer la page suivante de la liste. Sérialisation : exploser : faux
before	query	No	string	Un curseur pour la pagination. `before` est un identifiant d’objet qui définit votre place dans la liste. Par exemple, si vous envoyez une requête de liste et vous recevez 100 objets qui se terminent par obj_foo, votre l'appel suivant peut inclure before=obj_foo afin de récupérer la page précédente de la liste. Sérialisation : exploser : faux
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Objet	Données de réponse pour une liste d’éléments demandée.

Name	Catégorie	Description	Obligatoire
data	tableau d’AgentVersionObject	La liste des articles demandés.	Yes
premier_identifiant	string	Le premier ID représenté dans cette liste.	No
has_more	booléen	Une valeur indiquant s’il existe des valeurs supplémentaires disponibles non capturées dans cette liste.	Yes
last_id	string	Le dernier ID représenté dans cette liste.	No

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - obtenir la version de l’agent

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

Récupère une version spécifique d’un agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent à récupérer.
agent_version	path	Yes	string	Version de l’agent à récupérer.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentVersionObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents - Supprimer la version de l’agent

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

Supprime une version spécifique d’un agent.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom de l’agent à supprimer.
agent_version	path	Yes	string	Version de l’agent à supprimer
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DeleteAgentVersionResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents : créer une version de l’agent à partir du manifeste

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

Créez une version d’agent à partir d’un manifeste.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
agent_name	path	Yes	string	Nom unique qui identifie l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. - Doit commencer et se terminer par des caractères alphanumériques, - Peut contenir des traits d’union au milieu - Ne doit pas dépasser 63 caractères.
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Corps de la requête

Content-Type : application/json

Name	Catégorie	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Yes
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Yes

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentVersionObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Agents : créer un agent à partir du manifeste

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

Crée un agent à partir d’un manifeste.

Paramètres d’URI

Name	Dans	Obligatoire	Catégorie	Description
endpoint	server	Yes	string	Point de terminaison Project foundry dans le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name} ». Si vous n’avez qu’un seul Project dans votre hub Foundry ou pour cibler la Project par défaut dans votre hub, utilisez le formulaire « https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project »
version de l'API	query	Yes	string	Version de l’API à utiliser pour cette opération. Sérialisation : exploser : faux

Corps de la requête

Content-Type : application/json

Name	Catégorie	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Yes
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
nom	string	Nom unique qui identifie l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. - Doit commencer et se terminer par des caractères alphanumériques, - Peut contenir des traits d’union au milieu - Ne doit pas dépasser 63 caractères. Contraintes : maxLength : 63	Yes
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Yes

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Components

A2APreviewTool

Agent implémentant le protocole A2A.

Name	Catégorie	Description	Obligatoire
agent_card_path	string	Chemin d’accès à la carte de l’agent par rapport au `base_url`. S’il n’est pas fourni, la valeur par défaut est `/.well-known/agent-card.json`	No
base_url	chaîne (uri)	URL de base de l’agent.	No
project_connection_id	string	ID de connexion dans le projet pour le serveur A2A. La connexion stocke l’authentification et d’autres détails de connexion nécessaires pour se connecter au serveur A2A.	No
type	enum	Type de l’outil. A toujours la valeur `"a2a_preview`. Valeurs possibles : `a2a_preview`	Yes

AISearchIndexResource

Ressource d’index de recherche IA.

Name	Catégorie	Description	Obligatoire
filter	string	chaîne de filtre pour la ressource de recherche. En savoir plus ici.	No
index_asset_id	string	ID de ressource d’index pour la ressource de recherche.	No
nom_de_l'index	string	Nom d’un index dans un IndexResource attaché à cet agent.	No
project_connection_id	string	ID de connexion d’index dans un IndexResource attaché à cet agent.	No
type_de_requête	AzureAISearchQueryType	Types de requêtes disponibles pour l’outil Recherche Azure AI.	No
top_k	entier (int32)	Nombre de documents à récupérer à partir de la recherche et présents au modèle.	No

AgentDefinition

Discriminateur pour AgentDefinition

Ce composant utilise la propriété kind pour faire la distinction entre différents types :

Valeur de type	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition

Name	Catégorie	Description	Obligatoire
kind	AgentKind		Yes
rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Yes

AgentDéfinitionOptInKeys

Clés d’activation des fonctionnalités pour les opérations de définition d’agents prenant en charge les agents hébergés ou de workflow.

Propriété	Valeur
Type	string
Valeurs	`HostedAgents=V1Preview` `WorkflowAgents=V1Preview`

AgentKind

Propriété	Valeur
Type	string
Valeurs	`prompt` `hosted` `workflow`

AgentObject

Name	Catégorie	Description	Obligatoire
id	string	Identificateur unique de l’agent.	Yes
nom	string	Nom de l’agent. Contraintes : maxLength : 63	Yes
Objet	enum	Type d’objet, qui est toujours « agent ». Valeurs possibles : `agent`	Yes
versions	Objet	Dernière version de l’agent.	Yes
└> dernière version	AgentVersionObject		Yes

AgentProtocol

Propriété	Valeur
Type	string
Valeurs	`activity_protocol` `responses`

AgentVersionObject

Name	Catégorie	Description	Obligatoire
date_de_création	FoundryTimestamp		Yes
Définition	AgentDefinition		Yes
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
id	string	Identificateur unique de la version de l’agent.	Yes
metadata	objet (nullable)	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	Yes
nom	string	Nom de l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. Contraintes : maxLength : 256	Yes
Objet	enum	Type d’objet, qui est toujours « agent.version ». Valeurs possibles : `agent.version`	Yes
Version	string	Identificateur de version de l’agent. Les agents sont immuables et chaque mise à jour crée une nouvelle version tout en conservant le même nom.	Yes

ApiErrorResponse

Réponse d’erreur pour les échecs d’API.

Name	Catégorie	Description	Obligatoire	Par défaut
erreur	OpenAI.Error		Yes

AzureAISearchQueryType

Types de requêtes disponibles pour l’outil Recherche Azure AI.

Propriété	Valeur
Description	Types de requêtes disponibles pour l’outil Recherche Azure AI.
Type	string
Valeurs	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

Informations de définition d’entrée pour un outil de recherche d’ia Azure tel qu’il est utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
azure_ai_search	AzureAISearchToolResource	Ensemble de ressources d’index utilisées par l’outil `azure_ai_search` .	Yes
Index └>	tableau d’AISearchIndexResource	Index attachés à cet agent. Il peut y avoir un maximum de 1 index ressource attachée à l’agent. Contraintes : maxItems : 1	Yes
type	enum	Type d’objet, qui est toujours « azure_ai_search ». Valeurs possibles : `azure_ai_search`	Yes

AzureAISearchToolResource

Ensemble de ressources d’index utilisées par l’outil azure_ai_search .

Name	Catégorie	Description	Obligatoire	Par défaut
index	tableau d’AISearchIndexResource	Index attachés à cet agent. Il peut y avoir un maximum de 1 index ressource attachée à l’agent. Contraintes : maxItems : 1	Yes

AzureFunctionBinding

Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.

Name	Catégorie	Description	Obligatoire
storage_queue	AzureFunctionStorageQueue	Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.	Yes
└queue_name	string	Nom d’une file d’attente de stockage de fonctions Azure.	Yes
└queue_service_endpoint	string	URI du service file d’attente stockage Azure vous permettant de manipuler une file d’attente.	Yes
type	enum	Type de liaison, qui est toujours « storage_queue ». Valeurs possibles : `storage_queue`	Yes

AzureFunctionDefinition

Définition de la fonction Azure.

Name	Catégorie	Description	Obligatoire
function	Objet	Définition de la fonction Azure et de ses paramètres.	Yes
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	No
└─ Nom	string	Nom de la fonction à appeler.	Yes
└─ Paramètres	Objet	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON.	Yes
input_binding	AzureFunctionBinding	Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.	Yes
└storage_queue	AzureFunctionStorageQueue	File d’attente de stockage.	Yes
└─ Type	enum	Type de liaison, qui est toujours « storage_queue ». Valeurs possibles : `storage_queue`	Yes
output_binding	AzureFunctionBinding	Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.	Yes
└storage_queue	AzureFunctionStorageQueue	File d’attente de stockage.	Yes
└─ Type	enum	Type de liaison, qui est toujours « storage_queue ». Valeurs possibles : `storage_queue`	Yes

AzureFunctionStorageQueue

Structure permettant de conserver le nom et l’URI de la file d’attente de stockage.

Name	Catégorie	Description	Obligatoire	Par défaut
queue_name	string	Nom d’une file d’attente de stockage de fonctions Azure.	Yes
queue_service_endpoint	string	URI du service file d’attente stockage Azure vous permettant de manipuler une file d’attente.	Yes

AzureFunctionTool

Informations de définition d’entrée pour un outil de fonction Azure, comme utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
azure_function	AzureFunctionDefinition	Définition de la fonction Azure.	Yes
Fonction └>	Objet	Définition de la fonction Azure et de ses paramètres.	Yes
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	No
└─ Nom	string	Nom de la fonction à appeler.	Yes
└─ Paramètres	Objet	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON.	Yes
└input_binding	AzureFunctionBinding	File d’attente de stockage d’entrée. Le déclencheur de stockage de file d’attente exécute une fonction en tant que messages qui lui sont ajoutés.	Yes
└output_binding	AzureFunctionBinding	File d’attente de stockage de sortie. La fonction écrit la sortie dans cette file d’attente lorsque les éléments d’entrée sont traités.	Yes
type	enum	Type d’objet, qui est toujours « browser_automation ». Valeurs possibles : `azure_function`	Yes

BingCustomSearchConfiguration

Configuration de recherche personnalisée Bing.

Name	Catégorie	Description	Obligatoire
count	entier (int64)	Nombre de résultats de recherche à retourner dans la réponse de l’API Bing	No
freshness	string	Filtrez les résultats de la recherche selon un intervalle de temps spécifique. Consultez les valeurs acceptées ici.	No
nom_instance	string	Nom de l’instance de configuration personnalisée donnée à la configuration.	Yes
Marché	string	Le marché d’où proviennent les résultats.	No
project_connection_id	string	Project ID de connexion pour la mise à l’aide de la recherche Bing	Yes
set_lang	string	Langue à utiliser pour les chaînes d’interface utilisateur lors de l’appel de l’API Bing.	No

BingCustomSearchPreviewTool

Informations de définition d’entrée pour un outil de recherche personnalisée Bing tel qu’utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
bing_custom_search_preview	BingCustomSearchToolParameters	Paramètres de l’outil de recherche personnalisée Bing.	Yes
└search_configurations	tableau de BingCustomSearchConfiguration	Connexions de projet attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	Yes
type	enum	Type d’objet, qui est toujours « bing_custom_search_preview ». Valeurs possibles : `bing_custom_search_preview`	Yes

BingCustomSearchToolParameters

Paramètres de l’outil de recherche personnalisée Bing.

Name	Catégorie	Description	Obligatoire	Par défaut
search_configurations	tableau de BingCustomSearchConfiguration	Connexions de projet attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	Yes

BingGroundingSearchConfiguration

Configuration de recherche pour Bing Grounding

Name	Catégorie	Description	Obligatoire
count	entier (int64)	Nombre de résultats de recherche à retourner dans la réponse de l’API Bing	No
freshness	string	Filtrez les résultats de la recherche selon un intervalle de temps spécifique. Consultez les valeurs acceptées ici.	No
Marché	string	Le marché d’où proviennent les résultats.	No
project_connection_id	string	Project ID de connexion pour la mise à l’aide de la recherche Bing	Yes
set_lang	string	Langue à utiliser pour les chaînes d’interface utilisateur lors de l’appel de l’API Bing.	No

BingGroundingSearchToolParameters

Paramètres de l’outil de recherche bing grounding.

Name	Catégorie	Description	Obligatoire	Par défaut
search_configurations	tableau de BingGroundingSearchConfiguration	Configurations de recherche attachées à cet outil. Il peut y avoir un maximum de 1 ressource de configuration de recherche attachée à l’outil. Contraintes : maxItems : 1	Yes

BingGroundingTool

Informations de définition d’entrée pour un outil de recherche bing grounding tel qu’utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
bing_grounding	BingGroundingSearchToolParameters	Paramètres de l’outil de recherche bing grounding.	Yes
└search_configurations	tableau de BingGroundingSearchConfiguration	Configurations de recherche attachées à cet outil. Il peut y avoir un maximum de 1 ressource de configuration de recherche attachée à l’outil. Contraintes : maxItems : 1	Yes
type	enum	Type d’objet, qui est toujours « bing_grounding ». Valeurs possibles : `bing_grounding`	Yes

BrowserAutomationPreviewTool

Informations de définition d’entrée pour un outil Browser Automation, comme utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
browser_automation_preview	BrowserAutomationToolParameters	Définition des paramètres d’entrée pour l’outil Browser Automation.	Yes
Connexion └>	BrowserAutomationToolConnectionParameters	Paramètres de connexion de projet associés à l’outil Browser Automation.	Yes
type	enum	Type d’objet, qui est toujours « browser_automation_preview ». Valeurs possibles : `browser_automation_preview`	Yes

BrowserAutomationToolConnectionParameters

Définition des paramètres d’entrée pour la connexion utilisée par l’outil Browser Automation.

Name	Catégorie	Description	Obligatoire	Par défaut
project_connection_id	string	ID de la connexion du projet à votre ressource playwright Azure.	Yes

BrowserAutomationToolParameters

Définition des paramètres d’entrée pour l’outil Browser Automation.

Name	Catégorie	Description	Obligatoire	Par défaut
Connexion	BrowserAutomationToolConnectionParameters	Définition des paramètres d’entrée pour la connexion utilisée par l’outil Browser Automation.	Yes
└project_connection_id	string	ID de la connexion du projet à votre ressource playwright Azure.	Yes

CaptureStructuredOutputsTool

Outil de capture de sorties structurées

Name	Catégorie	Description	Obligatoire
outputs	StructuredOutputDefinition	Sortie structurée pouvant être produite par l’agent.	Yes
└─ Description	string	Description de la sortie à émettre. Utilisé par le modèle pour déterminer quand émettre la sortie.	Yes
└─ Nom	string	Nom de la sortie structurée.	Yes
└─ Schéma	Objet	Schéma JSON pour la sortie structurée.	Yes
└─ stricte	booléen (nullable)	Indique s’il faut appliquer une validation stricte. `true`par défaut .	Yes
type	enum	Type de l’outil. A toujours la valeur `capture_structured_outputs`. Valeurs possibles : `capture_structured_outputs`	Yes

CreateAgentFromManifestRequest

Name	Catégorie	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Yes
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
nom	string	Nom unique qui identifie l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. - Doit commencer et se terminer par des caractères alphanumériques, - Peut contenir des traits d’union au milieu - Ne doit pas dépasser 63 caractères. Contraintes : maxLength : 63	Yes
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Yes

CreateAgentRequest

Name	Catégorie	Description	Obligatoire
Définition	AgentDefinition		Yes
Type └	AgentKind		Yes
└rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
nom	string	Nom unique qui identifie l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. - Doit commencer et se terminer par des caractères alphanumériques, - Peut contenir des traits d’union au milieu - Ne doit pas dépasser 63 caractères. Contraintes : maxLength : 63	Yes

CreateAgentVersionFromManifestRequest

Name	Catégorie	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Yes
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Yes

CreateAgentVersionRequest

Name	Catégorie	Description	Obligatoire
Définition	AgentDefinition		Yes
Type └	AgentKind		Yes
└rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No

DeleteAgentResponse

Objet de l’agent supprimé

Name	Catégorie	Description	Obligatoire
supprimé	booléen	Indique si l’agent a été correctement supprimé.	Yes
nom	string	Nom de l’agent.	Yes
Objet	enum	Type d’objet. Toujours « agent.deleted ». Valeurs possibles : `agent.deleted`	Yes

DeleteAgentVersionResponse

Objet de version de l’agent supprimé

Name	Catégorie	Description	Obligatoire
supprimé	booléen	Indique si l’agent a été correctement supprimé.	Yes
nom	string	Nom de l’agent.	Yes
Objet	enum	Type d’objet. Toujours « agent.version.deleted ». Valeurs possibles : `agent.version.deleted`	Yes
Version	string	Identificateur de version de l’agent.	Yes

FabricDataAgentToolParameters

Paramètres de l’outil d’agent de données fabric.

Name	Catégorie	Description	Obligatoire	Par défaut
project_connections	tableau d’ToolProjectConnection	Connexions de projet attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	No

FoundryTimestamp

Type : entier

Format : unixtime

HostedAgentDefinition

Définition de l’agent hébergé.

Name	Catégorie	Description	Obligatoire
container_protocol_versions	tableau de ProtocolVersionRecord	Protocoles pris en charge par l’agent pour la communication d’entrée des conteneurs.	Yes
cpu	string	Configuration du processeur pour l’agent hébergé.	Yes
environment_variables	Objet	Variables d’environnement à définir dans le conteneur d’agent hébergé.	No
image	string	ID d’image de l’agent, applicable aux agents hébergés en fonction de l’image.	No
kind	enum	Valeurs possibles : `hosted`	Yes
memory	string	Configuration de la mémoire de l’agent hébergé.	Yes
rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Yes
tools	tableau d’OpenAI.Tool	Un tableau d’outils que le modèle de l’agent hébergé peut appeler lors de la génération d’une réponse. Vous peut spécifier l’outil à utiliser en définissant le `tool_choice` paramètre.	No

MemorySearchOptions

Options de recherche de mémoire.

Name	Catégorie	Description	Obligatoire	Par défaut
max_memories	entier (int32)	Nombre maximal d’éléments de mémoire à retourner.	No

MemorySearchPreviewTool

Outil permettant d’intégrer des souvenirs dans l’agent.

Name	Catégorie	Description	Obligatoire	Par défaut
memory_store_name	string	Nom du magasin de mémoire à utiliser.	Yes
scope	string	Espace de noms utilisé pour regrouper et isoler les souvenirs, tels qu’un ID d’utilisateur. Limite les mémoires pouvant être récupérées ou mises à jour. Utilisez une variable `{{$userId}}` spéciale pour étendre les mémoires à l’utilisateur connecté actuel.	Yes
search_options	MemorySearchOptions	Options de recherche de mémoire.	No
└max_memories	entier (int32)	Nombre maximal d’éléments de mémoire à retourner.	No
type	enum	Type de l’outil. A toujours la valeur `memory_search_preview`. Valeurs possibles : `memory_search_preview`	Yes
update_delay	entier (int32)	Délai d’attente avant de mettre à jour les souvenirs après l’inactivité (secondes). Valeur par défaut 300.	No	300

MicrosoftFabricPreviewTool

Informations de définition d’entrée pour un outil de Microsoft Fabric tel qu’il est utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
fabric_dataagent_preview	FabricDataAgentToolParameters	Paramètres de l’outil d’agent de données fabric.	Yes
└project_connections	tableau d’ToolProjectConnection	Connexions de projet attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	No
type	enum	Type d’objet, qui est toujours « fabric_dataagent_preview ». Valeurs possibles : `fabric_dataagent_preview`	Yes

OpenAI.ApplyPatchToolParam

Appliquer l’outil de patch

Permet à l’Assistant de créer, supprimer ou mettre à jour des fichiers à l’aide de différences unifiées.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Type de l’outil. A toujours la valeur `apply_patch`. Valeurs possibles : `apply_patch`	Yes	apply_patch

OpenAI.ApproximateLocation

Name	Catégorie	Description	Obligatoire	Par défaut
city	chaîne (nullable)		No
country	chaîne (nullable)		No
region	chaîne (nullable)		No
timezone	chaîne (nullable)		No
type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Yes	Approximative

OpenAI.AutoCodeInterpreterToolParam

Paramètres de l’outil d’interprétation automatique de code

Configuration d’un conteneur d’interpréteur de code. Vous pouvez éventuellement spécifier les ID des fichiers pour exécuter le code.

Name	Catégorie	Description	Obligatoire	Par défaut
identifiants_de_fichiers	tableau de chaînes	Une liste facultative de fichiers chargés à mettre au service de votre code. Contraintes : maxObjets : 50	No
limite_de_mémoire	OpenAI.ContainerMemoryLimit (annulable)		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Politique d’accès réseau pour le conteneur.	No
type	enum	A toujours la valeur `auto`. Valeurs possibles : `auto`	Yes	auto

OpenAI.CodeInterpreterTool

Interpréteur de code

Outil qui exécute du code Python afin d'aider à générer une réponse à une invite.

Name	Catégorie	Description	Obligatoire	Par défaut
container	ou OpenAI.AutoCodeInterpreterToolParam	Conteneur d’interpréteur de code. Il peut s’agir d’un ID de conteneur ou d’un objet qui spécifie les ID de fichier chargés à mettre à la disposition de votre code, ainsi qu’un paramètre facultatif `memory_limit` . S’il n’est pas fourni, le service part du principe automatique.	No
type	enum	Type de l’outil d’interpréteur de code. A toujours la valeur `code_interpreter`. Valeurs possibles : `code_interpreter`	Yes

OpenAI.ComparisonFilter

Filtre de comparaison

Filtre utilisé pour comparer une clé d’attribut spécifiée à une valeur donnée à l’aide d’une opération de comparaison définie.

Name	Catégorie	Description	Obligatoire	Par défaut
key	string	La clé à comparer avec la valeur.	Yes
type	enum	Spécifie l’opérateur de comparaison : `eq`, , `negt`, `gteltlte`, , `in`, . `nin` - `eq`:Égale - `ne`: non égal - `gt` : plus grand que - `gte`: supérieur ou égal à - `lt`:moins de - `lte`: inférieur ou égal à - `in`:Dans - `nin`: pas dans Valeurs possibles : `eq`, , `negt`, `gte`, `ltlte`	Yes	eq
value	chaîne ou OpenAI.numeric ou booléen ou array of string ou OpenAI.numeric	Valeur à comparer à la clé d’attribut ; prend en charge les types chaîne, nombre ou booléen.	Yes

OpenAI.CompoundFilter

Filtre composé

Combinez plusieurs filtres à l’aide and ou or.

Name	Catégorie	Description	Obligatoire	Par défaut
filters	tableau d’OpenAI.ComparisonFilter ou d’objet	Tableau de filtres à combiner. Les éléments peuvent être `ComparisonFilter` ou `CompoundFilter`.	Yes
type	enum	Type d’opération : `and` ou `or`. Valeurs possibles : `and`, `or`	Yes

OpenAI.ComputerEnvironment

Propriété	Valeur
Type	string
Valeurs	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerUsePreviewTool

Aperçu de l’utilisation de l’ordinateur

Outil qui contrôle un ordinateur virtuel.

Name	Catégorie	Description	Obligatoire	Par défaut
hauteur_affichage	OpenAI.integer		Yes
largeur d'affichage	OpenAI.integer		Yes
environment	OpenAI.ComputerEnvironment		Yes
type	enum	Type de l’outil d’utilisation de l’ordinateur. A toujours la valeur `computer_use_preview`. Valeurs possibles : `computer_use_preview`	Yes	computer_use_preview

OpenAI.ContainerAutoParam

Name	Catégorie	Description	Obligatoire	Par défaut
identifiants_de_fichiers	tableau de chaînes	Une liste facultative de fichiers chargés à mettre au service de votre code. Contraintes : maxObjets : 50	No
limite_de_mémoire	OpenAI.ContainerMemoryLimit (annulable)		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Politique d’accès réseau pour le conteneur.	No
compétences	array d’OpenAI.ContainerSkill	Une liste optionnelle des compétences référencées par identification ou données en ligne. Contraintes : maxObjets : 200	No
type	enum	Crée automatiquement un conteneur pour cette requête Valeurs possibles : `container_auto`	Yes	container_auto

OpenAI.ContainerMemoryLimit

Propriété	Valeur
Type	string
Valeurs	`1g` `4g` `16g` `64g`

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Catégorie	Description	Obligatoire	Par défaut
allowed_domains	tableau de chaînes	Une liste des domaines autorisés lorsque le type est `allowlist`. Contraintes : minObjets : 1	Yes
domain_secrets	array of OpenAI.ContainerNetworkPolicyDomainSecretParam	Secrets optionnels à portée de domaine pour les domaines autorisés. Contraintes : minObjets : 1	No
type	enum	Autoriser l’accès au réseau sortant uniquement à des domaines spécifiés. A toujours la valeur `allowlist`. Valeurs possibles : `allowlist`	Yes	allowlist

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Désactivez l’accès au réseau sortant. A toujours la valeur `disabled`. Valeurs possibles : `disabled`	Yes	handicapé

OpenAI.ContainerNetworkPolicyDomainSecretParam

Name	Catégorie	Description	Obligatoire
domain	string	Le domaine associé au secret. Contraintes : minLength : 1	Yes
nom	string	Le nom du secret à injecter pour le domaine. Contraintes : minLength : 1	Yes
value	string	La valeur secrète à injecter pour le domaine. Contraintes : minLongueur : 1, maxLongueur : 10485760	Yes

OpenAI.ContainerNetworkPolicyParam

Politique d’accès réseau pour le conteneur.

Discriminateur pour OpenAI.ContainerNetworkPolicyParam

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.ContainerNetworkPolicyParamType		Yes

OpenAI.ContainerNetworkPolicyParamType

Propriété	Valeur
Type	string
Valeurs	`disabled` `allowlist`

OpenAI.ContainerSkill

Discriminateur pour OpenAI.ContainerSkill

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Name	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.ContainerSkillType		Yes

OpenAI.ContainerSkillType

Propriété	Valeur
Type	string
Valeurs	`skill_reference` `inline`

OpenAI.CustomGrammarFormatParam

Format grammatical

Grammaire définie par l’utilisateur.

Name	Catégorie	Description	Obligatoire	Par défaut
Définition	string	Définition de grammaire.	Yes
Syntaxe	OpenAI.GrammarSyntax1		Yes
type	enum	Format de grammaire. A toujours la valeur `grammar`. Valeurs possibles : `grammar`	Yes	Grammaire

OpenAI.CustomTextFormatParam

Format de texte

Texte sans forme libre non contrainte.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Format de texte non contraint. A toujours la valeur `text`. Valeurs possibles : `text`	Yes	text

OpenAI.CustomToolParam

Outil personnalisé

Outil personnalisé qui traite les entrées à l’aide d’un format spécifié. En savoir plus sur les outils personnalisés

Name	Catégorie	Description	Obligatoire	Par défaut
description	string	Description facultative de l’outil personnalisé, utilisée pour fournir plus de contexte.	No
Format	OpenAI.CustomToolParamFormat	Format d’entrée de l’outil personnalisé. La valeur par défaut est un texte non entraîné.	No
└─ Type	OpenAI.CustomToolParamFormatType		Yes
nom	string	Nom de l’outil personnalisé utilisé pour l’identifier dans les appels d’outil.	Yes
type	enum	Type de l’outil personnalisé. A toujours la valeur `custom`. Valeurs possibles : `custom`	Yes	Personnalisé

OpenAI.CustomToolParamFormat

Format d’entrée de l’outil personnalisé. La valeur par défaut est un texte non entraîné.

Discriminateur pour OpenAI.CustomToolParamFormat

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Propriété	Valeur
Type	string
Valeurs	`text` `grammar`

OpenAI.Error

Name	Catégorie	Obligatoire
informations supplémentaires	Objet	No
code	chaîne (nullable)	Yes
debugInfo	Objet	No
details	tableau d’OpenAI.Error	No
Message	string	Yes
param	chaîne (nullable)	No
type	string	No

OpenAI.FileSearchTool

Recherche de fichiers

Outil qui recherche le contenu pertinent à partir de fichiers chargés.

Name	Catégorie	Description	Obligatoire	Par défaut
filters	OpenAI.Filters (annulable)		No
nombre_maximal_de_résultats	OpenAI.integer		No
options_de_classement	OpenAI.RankingOptions		No
└hybrid_search	OpenAI.HybridSearchOptions	Poids qui contrôlent la façon dont la fusion de classement réciproque équilibre les correspondances sémantiques d’incorporation de correspondances par rapport aux correspondances de mots clés éparses lorsque la recherche hybride est activée.	No
└─ classificateur	OpenAI.RankerVersionType	Outil de classement à utiliser pour la recherche de fichiers.	No
└score_threshold	OpenAI.numeric	Seuil de score pour la recherche de fichiers, nombre compris entre 0 et 1. Les nombres plus proches de 1 tenteront de retourner uniquement les résultats les plus pertinents, mais peuvent retourner moins de résultats.	No
type	enum	Type de l’outil de recherche de fichiers. A toujours la valeur `file_search`. Valeurs possibles : `file_search`	Yes	file_search
vector_store_ids	tableau de chaînes	ID des magasins vectoriels à rechercher.	Yes

OpenAI.Filters

Type : OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

OpenAI.FunctionShellToolParam

Outil coque

Outil qui permet au modèle d’exécuter des commandes shell.

Name	Catégorie	Description	Obligatoire	Par défaut
environment	OpenAI.FunctionShellToolParamEnvironment (nullable)		No
└─ Type	OpenAI.FunctionShellToolParamEnvironmentType		Yes
type	enum	Type de l’outil shell. A toujours la valeur `shell`. Valeurs possibles : `shell`	Yes	shell

OpenAI.FunctionShellToolParamEnvironment

Discriminateur pour OpenAI.FunctionShellToolParamEnvironment

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	Schema
`local`	OpenAI.FunctionShellToolParamEnvironnementLocalEnvironnementParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Name	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.FunctionShellToolParamEnvironmentType		Yes

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Catégorie	Description	Obligatoire	Par défaut
container_id	string	L’identifiant du conteneur mentionné.	Yes
type	enum	Référence à un conteneur créé avec le point de terminaison /v1/containers Valeurs possibles : `container_reference`	Yes	container_reference

OpenAI.FunctionShellToolParamEnvironnementLocalEnvironnementParam

Name	Catégorie	Description	Obligatoire	Par défaut
compétences	tableau d’OpenAI.LocalSkillParam	Une liste optionnelle de compétences. Contraintes : maxObjets : 200	No
type	enum	Utilisez un environnement informatique local. Valeurs possibles : `local`	Yes	locale

OpenAI.FunctionShellToolParamEnvironmentType

Propriété	Valeur
Type	string
Valeurs	`container_auto` `local` `container_reference`

OpenAI.FunctionTool

Fonction

Définit une fonction dans votre propre code que le modèle peut choisir d’appeler.

Name	Catégorie	Description	Obligatoire	Par défaut
description	chaîne (nullable)		No
nom	string	Nom de la fonction à appeler.	Yes
parameters	objet (nullable)		Yes
strict	booléen (nullable)		Yes
type	enum	Type de l’outil de fonction. A toujours la valeur `function`. Valeurs possibles : `function`	Yes	function

OpenAI.GrammarSyntax1

Propriété	Valeur
Type	string
Valeurs	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Catégorie	Description	Obligatoire	Par défaut
embedding_weight	OpenAI.numeric		Yes
text_weight	OpenAI.numeric		Yes

OpenAI.ImageGenActionEnum

Propriété	Valeur
Type	string
Valeurs	`generate` `edit` `auto`

OpenAI.ImageGenTool

Outil de génération d’images

Outil qui génère des images à l’aide des modèles d’image GPT.

Modèles valides :

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

Name	Catégorie	Description	Obligatoire	Par défaut
action	OpenAI.ImageGenActionEnum		No
Arrière-plan	enum	Type d’arrière-plan pour l’image générée. Valeurs possibles : `transparent`, `opaque`, ou `auto`. Valeur par défaut : `auto`. Valeurs possibles : `transparent`, , `opaqueauto`	No	auto
input_fidelity	OpenAI.InputFidelity (annulable)	Contrôler l’effort que le modèle exercera pour correspondre au style et aux caractéristiques, en particulier les caractéristiques faciales, des images d’entrée. Ce paramètre n’est pris en charge que pour `gpt-image-1` et `gpt-image-1.5` et les modèles ultérieurs, non pris en charge pour `gpt-image-1-mini`. Supports `high` et `low`. La valeur par défaut est `low`.	No
masque_d'image_d'entrée	OpenAI.ImageGenToolInputImageMask		No
└ file_id	string		No
└ image_url	chaîne (uri)		No
model	chaîne (voir les modèles valides ci-dessous)		No
Modération	enum	Niveau de modération de l’image générée. Valeur par défaut : `auto`. Valeurs possibles : `auto`, `low`	No	auto
compression_de_sortie	OpenAI.integer	Contraintes : min : 0, max : 100	No	100
format de sortie	enum	Format de sortie de l’image générée. Un des `png`, ou `webp` `jpeg`. Valeur par défaut : `png`. Valeurs possibles : `png`, , `webpjpeg`	No	png
images partielles	OpenAI.integer	Contraintes : min : 0, max : 3	No
Qualité	enum	Qualité de l’image générée. Un des `low`, , `medium`, `high`, ou `auto`. Valeur par défaut : `auto`. Valeurs possibles : `low`, , `mediumhigh`,`auto`	No	auto
size	enum	Taille de l’image générée. Un des `1024x1024`, , `1024x1536` `1536x1024`, ou `auto`. Valeur par défaut : `auto`. Valeurs possibles : `1024x1024`, , `1024x15361536x1024`,`auto`	No	auto
type	enum	Type de l’outil de génération d’images. A toujours la valeur `image_generation`. Valeurs possibles : `image_generation`	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Catégorie	Description	Obligatoire	Par défaut
identifiant_de_fichier	string		No
image_url	chaîne (uri)		No

OpenAI.InlineSkillParam

Name	Catégorie	Description	Obligatoire	Par défaut
description	string	La description de la compétence.	Yes
nom	string	Le nom de la compétence.	Yes
source	OpenAI.InlineSkillSourceParam	Charge utile de compétences en ligne	Yes
└─ données	string	Bundle zip de compétences codées en base64. Contraintes : minLongueur : 1, maxLongueur : 70254592	Yes
└─ media_type	enum	Le type média de la charge utile de compétence en ligne. Doit être `application/zip`. Valeurs possibles : `application/zip`	Yes	application/zip
└─ Type	enum	Le type de source de compétences en ligne. Doit être `base64`. Valeurs possibles : `base64`	Yes	base64
type	enum	Définit une compétence en ligne pour cette demande. Valeurs possibles : `inline`	Yes	inline

OpenAI.InlineSkillSourceParam

Charge utile de compétences en ligne

Name	Catégorie	Description	Obligatoire	Par défaut
data	string	Bundle zip de compétences codées en base64. Contraintes : minLongueur : 1, maxLongueur : 70254592	Yes
media_type	enum	Le type média de la charge utile de compétence en ligne. Doit être `application/zip`. Valeurs possibles : `application/zip`	Yes	application/zip
type	enum	Le type de source de compétences en ligne. Doit être `base64`. Valeurs possibles : `base64`	Yes	base64

OpenAI.InputFidelity

Contrôler l’effort que le modèle exercera pour correspondre au style et aux caractéristiques, en particulier les caractéristiques faciales, des images d’entrée. Ce paramètre n’est pris en charge que pour gpt-image-1 et gpt-image-1.5 et les modèles ultérieurs, non pris en charge pour gpt-image-1-mini. Supports high et low. La valeur par défaut est low.

Propriété	Valeur
Type	string
Valeurs	`high` `low`

OpenAI.LocalShellToolParam

Outil de coque local

Outil qui permet au modèle d’exécuter des commandes shell dans un environnement local.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Type de l’outil shell local. A toujours la valeur `local_shell`. Valeurs possibles : `local_shell`	Yes	local_shell

OpenAI.LocalSkillParam

Name	Catégorie	Description	Obligatoire
description	string	La description de la compétence.	Yes
nom	string	Le nom de la compétence.	Yes
path	string	Le chemin vers le répertoire contenant la compétence.	Yes

OpenAI.MCPTool

Outil MCP

Donnez au modèle l’accès à des outils supplémentaires via des serveurs MCP (Remote Model Context Protocol).

Name	Catégorie	Description	Obligatoire
outils_autorisés	tableau de chaîne ou OpenAI.MCPToolFilter		No
authorization	string	Jeton d’accès OAuth qui peut être utilisé avec un serveur MCP distant, soit avec une URL de serveur MCP personnalisée ou un connecteur de service. Votre application doit gérer le flux d’autorisation OAuth et fournir le jeton ici.	No
connector_id	enum	Identificateur des connecteurs de service, comme ceux disponibles dans ChatGPT. Oneof `server_url` ou `connector_id` doit être fourni. En savoir plus sur le service Connecteurs ici. Les valeurs actuellement prises en charge `connector_id` sont les suivantes : -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` - Calendrier Google : `connector_googlecalendar` - Google Drive : `connector_googledrive` - Microsoft Teams : `connector_microsoftteams` - Calendrier Outlook : `connector_outlookcalendar` - E-mail Outlook : `connector_outlookemail` -Sharepoint: `connector_sharepoint` Valeurs possibles : `connector_dropbox`, , `connector_gmail`, `connector_googlecalendarconnector_googledriveconnector_microsoftteamsconnector_outlookcalendar`, , `connector_outlookemailconnector_sharepoint`	No
headers	objet (nullable)		No
project_connection_id	string	ID de connexion dans le projet pour le serveur MCP. La connexion stocke l’authentification et d’autres détails de connexion nécessaires pour se connecter au serveur MCP.	No
require_approval	OpenAI.MCPToolRequireApproval ou chaîne		No
server_description	string	Description facultative du serveur MCP, utilisée pour fournir davantage de contexte.	No
server_label	string	Étiquette de ce serveur MCP, utilisée pour l’identifier dans les appels d’outils.	Yes
URL du serveur	chaîne (uri)	URL du serveur MCP. L’une ou l’autre `server_urlconnector_id` doit être Fourni.	No
type	enum	Type de l’outil MCP. A toujours la valeur `mcp`. Valeurs possibles : `mcp`	Yes

OpenAI.MCPToolFilter

Filtre outil MCP

Objet de filtre permettant de spécifier les outils autorisés.

Name	Catégorie	Description	Obligatoire	Par défaut
read_only	booléen	Indique si un outil modifie ou non les données ou est en lecture seule. Si un Le serveur MCP est annoté avec `readOnlyHint`, il correspond à ce filtre.	No
tool_names	tableau de chaînes	Liste des noms d’outils autorisés.	No

OpenAI.MCPToolRequireApproval

Name	Catégorie	Description	Obligatoire	Par défaut
toujours	OpenAI.MCPToolFilter	Objet de filtre permettant de spécifier les outils autorisés.	No
jamais	OpenAI.MCPToolFilter	Objet de filtre permettant de spécifier les outils autorisés.	No

OpenAI.RankerVersionType

Propriété	Valeur
Type	string
Valeurs	`auto` `default-2024-11-15`

OpenAI.RankingOptions

Name	Catégorie	Description	Obligatoire
hybrid_search	OpenAI.HybridSearchOptions		No
└embedding_weight	OpenAI.numeric	Poids de l’incorporation dans la fusion de classement réciproque.	Yes
└text_weight	OpenAI.numeric	Poids du texte dans la fusion de classement réciproque.	Yes
ranker	OpenAI.RankerVersionType		No
seuil de score	OpenAI.numeric		No

OpenAI.Reasoning

Reasoning

modèles gpt-5 et série o uniquement Options de configuration pour les modèles de raisonnement.

Name	Catégorie	Description	Obligatoire
effort	OpenAI.ReasoningEffort	Limite l’effort sur le raisonnement pour modèles de raisonnement. Actuellement, les valeurs prises en charge sont `none`, , `minimallow`, `medium`, `high`et `xhigh`. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés le raisonnement dans une réponse. - `gpt-5.1` `none`valeur par défaut , qui n’effectue pas de raisonnement. Les valeurs de raisonnement prises en charge sont `gpt-5.1none`, `low`, `medium`et `high`. Les appels d’outils sont pris en charge pour toutes les valeurs de raisonnement dans gpt-5.1. - Tous les modèles avant `gpt-5.1` l’effort `medium` de raisonnement par défaut, et ne prennent pas en charge `none`. - Le `gpt-5-pro` modèle prend par défaut (et prend uniquement en charge) `high` l’effort de raisonnement. - `xhigh` est pris en charge pour tous les modèles après `gpt-5.1-codex-max`.	No
generate_summary	enum (annulable)	Valeurs possibles : `auto`, , `concisedetailed`	No
summary	enum (annulable)	Valeurs possibles : `auto`, , `concisedetailed`	No

OpenAI.ReasoningEffort

Limite l’effort sur le raisonnement des modèles de raisonnement. Actuellement, les valeurs prises en charge sont none, , minimallow, medium, highet xhigh. La réduction de l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés sur le raisonnement dans une réponse.

gpt-5.1 nonevaleur par défaut , qui n’effectue pas de raisonnement. Les valeurs de raisonnement prises en charge sont gpt-5.1none, low, mediumet high. Les appels d’outils sont pris en charge pour toutes les valeurs de raisonnement dans gpt-5.1.
Tous les modèles avant gpt-5.1 l’effort medium de raisonnement par défaut, et ne prennent pas en charge none.
Le gpt-5-pro modèle prend par défaut (et prend uniquement en charge) high l’effort de raisonnement.
xhigh est pris en charge pour tous les modèles après gpt-5.1-codex-max.

Propriété	Valeur
Type	string
Nullable	Yes
Valeurs	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ResponseFormatJsonSchemaSchema

Schéma JSON

Schéma pour le format de réponse, décrit en tant qu’objet json Schema. Découvrez comment créer des schémas JSON ici.

Type : objet

OpenAI.SearchContextSize

Propriété	Valeur
Type	string
Valeurs	`low` `medium` `high`

OpenAI.SkillReferenceParam

Name	Catégorie	Description	Obligatoire	Par défaut
skill_id	string	L’ID de la compétence mentionnée. Contraintes : minLength : 1, maxLength : 64	Yes
type	enum	Fait référence à une compétence créée avec le point de terminaison /v1/skills. Valeurs possibles : `skill_reference`	Yes	skill_reference
Version	string	Version compétence optionnelle. Utilisez un entier positif ou un « plus récent ». Omets le défaut.	No

OpenAI.SpecificApplyPatchParam

Choix spécifique de l’outil de patch

Force le modèle à appeler l’outil apply_patch lors de l’exécution d’un appel d’outil.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Outil à appeler. A toujours la valeur `apply_patch`. Valeurs possibles : `apply_patch`	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Choix spécifique de l’outil shell

Force le modèle à appeler l’outil shell lorsqu’un appel d’outil est requis.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Outil à appeler. A toujours la valeur `shell`. Valeurs possibles : `shell`	Yes	shell

OpenAI.TextResponseFormatConfiguration

Objet spécifiant le format que le modèle doit générer. La configuration { "type": "json_schema" } active les sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le

Le format par défaut n’est { "type": "text" } pas doté d’options supplémentaires. Non recommandé pour le gpt-4o et les modèles plus récents : En réglant pour { "type": "json_object" } activer l’ancien mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. L’utilisation json_schema est recommandée pour les modèles qui le prennent en charge.

Discriminateur pour OpenAI.TextResponseFormatConfiguration

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Objet JSON

Format de réponse d’objet JSON. Méthode plus ancienne de génération de réponses JSON. L’utilisation json_schema est recommandée pour les modèles qui le prennent en charge. Notez que le modèle ne générera pas de JSON sans qu'un message système ou utilisateur ne lui demande de le faire.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Type de format de réponse défini. A toujours la valeur `json_object`. Valeurs possibles : `json_object`	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Texte

Format de réponse par défaut. Utilisé pour générer des réponses de texte.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Type de format de réponse défini. A toujours la valeur `text`. Valeurs possibles : `text`	Yes

OpenAI.TextResponseFormatConfigurationType

Propriété	Valeur
Type	string
Valeurs	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

Schéma JSON

Format de réponse de schéma JSON. Utilisé pour générer des réponses JSON structurées.

Name	Catégorie	Description	Obligatoire
description	string	Description de l'utilisation du format de réponse par le modèle pour déterminer comment répondre selon le format.	No
nom	string	Nom du format de réponse. Doit être a-z, A-Z, 0-9 ou contenir des traits de soulignement et tirets, avec une longueur maximale de 64.	Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schéma pour le format de réponse, décrit en tant qu’objet json Schema. Découvrez comment créer des schémas JSON ici.	Yes
strict	booléen (nullable)		No
type	enum	Type de format de réponse défini. A toujours la valeur `json_schema`. Valeurs possibles : `json_schema`	Yes

OpenAI.Tool

Outil qui peut être utilisé pour générer une réponse.

Discriminant pour OpenAI.Tool

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	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	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Outils autorisés

Limite les outils disponibles pour le modèle à un ensemble prédéfini.

Name	Catégorie	Description	Obligatoire
mode	enum	Limite les outils disponibles pour le modèle à un ensemble prédéfini. `auto` permet au modèle de choisir parmi les outils autorisés et de générer un message. `required` nécessite que le modèle appelle un ou plusieurs des outils autorisés. Valeurs possibles : `auto`, `required`	Yes
tools	tableau d’objet	Liste des définitions d’outils que le modèle doit être autorisé à appeler. Pour l’API Réponses, la liste des définitions d’outils peut ressembler à ceci : `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Yes
type	enum	Type de configuration d’outil autorisé. A toujours la valeur `allowed_tools`. Valeurs possibles : `allowed_tools`	Yes

OpenAI.ToolChoiceCodeInterpreter

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. En savoir plus sur les outils intégrés.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `code_interpreter`	Yes

OpenAI.ToolChoiceComputerUsePreview

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. En savoir plus sur les outils intégrés.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `computer_use_preview`	Yes

OpenAI.ToolChoiceCustom

Outil personnalisé

Utilisez cette option pour forcer le modèle à appeler un outil personnalisé spécifique.

Name	Catégorie	Description	Obligatoire	Par défaut
nom	string	Nom de l’outil personnalisé à appeler.	Yes
type	enum	Pour les appels d’outils personnalisés, le type est toujours `custom`. Valeurs possibles : `custom`	Yes

OpenAI.ToolChoiceFileSearch

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. En savoir plus sur les outils intégrés.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `file_search`	Yes

OpenAI.ToolChoiceFunction

Outil de fonction

Utilisez cette option pour forcer le modèle à appeler une fonction spécifique.

Name	Catégorie	Description	Obligatoire	Par défaut
nom	string	Nom de la fonction à appeler.	Yes
type	enum	Pour l’appel de fonction, le type est toujours `function`. Valeurs possibles : `function`	Yes

OpenAI.ToolChoiceImageGeneration

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. En savoir plus sur les outils intégrés.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `image_generation`	Yes

OpenAI.ToolChoiceMCP

Outil MCP

Utilisez cette option pour forcer le modèle à appeler un outil spécifique sur un serveur MCP distant.

Name	Catégorie	Description	Obligatoire
nom	chaîne (nullable)		No
server_label	string	Étiquette du serveur MCP à utiliser.	Yes
type	enum	Pour les outils MCP, le type est toujours `mcp`. Valeurs possibles : `mcp`	Yes

OpenAI.ToolChoiceParam

Comment le modèle doit sélectionner l’outil (ou les outils) à utiliser lors de la génération d’une réponse. Consultez le tools paramètre pour savoir comment spécifier les outils que le modèle peut appeler.

Discriminateur pour OpenAI.ToolChoiceParam

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	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	Catégorie	Description	Obligatoire	Par défaut
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Propriété	Valeur
Type	string
Valeurs	`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

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. En savoir plus sur les outils intégrés.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `web_search_preview`	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

Indique que le modèle doit utiliser un outil intégré pour générer une réponse. En savoir plus sur les outils intégrés.

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `web_search_preview_2025_03_11`	Yes

OpenAI.ToolType

Propriété Valeur

Type string

Valeurs 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

Recherche web localisation approximative

Emplacement approximatif de l’utilisateur.

Name	Catégorie	Description	Obligatoire	Par défaut
city	chaîne (nullable)		No
country	chaîne (nullable)		No
region	chaîne (nullable)		No
timezone	chaîne (nullable)		No
type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Yes	Approximative

OpenAI.WebSearchPreviewTool

Aperçu de la recherche web

Cet outil recherche sur le web des résultats pertinents à utiliser dans une réponse. En savoir plus sur l’outil de recherche web.

Name	Catégorie	Description	Obligatoire	Par défaut
taille_contexte_recherche	OpenAI.SearchContextSize		No
type	enum	Type de l’outil de recherche web. L’un de `web_search_preview` ou `web_search_preview_2025_03_11`. Valeurs possibles : `web_search_preview`	Yes	web_search_preview
emplacement_utilisateur	OpenAI.ApproximateLocation (nullable)		No
Ville └	chaîne (nullable)		No
Pays └>	chaîne (nullable)		No
Région └ ;	chaîne (nullable)		No
└' fuseau horaire	chaîne (nullable)		No
└─ Type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Yes	Approximative

OpenAI.WebSearchTool

Recherche web

Recherchez sur Internet des sources liées à l’invite. En savoir plus sur l’outil de recherche web.

Name	Catégorie	Description	Obligatoire	Par défaut
custom_search_configuration	WebSearchConfiguration	Configuration de recherche web pour la recherche personnalisée Bing	No
└instance_name	string	Nom de l’instance de configuration personnalisée donnée à la configuration.	Yes
└project_connection_id	string	Project ID de connexion pour la mise à l’aide de la recherche personnalisée Bing	Yes
filters	OpenAI.WebSearchToolFilters (annulable)		No
└allowed_domains	tableau de chaîne (nullable)		No
taille_contexte_recherche	enum	Conseils de haut niveau pour la quantité d’espace de fenêtre contextuelle à utiliser pour la recherche. Un des `low`, `medium`ou `high`. `medium` est la valeur par défaut. Valeurs possibles : `low`, , `mediumhigh`	No	moyenne
type	enum	Type de l’outil de recherche web. L’un de `web_search` ou `web_search_2025_08_26`. Valeurs possibles : `web_search`	Yes	recherche web
emplacement_utilisateur	OpenAI.WebSearchApproximateLocation (annulable)	Emplacement approximatif de l’utilisateur.	No
Ville └	chaîne (nullable)		No
Pays └>	chaîne (nullable)		No
Région └ ;	chaîne (nullable)		No
└' fuseau horaire	chaîne (nullable)		No
└─ Type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Yes	Approximative

OpenAI.WebSearchToolFilters

Name	Catégorie	Description	Obligatoire	Par défaut
allowed_domains	tableau de chaîne (nullable)		No

OpenAI.integer

Type : entier

Format : int64

OpenAI.numeric

Type : nombre

Format : double

OpenApiAnonymousAuthDetails

Détails de sécurité pour l’authentification anonyme OpenApi

Name	Catégorie	Description	Obligatoire	Par défaut
type	enum	Type d’objet, qui est toujours « anonyme ». Valeurs possibles : `anonymous`	Yes

OpenApiAuthDetails

détails d’authentification pour OpenApiFunctionDefinition

Discriminateur pour OpenApiAuthDetails

Ce composant utilise la propriété type pour faire la distinction entre différents types :

Valeur de type	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Name	Catégorie	Description	Obligatoire	Par défaut
type	OpenApiAuthType	Type d’authentification pour le point de terminaison OpenApi. Les types autorisés sont les suivants : - Anonyme (aucune authentification requise) - connexion Project (nécessite project_connection_id au point de terminaison, comme configuration dans AI Foundry) - Managed_Identity (nécessite l’audience pour l’authentification basée sur l’identité)	Yes

OpenApiAuthType

Type d’authentification pour le point de terminaison OpenApi. Les types autorisés sont les suivants :

Anonyme (aucune authentification requise)
connexion Project (nécessite project_connection_id au point de terminaison, comme configuration dans AI Foundry)
Managed_Identity (nécessite un public pour l’authentification basée sur l’identité)

Propriété	Valeur
Description	Type d’authentification pour le point de terminaison OpenApi. Les types autorisés sont les suivants : - Anonyme (aucune authentification requise) - connexion Project (nécessite project_connection_id au point de terminaison, comme configuration dans AI Foundry) - Managed_Identity (nécessite l’audience pour l’authentification basée sur l’identité)
Type	string
Valeurs	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Informations de définition d’entrée pour une fonction openapi.

Name	Catégorie	Description	Obligatoire
auth	OpenApiAuthDetails	détails d’authentification pour OpenApiFunctionDefinition	Yes
└─ Type	OpenApiAuthType	Le type d’authentification doit être anonyme/project_connection/managed_identity	Yes
default_params	tableau de chaînes	Liste des paramètres de spécification OpenAPI qui utiliseront les paramètres par défaut fournis par l’utilisateur	No
description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	No
functions	tableau d’objet (en lecture seule)	Liste des définitions de fonction utilisées par l’outil OpenApi	No
nom	string	Nom de la fonction à appeler.	Yes
spec	Objet	Forme de fonction openapi, décrite en tant qu’objet json Schema.	Yes

OpenApiManagedAuthDetails

Détails de sécurité pour l’authentification openApi managed_identity

Name	Catégorie	Description	Obligatoire
security_scheme	OpenApiManagedSecurityScheme	Schéma de sécurité pour l’authentification openApi managed_identity	Yes
Public └>	string	Étendue d’authentification pour managed_identity type d’authentification	Yes
type	enum	Type d’objet, qui est toujours « managed_identity ». Valeurs possibles : `managed_identity`	Yes

OpenApiManagedSecurityScheme

Schéma de sécurité pour l’authentification openApi managed_identity

Name	Catégorie	Description	Obligatoire	Par défaut
public	string	Étendue d’authentification pour managed_identity type d’authentification	Yes

OpenApiProjectConnectionAuthDetails

Détails de sécurité pour l’authentification de connexion au projet OpenApi

Name	Catégorie	Description	Obligatoire
security_scheme	OpenApiProjectConnectionSecurityScheme	Schéma de sécurité pour l’authentification openApi managed_identity	Yes
└project_connection_id	string	id de connexion Project pour Project type d’authentification de connexion	Yes
type	enum	Type d’objet, qui est toujours « project_connection ». Valeurs possibles : `project_connection`	Yes

OpenApiProjectConnectionSecurityScheme

Schéma de sécurité pour l’authentification openApi managed_identity

Name	Catégorie	Description	Obligatoire	Par défaut
project_connection_id	string	id de connexion Project pour Project type d’authentification de connexion	Yes

OpenApiTool

Informations de définition d’entrée pour un outil OpenAPI tel qu’utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
openapi	OpenApiFunctionDefinition	Informations de définition d’entrée pour une fonction openapi.	Yes
└> authentification	OpenApiAuthDetails	Ouvrir les détails de l’authentification de l’API	Yes
└default_params	tableau de chaînes	Liste des paramètres de spécification OpenAPI qui utiliseront les paramètres par défaut fournis par l’utilisateur	No
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	No
Fonctions └ ;	tableau d’objet (en lecture seule)	Liste des définitions de fonction utilisées par l’outil OpenApi	No
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	No
└─ Nom	string	Nom de la fonction à appeler.	Yes
└─ Paramètres	Objet	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON.	Yes
└─ Nom	string	Nom de la fonction à appeler.	Yes
Spec └ ;	Objet	Forme de fonction openapi, décrite en tant qu’objet json Schema.	Yes
type	enum	Type d’objet, qui est toujours « openapi ». Valeurs possibles : `openapi`	Yes

PageOrder

Propriété	Valeur
Type	string
Valeurs	`asc` `desc`

PromptAgentDefinition

Définition de l’agent d’invite

Name	Catégorie	Description	Obligatoire	Par défaut
instructions	chaîne (nullable)	Message système (ou développeur) inséré dans le contexte du modèle.	No
kind	enum	Valeurs possibles : `prompt`	Yes
model	string	Déploiement de modèle à utiliser pour cet agent.	Yes
rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Yes
reasoning	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	No
Effort └ ;	OpenAI.ReasoningEffort	Limite l’effort sur le raisonnement pour modèles de raisonnement. Actuellement, les valeurs prises en charge sont `none`, , `minimallow`, `medium`, `high`et `xhigh`. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés le raisonnement dans une réponse. - `gpt-5.1` `none`valeur par défaut , qui n’effectue pas de raisonnement. Les valeurs de raisonnement prises en charge sont `gpt-5.1none`, `low`, `medium`et `high`. Les appels d’outils sont pris en charge pour toutes les valeurs de raisonnement dans gpt-5.1. - Tous les modèles avant `gpt-5.1` l’effort `medium` de raisonnement par défaut, et ne prennent pas en charge `none`. - Le `gpt-5-pro` modèle prend par défaut (et prend uniquement en charge) `high` l’effort de raisonnement. - `xhigh` est pris en charge pour tous les modèles après `gpt-5.1-codex-max`.	No
└─ générer_resume	enum (annulable)	Valeurs possibles : `auto`, , `concisedetailed`	No
Résumé └>	enum (annulable)	Valeurs possibles : `auto`, , `concisedetailed`	No
structured_inputs	Objet	Ensemble d’entrées structurées qui peuvent participer aux liaisons d’arguments de modèle ou de substitution de modèle d’invite.	No
Température	nombre (float) (annulable)	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées telles que 0,8 rendent la sortie plus aléatoire, tandis que des valeurs inférieures telles que 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou `top_p` pas les deux. Contraintes : min : 0, max : 2	No	1
text	PromptAgentDefinitionTextOptions	Options de configuration d’une réponse texte à partir du modèle. Peut être du texte brut ou des données JSON structurées.	No
└─ Format	OpenAI.TextResponseFormatConfiguration	Objet spécifiant le format que le modèle doit générer. La configuration `{ "type": "json_schema" }` active les sorties structurées, qui garantit que le modèle correspondra à votre schéma JSON fourni. En savoir plus dans le Le format par défaut n’est `{ "type": "text" }` pas doté d’options supplémentaires. Non recommandé pour les modèles gpt-4o et versions ultérieures : Activer `{ "type": "json_object" }` permet de passer au mode JSON plus ancien, qui garantit que le message généré par le modèle est json valide. Utilisation de `json_schema` La solution est préférée pour les modèles qui la prennent en charge.	No
tool_choice	string ou OpenAI.ToolChoiceParam	Comment le modèle doit sélectionner l’outil (ou les outils) à utiliser lors de la génération d’une réponse. Consultez le `tools` paramètre pour savoir comment spécifier les outils que le modèle peut appeler.	No
tools	tableau d’OpenAI.Tool	Un tableau d’outils que le modèle peut appeler lors de la génération d’une réponse. Vous peut spécifier l’outil à utiliser en définissant le `tool_choice` paramètre.	No
top_p	nombre (float) (annulable)	Une alternative à l’échantillonnage avec la température, appelée échantillonnage de noyau, où le modèle considère les résultats des tokens avec une probabilité top_p masse. Par conséquent, 0.1 signifie que seuls les jetons comprenant les 10 % supérieurs de la masse de probabilité% sont pris en compte. sont considérés. Nous recommandons généralement de modifier cela, ou `temperature` pas les deux. Contraintes : min : 0, max : 1	No	1

PromptAgentDefinitionTextOptions

Options de configuration d’une réponse texte à partir du modèle. Peut être du texte brut ou des données JSON structurées.

Name	Catégorie	Description	Obligatoire	Par défaut
Format	OpenAI.TextResponseFormatConfiguration	Objet spécifiant le format que le modèle doit générer. La configuration `{ "type": "json_schema" }` active les sorties structurées, qui garantit que le modèle correspondra à votre schéma JSON fourni. En savoir plus dans le Le format par défaut n’est `{ "type": "text" }` pas doté d’options supplémentaires. Non recommandé pour les modèles gpt-4o et versions ultérieures : Activer `{ "type": "json_object" }` permet de passer au mode JSON plus ancien, qui garantit que le message généré par le modèle est json valide. Utilisation de `json_schema` La solution est préférée pour les modèles qui la prennent en charge.	No

ProtocolVersionRecord

Mappage d’enregistrements pour un protocole unique et sa version.

Name	Catégorie	Description	Obligatoire	Par défaut
protocol	AgentProtocol		Yes
Version	string	Chaîne de version pour le protocole, par exemple « v0.1.1 ».	Yes

RaiConfig

Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).

Name	Catégorie	Description	Obligatoire	Par défaut
rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Yes

SharepointGroundingToolParameters

Paramètres de l’outil de base sharepoint.

Name	Catégorie	Description	Obligatoire	Par défaut
project_connections	tableau d’ToolProjectConnection	Connexions de projet attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	No

SharepointPreviewTool

Informations de définition d’entrée pour un outil SharePoint, comme utilisé pour configurer un agent.

Name	Catégorie	Description	Obligatoire
sharepoint_grounding_preview	SharepointGroundingToolParameters	Paramètres de l’outil de base sharepoint.	Yes
└project_connections	tableau d’ToolProjectConnection	Connexions de projet attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	No
type	enum	Type d’objet, qui est toujours « sharepoint_grounding_preview ». Valeurs possibles : `sharepoint_grounding_preview`	Yes

StructuredInputDefinition

Entrée structurée qui peut participer aux substitutions de modèles d’invite et à la liaison d’arguments d’outil.

Name	Catégorie	Description	Obligatoire	Par défaut
default_value		Valeur par défaut de l’entrée si aucune valeur d’exécution n’est fournie.	No
description	string	Description lisible par l’homme de l’entrée.	No
required	booléen	Indique si la propriété d’entrée est requise lorsque l’agent est appelé.	No	Faux
schema	Objet	Schéma JSON pour l’entrée structurée (facultatif).	No

StructuredOutputDefinition

Sortie structurée pouvant être produite par l’agent.

Name	Catégorie	Description	Obligatoire
description	string	Description de la sortie à émettre. Utilisé par le modèle pour déterminer quand émettre la sortie.	Yes
nom	string	Nom de la sortie structurée.	Yes
schema	Objet	Schéma JSON pour la sortie structurée.	Yes
strict	booléen (nullable)	Indique s’il faut appliquer une validation stricte. `true`par défaut .	Yes

ToolProjectConnection

Ressource de connexion de projet.

Name	Catégorie	Description	Obligatoire	Par défaut
project_connection_id	string	Connexion de projet dans un ToolProjectConnectionList attaché à cet outil.	Yes

UpdateAgentFromManifestRequest

Name	Catégorie	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Yes
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Yes

UpdateAgentRequest

Name	Catégorie	Description	Obligatoire
Définition	AgentDefinition		Yes
Type └	AgentKind		Yes
└rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	No
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans une structure formater et interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes avec une longueur maximale de 512 caractères.	No

WebSearchConfiguration

Configuration de recherche web pour la recherche personnalisée Bing

Name	Catégorie	Description	Obligatoire	Par défaut
nom_instance	string	Nom de l’instance de configuration personnalisée donnée à la configuration.	Yes
project_connection_id	string	Project ID de connexion pour la mise à l’aide de la recherche personnalisée Bing	Yes

WorkflowAgentDefinition

Définition de l’agent de flux de travail.

Name	Catégorie	Description	Obligatoire
kind	enum	Valeurs possibles : `workflow`	Yes
rai_config	RaiConfig	Configuration des fonctionnalités de filtrage et de sécurité du contenu IA responsable (RAI).	No
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Yes
flux de travail	string	Définition YAML CSDL du flux de travail.	No

Last updated on 2026-06-01