Microsoft Foundry

Version de l’API : v1

Authentication

Flux : implicite

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

Étendues:

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

Agents

Agents - Créer un agent

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

Crée l’agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=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

Nom	Type	Description	Obligatoire
Définition	AgentDefinition		Oui
Type └	AgentKind		Oui
└rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
Métadonnées	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.	Non
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	Oui

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

Renvoie la liste de tous les agents.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Non	string Valeurs possibles : `prompt`, , `hostedcontainer_app`,`workflow`	Filtrez les agents par type. S’il n’est pas fourni, tous les agents sont retournés.
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

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.

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

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

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 si la définition de l’agent est modifiée. Si aucune modification n’est apportée, renvoie la version existante de l’agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=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

Nom	Type	Description	Obligatoire
Définition	AgentDefinition		Oui
Type └	AgentKind		Oui
└rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
Métadonnées	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.	Non

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

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent à supprimer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

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, renvoie la version existante de l’agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent à mettre à jour.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Oui
Métadonnées	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.	Non
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Oui

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

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=V1Preview`, , `HostedAgents=V1PreviewWorkflowAgents=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

Nom	Type	Description	Obligatoire
Définition	AgentDefinition		Oui
Type └	AgentKind		Oui
└rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
Métadonnées	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.	Non

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

Renvoie la liste des versions d’un agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent pour lequel récupérer des versions.
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

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.

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

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent à récupérer.
agent_version	path	Oui	string	Version de l’agent à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

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

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent à supprimer.
agent_version	path	Oui	string	Version de l’agent à supprimer
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

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 nouvelle version de l’agent à partir d’un manifeste.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Oui
Métadonnées	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.	Non
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Oui

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

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Oui
Métadonnées	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.	Non
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	Oui
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Oui

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

Conteneurs d’agents

Conteneurs d’agents - Répertorier les opérations de conteneur de l’agent

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

Répertorier les opérations de conteneur pour un agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - obtenir l’opération de conteneur d’agent

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

Obtenez l’état d’une opération de conteneur pour un agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
operation_id	path	Oui	string	ID d’opération.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentContainerOperationObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - obtenir le conteneur d’agent

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

Obtenir un conteneur pour une version spécifique d’un agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AgentContainerObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - Répertorier les opérations de conteneur de version de l’agent

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

Répertorier les opérations de conteneur pour une version spécifique d’un agent.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - Supprimer un conteneur d’agent

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

Supprimez un conteneur pour une version spécifique d’un agent. Si le conteneur n’existe pas, l’opération sera no-op. L’opération est une opération longue. Suivez les instructions de conception pour les opérations de longue durée dans Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

Responses

Code d’état : 202

Description : la demande a été acceptée pour traitement, mais le traitement n’a pas encore été effectué.

Type de contenu	Type	Description
application/json	AgentContainerOperationObject

En-têtes de réponse :

En-tête	Type	Description
Opération-Emplacement	string

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - diffuser en continu les journaux des conteneurs d’agent

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

Entrée de journal de conteneur diffusée à partir du conteneur sous forme de blocs de texte. Chaque bloc est une chaîne UTF-8 qui peut être une ligne de journal de texte brut ou une entrée de journal au format JSON, selon le type de journal de conteneur en cours de diffusion en continu. Les clients doivent traiter chaque bloc comme du texte opaque et, si nécessaire, tenter de l’analyser en tant que JSON en fonction de leurs exigences de journalisation.

Pour les journaux système, le format est JSON avec la structure suivante : {"TimeStamp » :"2025-12-15T16:51:33Z »,"Type » :"Normal »,"ContainerAppName » :null,"RevisionName » :null,"ReplicaName » :null,"Msg » :"Connexion au collecteur d’événements... »,"Reason » :"StartingGettingEvents » :,"EventSource » :"ContainerAppController »,"Count » :1} {"TimeStamp » :"2025-12-15T16:51:34Z »,"Type » :"Normal »,"ContainerAppName » :null,"RevisionName » :null,"ReplicaName » :null,"Msg » :"Correctement connecté aux événements server »,"Reason » :"ConnectedToEventsServer »,"EventSource » :"ContainerAppController »,"Count » :1}

Pour les journaux de console, le format est du texte brut émis par le stdout/stderr du conteneur. 2025-12-15T08:43:48.72656 Connexion au conteneur 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
kind	query	Non	string Valeurs possibles : `console`, `system`	la console retourne le conteneur stdout/stderr, le système retourne le flux d’événements de l’application conteneur. valeurs par défaut de la console
replica_name	query	Non	string	En cas d’omission, le serveur choisit la première réplication pour les logs de console. Requis pour cibler une réplique spécifique.
queue	query	Non	entier	Nombre de lignes finales retournées. Appliqué à 1 à 300. Valeur par défaut : 20
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - démarrer le conteneur d’agent

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

Démarrez un conteneur pour une version spécifique d’un agent. Si le conteneur est déjà en cours, l’opération sera no-op. L’opération est une opération longue. Suivez les instructions de conception pour les opérations de longue durée dans Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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

Nom	Type	Description	Obligatoire	Par défaut
max_replicas	entier	Nombre maximal de réplicas. La valeur par défaut est 1.	Non	1
min_replicas	entier	Nombre minimal de réplicas. La valeur par défaut est 1.	Non	1

Responses

Code d’état : 202

Description : la demande a été acceptée pour traitement, mais le traitement n’a pas encore été effectué.

Type de contenu	Type	Description
application/json	AgentContainerOperationObject

En-têtes de réponse :

En-tête	Type	Description
Opération-Emplacement	string

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents : arrêter le conteneur d’agent

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

Arrêtez un conteneur pour une version spécifique d’un agent. Si le conteneur n’est pas en cours d’exécution ou est déjà arrêté, l’opération sera no-op. L’opération est une opération longue. Suivez les instructions de conception pour les opérations de longue durée dans Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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.

Responses

Code d’état : 202

Description : la demande a été acceptée pour traitement, mais le traitement n’a pas encore été effectué.

Type de contenu	Type	Description
application/json	AgentContainerOperationObject

En-têtes de réponse :

En-tête	Type	Description
Opération-Emplacement	string

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conteneurs d’agents - Mettre à jour le conteneur de l’agent

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

Mettez à jour un conteneur pour une version spécifique d’un agent. Si le conteneur ne fonctionne pas, l’opération sera no-op. L’opération est une opération longue. Suivez les instructions de conception pour les opérations de longue durée dans Azure API REST. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Nom de l’agent.
agent_version	path	Oui	string	Version de l’agent.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `ContainerAgents=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

Nom	Type	Description	Obligatoire	Par défaut
max_replicas	entier	Nombre maximal de réplicas.	Non
min_replicas	entier	Nombre minimal de réplicas.	Non

Responses

Code d’état : 202

Description : la demande a été acceptée pour traitement, mais le traitement n’a pas encore été effectué.

Type de contenu	Type	Description
application/json	AgentContainerOperationObject

En-têtes de réponse :

En-tête	Type	Description
Opération-Emplacement	string

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Connections

Connexions - liste

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

Répertorier toutes les connexions dans le projet, sans remplir les informations d’identification de connexion

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
connectionType	query	Non	string Valeurs possibles : `AzureOpenAI`, `AzureBlob`, `AzureStorageAccount`, `CognitiveSearch`, `CosmosDB`, `ApiKey`, `AppConfig`, `AppInsights`, `CustomKeys`, `RemoteTool_Preview`	Répertorier les connexions de ce type spécifique
defaultConnection	query	Non	booléen	Répertorier les connexions qui sont des connexions par défaut

En-tête de requête

Nom	Obligatoire	Type	Description
x-ms-client-request-id	Faux	string	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedConnection

En-têtes de réponse :

En-tête	Type	Description
x-ms-client-request-id		Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Connexions - obtenir

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

Obtenir une connexion par nom, sans remplir les informations d’identification de connexion

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	Nom convivial de la connexion fournie par l’utilisateur.

En-tête de requête

Nom	Obligatoire	Type	Description
x-ms-client-request-id	Faux	string	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Connection

En-têtes de réponse :

En-tête	Type	Description
x-ms-client-request-id		Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Connexions : obtenir avec les informations d’identification

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

Obtenir une connexion par nom, avec ses informations d’identification de connexion

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	Nom convivial de la connexion fournie par l’utilisateur.

En-tête de requête

Nom	Obligatoire	Type	Description
x-ms-client-request-id	Faux	string	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Connection

En-têtes de réponse :

En-tête	Type	Description
x-ms-client-request-id		Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Groupes de données

Jeux de données - répertorier la dernière version

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

Répertorier la dernière version de chaque DatasetVersion

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedDatasetVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Jeux de données - versions de liste

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

Répertorier toutes les versions du DatasetVersion donné

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedDatasetVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Jeux de données - obtenir la version

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

Obtenez la version spécifique de DatasetVersion. Le service retourne l’erreur 404 Introuvable si DatasetVersion n’existe pas.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique du DatasetVersion à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DatasetVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Jeux de données - supprimer la version

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

Supprimez la version spécifique de DatasetVersion. Le service retourne 204 Aucun contenu si DatasetVersion a été supprimé correctement ou si DatasetVersion n’existe pas.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	Version de DatasetVersion à supprimer.

Responses

Code d’état : 204

Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Jeux de données - créer ou mettre à jour la version

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

Créer ou mettre à jour un DatasetVersion existant avec l’ID de version donné

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique de DatasetVersion à créer ou à mettre à jour.

Corps de la requête

Content-Type : application/merge-patch+json

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	DatasetType	Énumération pour déterminer le type de données.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DatasetVersion

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	DatasetVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Jeux de données - obtenir des informations d’identification

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

Obtenez les informations d’identification SAP pour accéder au compte de stockage associé à une version du jeu de données.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique du DatasetVersion sur lequel opérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AssetCredentialResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Jeux de données : démarrer la version de chargement en attente

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

Démarrez un nouveau fichier ou obtenez un chargement en attente existant d’un jeu de données pour une version spécifique.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique du DatasetVersion sur lequel opérer.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
connectionName	string	Nom de connexion du compte de stockage Azure à utiliser pour générer un jeton SAS temporaire	Non
pendingUploadId	string	Si PendingUploadId n’est pas fourni, un GUID aléatoire sera utilisé.	Non
pendingUploadType	enum	BlobReference est le seul type pris en charge. Valeurs possibles : `BlobReference`	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PendingUploadResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Déploiements

Déploiements - liste

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

Répertorier tous les modèles déployés dans le projet

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
modelPublisher	query	Non	string	Éditeur de modèle pour filtrer les modèles par
modelName	query	Non	string	Nom du modèle (nom spécifique de l’éditeur) pour filtrer les modèles par
deploymentType	query	Non	string Valeurs possibles : `ModelDeployment`	Type de déploiement pour filtrer la liste par

En-tête de requête

Nom	Obligatoire	Type	Description
x-ms-client-request-id	Faux	string	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedDeployment

En-têtes de réponse :

En-tête	Type	Description
x-ms-client-request-id		Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Déploiements - obtenir

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

Obtient un modèle déployé.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	Nom du déploiement

En-tête de requête

Nom	Obligatoire	Type	Description
x-ms-client-request-id	Faux	string	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Déploiement

En-têtes de réponse :

En-tête	Type	Description
x-ms-client-request-id		Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Taxonomies d’évaluation

Taxonomies d’évaluation - liste

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

Répertorier les taxonomies d’évaluation

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
inputName	query	Non	string	Filtrez par nom d’entrée d’évaluation.
inputType	query	Non	string	Filtrez par type d’entrée de taxonomie.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedEvaluationTaxonomy

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Taxonomies d’évaluation - get

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

Obtenez une évaluation exécutée par nom.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvaluationTaxonomy

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Taxonomies d’évaluation - Supprimer

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

Supprimez une taxonomie d’évaluation par nom.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code d’état : 204

Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Taxonomies d’évaluation - créer

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

Créez une taxonomie d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	Nom de la taxonomie d’évaluation.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
properties	Objet	Propriétés supplémentaires pour la taxonomie d’évaluation.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
taxonomyCategories	tableau de TaxonomyCategory	Liste des catégories de taxonomie.	Non
taxonomyInput	EvaluationTaxonomyInput	Configuration d’entrée pour la taxonomie d’évaluation.	Oui
└─ Type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvaluationTaxonomy

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	EvaluationTaxonomy

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Taxonomies d’évaluation - mise à jour

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

Mettez à jour une taxonomie d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	Nom de la taxonomie d’évaluation.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
properties	Objet	Propriétés supplémentaires pour la taxonomie d’évaluation.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
taxonomyCategories	tableau de TaxonomyCategory	Liste des catégories de taxonomie.	Non
taxonomyInput	EvaluationTaxonomyInputUpdate	Configuration d’entrée pour la taxonomie d’évaluation.	Non
└─ Type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvaluationTaxonomy

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Règles d’évaluation

Règles d’évaluation - liste

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

Répertorier toutes les règles d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
actionType	query	Non	string Valeurs possibles : `continuousEvaluation`, `humanEvaluationPreview`	Filtrez par type de règle d’évaluation.
agentNom	query	Non	string	Filtrez par nom d’agent.
enabled	query	Non	booléen	Filtrez par état activé.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedEvaluationRule

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Règles d’évaluation - obtenir

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

Obtenez une règle d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur unique de la règle d’évaluation.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvaluationRule

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Règles d’évaluation - Supprimer

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

Supprimez une règle d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur unique de la règle d’évaluation.

Responses

Code d’état : 204

Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Règles d’évaluation - créer ou mettre à jour

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

Créez ou mettez à jour une règle d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur unique de la règle d’évaluation.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	Faux	string Valeurs possibles : `Evaluations=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

Nom	Type	Description	Obligatoire
action	EvaluationRuleAction	Modèle d’action d’évaluation.	Oui
└─ Type	EvaluationRuleActionType	Type d’action d’évaluation.	Oui
description	string	Description de la règle d’évaluation.	Non
displayName	string	Nom complet de la règle d’évaluation.	Non
enabled	booléen	Indique si la règle d’évaluation est activée. La valeur par défaut est true.	Oui
eventType	EvaluationRuleEventType	Type de l’événement de règle d’évaluation.	Oui
filter	EvaluationRuleFilter	Modèle de filtre d’évaluation.	Non
└} agentName	string	Filtrez par nom d’agent.	Oui
id	chaîne (en lecture seule)	Identificateur unique de la règle d’évaluation.	Oui
données système	objet (en lecture seule)	Métadonnées système pour la règle d’évaluation.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvaluationRule

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	EvaluationRule

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Évaluateurs

Évaluateurs - répertorier les dernières versions

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

Énumérer la dernière version de chaque évaluateur

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
type	query	Non	string Valeurs possibles : `builtin`, , `customall`	Filtrez les évaluateurs par type. Valeurs possibles : « all », « custom », « builtin ».
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedEvaluatorVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Évaluateurs - versions de liste

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

Répertorier toutes les versions de l’évaluateur donné

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
type	query	Non	string Valeurs possibles : `builtin`, , `customall`	Filtrez les évaluateurs par type. Valeurs possibles : « all », « custom », « builtin ».
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedEvaluatorVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Évaluateurs - Créer une version

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

Créer un EvaluatorVersion avec l’ID de version incrémenté automatiquement

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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

Nom	Type	Description	Obligatoire
categories	tableau d’évaluateurCategory	Les catégories de l’évaluateur	Oui
Définition	ÉvaluateurDefinition	Configuration de l’évaluateur de base avec discriminateur	Oui
└data_schema	Objet	Le schéma JSON (Draft 2020-12) pour les données d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
└init_parameters	Objet	Le schéma JSON (Draft 2020-12) pour les paramètres d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
Métriques └>	Objet	Liste des paramètres de production produits par cet évaluateur	Non
└─ Type	AssessDefinitionType	Définition du type d’évaluateur	Oui
description	string	Texte de description de la ressource.	Non
display_name	string	Nom d’affichage de l’évaluateur. Cela aide à trouver facilement l’évaluateur dans AI Foundry. Il n’a pas besoin d’être unique.	Non
evaluator_type	AssessType	Le type d’évaluateur	Oui
Métadonnées	Objet	Métadonnées sur l’évaluateur	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non

Responses

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	AssessVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Évaluateurs - obtenir la version

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

Obtenez la version spécifique de EvaluatorVersion. Le service renvoie l’erreur 404 Not Found si EvaluatorVersion n’existe pas.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique de l’ÉvaluateurVersion à récupérer.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AssessVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Évaluateurs - supprimer la version

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

Supprimez la version spécifique de EvaluatorVersion. Le service renvoie 204 Aucun contenu si la version EvaluatorVersion a été supprimée avec succès ou si la version EvaluatorVersion n’existe pas.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	Version de l’ÉvaluateurVersion à supprimer.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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.

Responses

Code d’état : 204

Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Évaluateurs - version de mise à jour

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

Mettre à jour un EvaluatorVersion existant avec l’ID de version donné

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	Version de l’ÉvaluateurVersion à mettre à jour.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Evaluations=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

Nom	Type	Description	Obligatoire
categories	tableau d’évaluateurCategory	Les catégories de l’évaluateur	Non
description	string	Texte de description de la ressource.	Non
display_name	string	Nom d’affichage de l’évaluateur. Cela aide à trouver facilement l’évaluateur dans AI Foundry. Il n’a pas besoin d’être unique.	Non
Métadonnées	Objet	Métadonnées sur l’évaluateur	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	AssessVersion

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Indexes

Index : liste la plus récente

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

Répertorier la dernière version de chaque index

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedIndex

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Index - versions de liste

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

Répertorier toutes les versions de l’index donné

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedIndex

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Index - obtenir la version

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

Obtenez la version spécifique de l’index. Le service retourne l’erreur 404 Introuvable si l’index n’existe pas.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique de l’index à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Index

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Index - Supprimer la version

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

Supprimez la version spécifique de l’index. Le service retourne 204 Aucun contenu si l’index a été supprimé correctement ou si l’index n’existe pas.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	Version de l’index à supprimer.

Responses

Code d’état : 204

Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Index - créer ou mettre à jour la version

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

Créer ou mettre à jour un index existant avec l’ID de version donné

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	nom de la ressource.
version	path	Oui	string	ID de version spécifique de l’index à créer ou à mettre à jour.

Corps de la requête

Content-Type : application/merge-patch+json

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	IndexType		Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Index

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	Index

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Insights

Insights - Générer

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

Générer des insights

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Insights=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.
Répétabilité -Request-ID	Faux	string	Identificateur unique, généré par le client, pour garantir l’idempotence de la demande. Utilisez le même ID pour les nouvelles tentatives afin d’éviter les évaluations en double.
Répétabilité -First-Sent	Faux	string	Horodatage indiquant la date à laquelle cette demande a été initiée pour la première fois. Utilisé conjointement avec repeatability-request-id pour le contrôle de l’idempotence.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
displayName	string	Nom d’affichage convivial pour l’insight.	Oui
id	chaîne (en lecture seule)	Identificateur unique du rapport Insights.	Oui
Métadonnées	InsightsMetadata (en lecture seule)	Métadonnées sur les informations.	Oui
└' completedAt	string	Horodatage lorsque les insights ont été terminés.	Non
└> createdAt	string	Horodatage lorsque les insights ont été créés.	Oui
request	InsightRequest	La demande du rapport d’analyses.	Oui
└─ Type	InsightType	Type de requête.	Oui
result	InsightResult (en lecture seule)	Le résultat de ces idées.	Non
└─ Type	InsightType	Type de résultat d’insights.	Oui
state	Azure. Core.Foundations.OperationState (lecture seule)	Enum décrivant les états de fonctionnement autorisés.	Oui

Responses

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	Informations

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Insights - liste

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

Répertoriez tous les insights dans l’ordre chronologique inverse (le plus récent).

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
type	query	Non	string Valeurs possibles : `EvaluationRunClusterInsight`, , `AgentClusterInsightEvaluationComparison`	Filtrez par type d’analyse.
evalId	query	Non	string	Filtrez par ID d’évaluation.
Identifiant d'exécution	query	Non	string	Filtrez par ID d’exécution d’évaluation.
agentNom	query	Non	string	Filtrez par nom d’agent.
includeCoordinates	query	Non	booléen	Indique s’il faut inclure des coordonnées pour la visualisation dans la réponse. La valeur par défaut est false.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Insights=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedInsight

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Insights - obtenir

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

Obtenez un insight spécifique par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur unique du rapport Insights.
includeCoordinates	query	Non	booléen	Indique s’il faut inclure des coordonnées pour la visualisation dans la réponse. La valeur par défaut est false.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Insights=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Informations

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Magasins de mémoire

Créer un magasin de mémoire

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

Créez un magasin de mémoire.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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

Nom	Type	Description	Obligatoire
Définition	MemoryStoreDefinition	Définition de base pour les configurations de stockage de mémoire.	Oui
Type └	MemoryStoreKind	Type de magasin de mémoire.	Oui
description	string	Description lisible par l’homme du magasin de mémoire. Contraintes : maxLength : 512	Non
Métadonnées	Objet	Métadonnées de clé-valeur arbitraires à associer au magasin de mémoire.	Non
nom	string	Nom du magasin de mémoire. Contraintes : maxLength : 256	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	MemoryStoreObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les stockages de mémoire

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

Répertorie tous les magasins de mémoire.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Mettre à jour le magasin de mémoire

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

Mettre à jour un magasin de mémoire.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire à mettre à jour.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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

Nom	Type	Description	Obligatoire	Par défaut
description	string	Description lisible par l’homme du magasin de mémoire. Contraintes : maxLength : 512	Non
Métadonnées	Objet	Métadonnées de clé-valeur arbitraires à associer au magasin de mémoire.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	MemoryStoreObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Obtenir le magasin de mémoire

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

Récupérez un magasin de mémoire.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	MemoryStoreObject

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Supprimer le magasin de mémoire

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

Supprimer un magasin de mémoire.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire à supprimer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DeleteMemoryStoreResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Obtenir le résultat de la mise à jour

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

Obtenir le résultat de la mise à jour de la mémoire stockée.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire.
update_id	path	Oui	string	ID de l’opération de mise à jour de mémoire.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	MemoryStoreUpdateResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Supprimer des mémoires d’étendue

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

Supprimez tous les souvenirs associés à une étendue spécifique d’une mémoire stockée.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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

Nom	Type	Description	Obligatoire	Par défaut
scope	string	Espace de noms qui regroupe et isole logiquement les souvenirs à supprimer, tels qu’un ID d’utilisateur.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	MemoryStoreDeleteScopeResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Rechercher des souvenirs

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

Recherchez des souvenirs pertinents à partir d’un magasin de mémoire en fonction du contexte de la conversation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire à rechercher.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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

Nom	Type	Description	Obligatoire
items	tableau d’OpenAI.InputItem	Éléments pour lesquels rechercher des souvenirs pertinents.	Non
options	MemorySearchOptions	Options de recherche de mémoire.	Non
└max_memories	entier	Nombre maximal d’éléments de mémoire à retourner.	Non
previous_search_id	string	ID unique de la demande de recherche précédente, activant la recherche de mémoire incrémentielle à partir de laquelle la dernière opération s’est arrêtée.	Non
scope	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	MemoryStoreSearchResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Mettre à jour les souvenirs

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

Mettez à jour la mémoire avec les mémoires de conversation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
nom	path	Oui	string	Nom du magasin de mémoire à mettre à jour.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `MemoryStores=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

Nom	Type	Description	Obligatoire	Par défaut
items	tableau d’OpenAI.InputItem	Éléments de conversation à partir desquels extraire des souvenirs.	Non
previous_update_id	string	ID unique de la demande de mise à jour précédente, activant les mises à jour de mémoire incrémentielles à partir de laquelle la dernière opération s’est arrêtée.	Non
scope	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui
update_delay	entier	Délai d’expiration avant de traiter la mise à jour de mémoire en secondes. Si une nouvelle demande de mise à jour est reçue pendant cette période, elle annule la requête actuelle et réinitialise le délai d’expiration. Définissez la valeur 0 pour déclencher immédiatement la mise à jour sans délai. La valeur par défaut est 300 (5 minutes).	Non	300

Responses

Code d’état : 202

Description : la demande a été acceptée pour traitement, mais le traitement n’a pas encore été effectué.

Type de contenu	Type	Description
application/json	MemoryStoreUpdateResponse

En-têtes de réponse :

En-tête	Type	Description
Opération-Emplacement	string	Emplacement de surveillance de l’état de l’opération.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Conversations

Créer une conversation

POST {endpoint}/openai/v1/conversations

Créez une conversation.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire	Par défaut
items	tableau d’OpenAI.InputItem		Non
Métadonnées	OpenAI.Metadata (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.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ConversationResource

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les conversations

GET {endpoint}/openai/v1/conversations

Retourne la liste de toutes les conversations.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
agent_name	query	Non	string	Filtrez par nom d’agent. S’il est fourni, seuls les éléments associés à l’agent spécifié sont retournés.
agent_id	query	Non	string	Filtrez par ID d’agent au format `name:version`. S’il est fourni, seuls les éléments associés à l’ID d’agent spécifié sont retournés.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Mettre à jour la conversation

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

Mettez à jour une conversation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation à mettre à jour.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire	Par défaut
Métadonnées	OpenAI.Metadata (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.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ConversationResource

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Engagez la conversation

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

Récupère une conversation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ConversationResource

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Supprimer une conversation

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

Supprime une conversation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation à supprimer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.DeletedConversationResource

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Créer des éléments de conversation

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

Créez des éléments dans une conversation avec l’ID donné.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation sur laquelle l’élément doit être créé.
Inclure	query	Non	tableau	Champs supplémentaires à inclure dans la réponse. Pour plus d’informations, consultez le `include` paramètre permettant de répertorier les éléments de conversation.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire	Par défaut
items	tableau d’OpenAI.Item	Éléments à ajouter à la conversation. Vous pouvez ajouter jusqu’à 20 éléments à la fois.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ConversationItemList

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les éléments de conversation

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

Répertorie tous les éléments d’une conversation avec l’ID donné.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation sur laquelle les éléments doivent être répertoriés.
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
item_type	query	Non	string Valeurs possibles : `message`, `output_message`, `file_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action`	Filtrez par type d’élément. S’il est fourni, seuls les éléments du type spécifié sont retournés.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Obtenir un élément de conversation

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

Obtenez un élément unique à partir d’une conversation avec les ID donnés.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation qui contient l’élément.
item_id	path	Oui	string	ID de l’élément de conversation à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.OutputItem

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Supprimer l’élément de conversation

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

Supprimez un élément d’une conversation avec les ID donnés.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
conversation_id	path	Oui	string	ID de la conversation sur laquelle l’élément doit être supprimé.
item_id	path	Oui	string	ID de l’élément de conversation à supprimer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ConversationResource

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals

Évaluations - évaluations par liste

GET {endpoint}/openai/v1/evals

Répertorier toutes les évaluations Répertorier les évaluations d’un projet.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
Après	query	Non	string	Identificateur de la dernière exécution de la demande de pagination précédente.
limit	query	Non	entier	Nombre d’exécutions à récupérer.
order	query	Non	string Valeurs possibles : `asc`, `desc`	Ordre de tri pour les exécutions par horodatage. Utiliser `asc` pour l’ordre croissant ou `desc` pour l’ordre décroissant. La valeur par défaut est `asc`.
ordonner_par	query	Non	string Valeurs possibles : `created_at`, `updated_at`	Les evals peuvent être triés par heure de création ou heure de dernière mise à jour. Utiliser `created_at` pour l’heure de création ou `updated_at` pour la dernière heure mise à jour.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - créer eval

POST {endpoint}/openai/v1/evals

Créer une évaluation Créer la structure d’une évaluation qui peut être utilisée pour tester les performances d’un modèle. Une évaluation est un ensemble de critères de test et de configuration pour une source de données, qui détermine le schéma des données utilisées dans l’évaluation. Après avoir créé une évaluation, vous pouvez l’exécuter sur différents modèles et paramètres de modèle. Nous prenons en charge plusieurs types de nuanceurs et de sources de données. Pour plus d’informations, consultez le

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
data_source_config	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig ou AzureAIDataSourceConfig	Configuration de la source de données utilisée pour les exécutions d’évaluation. Dicte le schéma des données utilisées dans l’évaluation.	Oui
Métadonnées	OpenAI.Metadata (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.	Non
nom	string	Nom de l’évaluation.	Non
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non
critères_de_test	tableau d’OpenAI.EvalGraderLabelModel ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderAzureAIEvaluator	Liste des correcteurs de toutes les exécutions d’évaluation dans ce groupe. Les nuanceurs peuvent référencer des variables dans la source de données à l’aide d’accolades doubles, comme `{{item.variable_name}}`. Pour référencer la sortie du modèle, utilisez l’espace `sample` de noms (par exemple, `{{sample.output_text}}`).	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Eval

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Évaluations - supprimer l’évaluation

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

Supprimer une évaluation Supprimer une évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	ID de l’évaluation à supprimer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DeleteEvalResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Évaluations - obtenez une évaluation

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

Obtenir une évaluation Obtenir une évaluation par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	L’identifiant de l’évaluation à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Eval

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - mettre à jour eval

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

Mettre à jour une évaluation Mettre à jour certaines propriétés d’une évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	L’identifiant de l’évaluation à mettre à jour.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
Métadonnées	OpenAI.Metadata (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.	Non
nom	string		Non
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Eval

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - exécutions de liste

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

Obtenir la liste des exécutions d’une évaluation Obtenir une liste d’exécutions pour une évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	L’identifiant de l’évaluation pour laquelle récupérer les exécutions.
Après	query	Non	string	Identificateur de la dernière exécution de la demande de pagination précédente.
limit	query	Non	entier	Nombre d’exécutions à récupérer.
order	query	Non	string Valeurs possibles : `asc`, `desc`	Ordre de tri pour les exécutions par horodatage. Utiliser `asc` pour l’ordre croissant ou `desc` pour l’ordre décroissant. La valeur par défaut est `asc`.
status	query	Non	string Valeurs possibles : `queued`, , `in_progresscompleted`, `canceled`, `failed` . Filtrez les processus par statut. Un des `queued`, , `in_progress`, `failedcompleted`, , `canceled`.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Évaluations - créer une série d’évaluation

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

Créer une exécution d’évaluation

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	ID de l’évaluation pour lequel créer une exécution.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
source de données	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource ou EvalRunDataSource	Détails sur la source de données de l’exécution.	Oui
Métadonnées	OpenAI.Metadata (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.	Non
nom	string	Nom de l’exécution.	Non
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvalRun

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - Delete eval run

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

Supprimer l’exécution d’évaluation Supprimer une exécution d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	ID de l’évaluation d’où supprimer l’exécution.
run_id	path	Oui	string	ID de l’exécution à supprimer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DeleteEvalRunResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Évaluations - obtenir une évaluation en course

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

Obtenez une exécution d’évaluation Obtenir une évaluation exécutée par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	L’identifiant de l’évaluation pour laquelle récupérer les exécutions.
run_id	path	Oui	string	ID de l’exécution à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvalRun

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - annuler l’exécution d’eval

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

Annuler l’exécution d’évaluation Annuler une exécution d’évaluation en cours.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	ID de l’évaluation dont vous souhaitez annuler l’exécution.
run_id	path	Oui	string	ID de l’exécution à annuler.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvalRun

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - obtenir les éléments de sortie d’exécution eval

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

Obtenir les éléments de sortie d’exécution d’évaluation Obtenir une liste d’éléments de sortie pour une exécution d’évaluation.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string
run_id	path	Oui	string	ID de l’exécution pour lequel récupérer les éléments de sortie.
Après	query	Non	string	Identificateur de la dernière exécution de la demande de pagination précédente.
limit	query	Non	entier	Nombre d’exécutions à récupérer.
order	query	Non	string Valeurs possibles : `asc`, `desc`	Ordre de tri pour les exécutions par horodatage. Utiliser `asc` pour l’ordre croissant ou `desc` pour l’ordre décroissant. La valeur par défaut est `asc`.
status	query	Non	string Valeurs possibles : `fail`, `pass`	Filtrez les éléments de sortie par état. Utiliser `failed` pour filtrer par sortie ayant échoué éléments ou `pass` pour filtrer en passant les éléments de sortie.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Evals - obtenir l’élément de sortie d’exécution eval

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

Obtenir un élément de sortie d’une exécution d’évaluation Obtenir un élément de sortie d’exécution d’évaluation par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
eval_id	path	Oui	string	L’identifiant de l’évaluation pour laquelle récupérer les exécutions.
run_id	path	Oui	string	ID de l’exécution à récupérer.
output_item_id	path	Oui	string	ID de l’élément de sortie à récupérer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	EvalRunOutputItem

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Fine-Tuning

Créer un travail de réglage précis

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

Crée un travail de réglage précis qui commence le processus de création d’un modèle à partir d’un jeu de données donné.

La réponse inclut les détails de la tâche mise en file d’attente, y compris l’état du travail et le nom des modèles affinés une fois terminés.

En savoir plus sur l’ajustement fin

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire	Par défaut
hyperparameters	OpenAI.CreateFineTuningJobRequestHyperparameters		Non
└ taille_du_lot	string ou OpenAI.integer		Non	auto
─ learning_rate_multiplier	string ou OpenAI.numeric		Non
└n_epochs	string ou OpenAI.integer		Non	auto
Intégrations	array d’OpenAI.CreateFineTuningJobRequestIntegrations	Liste des intégrations à activer pour votre travail de réglage précis.	Non
Métadonnées	OpenAI.Metadata (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.	Non
method	OpenAI.FineTuneMethod	Méthode utilisée pour le réglage précis.	Non
model	chaîne (voir les modèles valides ci-dessous)	Nom du modèle à ajuster. Vous pouvez sélectionner l’une des modèles pris en charge.	Oui
seed	OpenAI.integer (annulable)		Non
Suffixe	chaîne (nullable)	Chaîne de jusqu’à 64 caractères qui seront ajoutés au nom de votre modèle affiné. Par exemple, un `suffix` « custom-model-name » produit un nom de modèle comme `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Contraintes : minLength : 1, maxLength : 64	Non
fichier d'entraînement	string	ID d’un fichier chargé qui contient des données d’apprentissage. Consultez le fichier de chargement pour savoir comment charger un fichier. Votre jeu de données doit être mis en forme en tant que fichier JSONL. En outre, vous devez charger votre fichier à l’aide de l’objectif `fine-tune`. Le contenu du fichier doit différer selon que le modèle utilise la conversation, le format de saisie semi-automatique ou si la méthode de réglage précis utilise le format de préférence . Consultez le guide d'ajustement pour plus de détails.	Oui
fichier_de_validation	chaîne (nullable)	ID d’un fichier chargé qui contient des données de validation. Si vous fournissez ce fichier, les données sont utilisées pour générer la validation métriques régulièrement pendant le réglage précis. Ces métriques peuvent être consultées dans le fichier de résultats de réglage précis. Les mêmes données ne doivent pas être présentes dans les fichiers d’apprentissage et de validation. Votre jeu de données doit être mis en forme en tant que fichier JSONL. Vous devez charger votre fichier à l’aide de l’objectif `fine-tune`. Consultez le guide d'ajustement pour plus de détails.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.FineTuningJob

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les travaux d’optimisation des fins paginés

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

Répertorier les travaux d’optimisation de votre organisation

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
Après	query	Non	string	Identificateur du dernier travail de la demande de pagination précédente.
limit	query	Non	entier	Nombre de travaux de réglage précis à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Récupérer le travail de réglage précis

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

Obtenez des informations sur un travail de réglage précis.

En savoir plus sur l’ajustement fin

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
fine_tuning_job_id	path	Oui	string	ID du travail de réglage précis.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.FineTuningJob

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Annuler le travail de réglage précis

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

Annulez immédiatement un travail affiné.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
fine_tuning_job_id	path	Oui	string	ID du travail de réglage précis à annuler.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.FineTuningJob

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les points de contrôle de travail de réglage précis

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

Répertorier les points de contrôle d’un travail de réglage précis.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
fine_tuning_job_id	path	Oui	string	ID du travail de réglage précis pour lequel obtenir des points de contrôle.
Après	query	Non	string	Identificateur du dernier ID de point de contrôle de la demande de pagination précédente.
limit	query	Non	entier	Nombre de points de contrôle à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les événements de travail de réglage précis

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

Obtenez des mises à jour d’état affinées pour un travail de réglage précis.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
fine_tuning_job_id	path	Oui	string	ID du travail de réglage précis pour obtenir des événements.
Après	query	Non	string	Identificateur du dernier événement de la demande de pagination précédente.
limit	query	Non	entier	Nombre d’événements à récupérer.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Suspendre le travail de réglage précis

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

Suspendre un travail d’optimisation en cours d’exécution.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
fine_tuning_job_id	path	Oui	string	ID du travail de réglage précis à suspendre.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.FineTuningJob

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Reprendre le travail de réglage précis

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

Reprendre une tâche d’optimisation affinée suspendue.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
fine_tuning_job_id	path	Oui	string	ID du travail de réglage précis à reprendre.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.FineTuningJob

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Responses

Créer une réponse - créer un flux de réponse

POST {endpoint}/openai/v1/responses

Crée un modèle de réponse. Crée une réponse de modèle (réponse de streaming).

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire	Par défaut
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
Arrière-plan	booléen (nullable)		Non
conversation	OpenAI.ConversationParam (nullable)	Conversation à laquelle cette réponse appartient. Les éléments de cette conversation sont ajoutés à `input_items` cette demande de réponse. Les éléments d’entrée et les éléments de sortie de cette réponse sont automatiquement ajoutés à cette conversation une fois cette réponse terminée.	Non
Inclure	tableau d’OpenAI.IncludeEnum		Non
input	OpenAI.InputParam	Entrées de texte, d’image ou de fichier dans le modèle, utilisées pour générer une réponse. Pour en savoir plus: - Entrées et sorties de texte - Entrées d’image - Entrées de fichier - État de la conversation - Appel de fonction	Non
Instructions	chaîne (nullable)		Non
max_output_tokens	OpenAI.integer (annulable)		Non
max_tool_calls	OpenAI.integer (annulable)		Non
Métadonnées	OpenAI.Metadata (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.	Non
model	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
parallel_tool_calls	booléen (nullable)		Non	True
previous_response_id	chaîne (nullable)		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
reasoning	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
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`.	Non
└─ générer_resume	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
Résumé └>	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
niveau de service	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
boutique	booléen (nullable)		Non	True
stream	booléen (nullable)		Non
stream_options	OpenAI.ResponseStreamOptions (annulable)	Options de diffusion en continu des réponses. Définissez cette valeur uniquement lorsque vous définissez `stream: true`.	Non
└include_obfuscation	booléen	Lorsque la valeur est true, l’obfuscation de flux est activée. Ajouts d’obfuscation de flux caractères aléatoires sur un `obfuscation` champ sur les événements delta de diffusion en continu vers normalisez les tailles de charge utile en tant qu’atténuation de certaines attaques par canal latéral. Ces champs d’obfuscation sont inclus par défaut, mais ajoutent une petite quantité d’une surcharge sur le flux de données. Vous pouvez définir `include_obfuscation` sur false pour optimiser la bande passante si vous approuvez les liens réseau entre votre application et l’API OpenAI.	Non
structured_inputs	Objet	Entrées structurées dans la réponse qui peuvent participer aux liaisons d’arguments de modèle ou de substitution de modèle d’invite.	Non
Température	OpenAI.numeric (annulable)		Non	1
text	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
top_logprobs	OpenAI.integer (annulable)		Non
top_p	OpenAI.numeric (annulable)		Non	1
truncation	enum	Valeurs possibles : `auto`, `disabled`	Non
user	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Lister les réponses

GET {endpoint}/openai/v1/responses

Retourne la liste de toutes les réponses.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.
agent_name	query	Non	string	Filtrez par nom d’agent. S’il est fourni, seuls les éléments associés à l’agent spécifié sont retournés.
agent_id	query	Non	string	Filtrez par ID d’agent au format `name:version`. S’il est fourni, seuls les éléments associés à l’ID d’agent spécifié sont retournés.
conversation_id	query	Non	string	Filtrez par ID de conversation. Si elle est fournie, seules les réponses associées à la conversation spécifiée sont retournées.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Compacter la conversation de réponse

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

Produit un compactage d’une conversation de réponses.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
input	chaîne ou tableau d’OpenAI.InputItem		Non
Instructions	chaîne (nullable)		Non
model	OpenAI.ModelIdsCompaction	ID de modèle utilisé pour générer la réponse, comme `gpt-5` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, caractéristiques de performances et points de prix. Reportez-vous au guide de modèle pour parcourir et comparer les modèles disponibles.	Oui
previous_response_id	chaîne (nullable)		Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.CompactResource

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Obtenir la réponse - obtenir le flux de réponse

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

Récupère une réponse de modèle avec l’ID donné. Récupère une réponse de modèle avec l’ID donné (réponse de streaming).

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
response_id	path	Oui	string
include[]	query	Non	tableau
stream	query	Non	booléen
starting_after	query	Non	entier

En-tête de requête

Nom	Obligatoire	Type	Description
accepter	Faux	string Valeurs possibles : `text/event-stream`

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Supprimer la réponse

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

Supprime une réponse de modèle.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
response_id	path	Oui	string	ID de la réponse à supprimer.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	DeleteResponseResult

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Annuler la réponse

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

Annule une réponse de modèle.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
response_id	path	Oui	string	ID de la réponse à annuler.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.Response

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Répertorier les éléments d’entrée

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

Retourne une liste d’éléments d’entrée pour une réponse donnée.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
response_id	path	Oui	string
limit	query	Non	entier	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20.
order	query	Non	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.
Après	query	Non	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.
before	query	Non	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.

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.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Redteams

Redteams - liste

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

Répertoriez un redteam par nom.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `RedTeams=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedRedTeam

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Redteams - obtenez

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

Obtenez un redteam par nom.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
nom	path	Oui	string	Identificateur de l’exécution de l’équipe rouge.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `RedTeams=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	RedTeam

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Redteams - créer

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

Crée une exécution redteam.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `RedTeams=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

Nom	Type	Description	Obligatoire	Par défaut
applicationScenario	string	Scénario d’application pour l’opération d’équipe rouge, afin de générer des attaques spécifiques au scénario.	Non
attackStrategies	array d’AttackStrategy	Liste des stratégies d’attaque ou listes imbriquées de stratégies d’attaque.	Non
displayName	string	Nom de l’exécution de l’équipe rouge.	Non
id	chaîne (en lecture seule)	Identificateur de l’exécution de l’équipe rouge.	Oui
numTurns	entier	Nombre d’arrondis de simulation.	Non
properties	Objet	Propriétés de l’équipe rouge. Contrairement aux balises, les propriétés sont des compléments uniquement. Une fois ajoutée, une propriété ne peut pas être supprimée.	Non
riskCategories	tableau de RiskCategory	Liste des catégories de risques pour générant des objectifs d’attaque.	Non
simulationOnly	booléen	Simulation uniquement ou Simulation + Évaluation. False par défaut, si la valeur true, l’analyse génère la conversation et non le résultat de l’évaluation.	Non	Faux
status	chaîne (en lecture seule)	État de l’équipe rouge. Il est défini par service et est en lecture seule.	Non
tags	Objet	Étiquettes de l’équipe rouge. Contrairement aux propriétés, les balises sont totalement mutables.	Non
target	TargetConfig	Classe abstraite pour la configuration cible.	Oui
└─ Type	string	Type de configuration du modèle.	Oui

Responses

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	RedTeam

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Schedules

Planifications - liste

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

Répertorier toutes les planifications.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
type	query	Non	string Valeurs possibles : `Evaluation`, `Insight`	Filtrez par type de planification.
enabled	query	Non	booléen	Filtrez par état activé.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Schedules=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedSchedule

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Planifications - Supprimer

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

Supprimez une planification.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur de la planification.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Schedules=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.

Responses

Code d’état : 204

Description : il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Planifications - obtenir

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

Obtenez une planification par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur de la planification.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Schedules=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Schedule

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Planifications - créer ou mettre à jour

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

Créer ou mettre à jour un modèle d’opération.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur de la planification.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Schedules=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

Nom	Type	Description	Obligatoire
description	string	Description de la planification.	Non
displayName	string	Nom de la planification.	Non
enabled	booléen	État activé de la planification.	Oui
id	chaîne (en lecture seule)	Identificateur de la planification.	Oui
properties	Objet	Propriétés de schedule. Contrairement aux balises, les propriétés sont des compléments uniquement. Une fois ajoutée, une propriété ne peut pas être supprimée.	Non
provisionnementÉtat	ScheduleProvisioningStatus (lecture seule)	Planifier l’état du provisionnement.	Non
données système	objet (en lecture seule)	Métadonnées système pour la ressource.	Oui
tags	Objet	Balises de planification. Contrairement aux propriétés, les balises sont totalement mutables.	Non
tâche	ScheduleTask	Planifier le modèle de tâche.	Oui
Configuration de └ ;	Objet	Configuration de la tâche.	Non
└─ Type	ScheduleTaskType	Type de la tâche.	Oui
trigger	Trigger	Modèle de base pour le déclenchement de la planification.	Oui
└─ Type	TriggerType	Type de déclencheur.	Oui

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Schedule

Code d’état : 201

Description : la demande a réussi et une nouvelle ressource a été créée par conséquent.

Type de contenu	Type	Description
application/json	Schedule

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Planifications - Exécutions de liste

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

Répertorier toutes les exécutions de planification.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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	Oui	string	Version de l’API à utiliser pour cette opération.
id	path	Oui	string	Identificateur de la planification.
type	query	Non	string Valeurs possibles : `Evaluation`, `Insight`	Filtrez par type de planification.
enabled	query	Non	booléen	Filtrez par état activé.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Schedules=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	PagedScheduleRun

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

En-têtes de réponse :

En-tête	Type	Description
x-ms-error-code	string	Code d’erreur de chaîne indiquant ce qui s’est passé.

Planifications - Get Run

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

Obtenir une planification exécutée par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	path	Oui	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 »
schedule_id	path	Oui	string	Identificateur unique de la planification.
run_id	path	Oui	string	Identificateur unique de l’exécution de planification.
version de l'API	query	Oui	string	Version de l’API à utiliser pour cette opération.

En-tête de requête

Nom	Obligatoire	Type	Description
Foundry-Features	True	string Valeurs possibles : `Schedules=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.

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	ScheduleRun

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	ApiErrorResponse

Components

A2APreviewTool

Un agent implémentant le protocole A2A.

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

AISearchIndexResource

Une ressource d’index de recherche IA.

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

AgentClusterInsightRequest

Informations sur l’ensemble des résultats de l’évaluation des agents

Nom	Type	Description	Obligatoire
agentNom	string	Identificateur de l’agent.	Oui
modèleConfiguration	InsightModelConfiguration	Configuration du modèle utilisé dans la génération d’insights.	Non
└} modelDeploymentName	string	Déploiement du modèle à évaluer. Accepte le nom de déploiement seul ou avec le nom de connexion en tant que `{connectionName}/<modelDeploymentName>`.	Oui
type	enum	Type de requête. Valeurs possibles : `AgentClusterInsight`	Oui

AgentClusterInsightResult

Aperçu de l’analyse du cluster d’agents.

Nom	Type	Description	Obligatoire	Par défaut
clusterInsight	ClusterInsightResult	Enseignements tirés de l’analyse des clusters.	Oui
type	enum	Type de résultat d’insights. Valeurs possibles : `AgentClusterInsight`	Oui

AgentContainerObject

Détails du conteneur d’une version spécifique d’un agent.

Nom	Type	Description	Obligatoire
container	ContainerDetails (lecture seule)	Informations détaillées sur le conteneur.	Non
└health_state	string	État d’intégrité du conteneur.	Oui
└provisioning_error	string	Erreur d’approvisionnement du conteneur, le cas échéant.	Non
└provisioning_state	string	État d’approvisionnement du conteneur.	Oui
Réplicas └>	tableau de ContainerReplica	Liste des réplicas dans le conteneur.	Oui
État └>	string	État du conteneur.	Oui
└updated_on	string	Heure de la dernière mise à jour du conteneur.	Oui
date_de_création	string	Heure de création du conteneur.	Oui
error_message	chaîne (en lecture seule)	Message d’erreur si le conteneur n’a pas pu fonctionner, le cas échéant.	Non
id	chaîne (en lecture seule)	Identificateur du conteneur.	Non
max_replicas	entier	Nombre maximal de réplicas pour le conteneur. La valeur par défaut est 1.	Non
min_replicas	entier	Nombre minimal de réplicas pour le conteneur. La valeur par défaut est 1.	Non
Objet	enum	Type d’objet, qui est toujours « agent.container ». Valeurs possibles : `agent.container`	Oui
status	AgentContainerStatus (lecture seule)	État du conteneur d’une version spécifique d’un agent.	Oui
updated_at	string	Heure de la dernière mise à jour du conteneur.	Oui

AgentContainerOperationError

Détails de l’erreur de l’opération de conteneur, le cas échéant.

Nom	Type	Description	Obligatoire
code	string	Code d’erreur de l’opération de conteneur, le cas échéant.	Oui
message	string	Message d’erreur de l’opération de conteneur, le cas échéant.	Oui
type	string	Type d’erreur de l’opération de conteneur, le cas échéant.	Oui

AgentContainerOperationObject

Opération de conteneur pour une version spécifique d’un agent.

Nom	Type	Description	Obligatoire
agent_id	string	ID de l’Agent.	Oui
agent_version_id	string	ID de la version de l’agent.	Oui
container	AgentContainerObject	Détails du conteneur d’une version spécifique d’un agent.	Non
Conteneur └>	ContainerDetails (lecture seule)	Informations détaillées sur le conteneur.	Non
└created_at	chaîne (en lecture seule)	Heure de création du conteneur.	Oui
└error_message	chaîne (en lecture seule)	Message d’erreur si le conteneur n’a pas pu fonctionner, le cas échéant.	Non
└─ identifiant	chaîne (en lecture seule)	Identificateur du conteneur.	Non
└max_replicas	entier	Nombre maximal de réplicas pour le conteneur. La valeur par défaut est 1.	Non
└min_replicas	entier	Nombre minimal de réplicas pour le conteneur. La valeur par défaut est 1.	Non
└─ Objet	enum	Type d’objet, qui est toujours « agent.container ». Valeurs possibles : `agent.container`	Oui
└─ État	AgentContainerStatus (lecture seule)	État du conteneur d’une version spécifique d’un agent.	Oui
└updated_at	chaîne (en lecture seule)	Heure de la dernière mise à jour du conteneur.	Oui
erreur	AgentContainerOperationError	Détails de l’erreur de l’opération de conteneur, le cas échéant.	Non
└─ Code	string	Code d’erreur de l’opération de conteneur, le cas échéant.	Oui
└─ Message	string	Message d’erreur de l’opération de conteneur, le cas échéant.	Oui
└─ Type	string	Type d’erreur de l’opération de conteneur, le cas échéant.	Oui
id	string	ID de l’opération de conteneur. Cet ID est un identificateur unique dans le système.	Oui
status	AgentContainerOperationStatus	État de l’opération de conteneur pour une version spécifique d’un agent.	Oui

AgentContainerOperationStatus

État de l’opération de conteneur pour une version spécifique d’un agent.

Propriété	Valeur
Type	string
Valeurs	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

État du conteneur d’une version spécifique d’un agent.

Propriété	Valeur
Type	string
Valeurs	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

Discriminateur pour AgentDefinition

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

Type de valeur	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

Nom	Type	Description	Obligatoire
kind	AgentKind		Oui
rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Oui

AgentKind

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

AgentObject

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

AgentProtocol

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

AgentReference

Nom	Type	Description	Obligatoire
nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
type	enum	Valeurs possibles : `agent_reference`	Oui
version	string	Identificateur de version de l’agent.	Non

AgentTaxonomyInput

Configuration d’entrée pour la taxonomie d’évaluation lorsque le type d’entrée est agent.

Nom	Type	Description	Obligatoire
riskCategories	tableau de RiskCategory	Liste des catégories de risques à évaluer.	Oui
target	Cible	Classe de base pour les cibles avec support discriminateur.	Oui
└─ Type	string	Type de cible.	Oui
type	enum	Type d’entrée de la taxonomie d’évaluation. Valeurs possibles : `agent`	Oui

AgentTaxonomyInputUpdate

Configuration d’entrée pour la taxonomie d’évaluation lorsque le type d’entrée est agent.

Nom	Type	Description	Obligatoire
riskCategories	tableau de RiskCategory	Liste des catégories de risques à évaluer.	Non
target	TargetUpdate	Classe de base pour les cibles avec support discriminateur.	Non
└─ Type	string	Type de cible.	Oui
type	enum	Type d’entrée de la taxonomie d’évaluation. Valeurs possibles : `agent`	Oui

AgentVersionObject

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (secondes) lors de la création de l’agent.	Oui
Définition	AgentDefinition		Oui
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
id	string	Identificateur unique de la version de l’agent.	Oui
Métadonnées	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.	Oui
nom	string	Nom de l’agent. Le nom peut être utilisé pour récupérer/mettre à jour/supprimer l’agent. Contraintes : maxLength : 256	Oui
Objet	enum	Le type d’objet, qui est toujours 'agent.version'. Valeurs possibles : `agent.version`	Oui
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.	Oui

AgenticIdentityPreviewCredentials

Définition des informations d’identification d’identité agentique

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type d’informations d’identification Valeurs possibles : `AgenticIdentityToken_Preview`	Oui

ApiErrorResponse

Réponse d’erreur en cas d’échec de l’API.

Nom	Type	Description	Obligatoire	Par défaut
erreur	OpenAI.Error		Oui

ApiKeyCredentials

Définition des informations d’identification de la clé API

Nom	Type	Description	Obligatoire	Par défaut
key	chaîne (en lecture seule)	Clé API	Non
type	enum	Type d’informations d’identification Valeurs possibles : `ApiKey`	Oui

AssetCredentialResponse

Représente une référence à un objet blob pour la consommation

Nom	Type	Description	Obligatoire
blobReference	BlobReference	Détails de référence du blob.	Oui
└> blobUri	string	Chemin d’URI d’objet blob pour que le client charge les données. Exemple : `https://blob.windows.core.net/Container/Path`	Oui
Informations d’identification └>	SasCredential	Informations d’identification pour accéder au compte de stockage.	Oui
└> storageAccountArmId	string	ID ARM du compte de stockage à utiliser.	Oui

Identifiant d'actif

Identificateur d’une ressource enregistrée.

Type : chaîne

AttackStrategy

Stratégies d’attaques.

Propriété	Valeur
Description	Stratégies d’attaques.
Type	string
Valeurs	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure. Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description	Obligatoire
code	string	Un ensemble de codes d’erreur définis par le serveur.	Oui
details	tableau de Azure. Core.Foundations.Error	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.	Non
innererror	Azure. Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Non
└─ Code	string	Un ensemble de codes d’erreur définis par le serveur.	Non
└' innererror	Azure. Core.Foundations.InnerError	Erreur interne.	Non
message	string	Représentation lisible par l’homme de l’erreur.	Oui
target	string	Cible de l’erreur.	Non

Azure. Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description	Obligatoire
erreur	Azure. Core.Foundations.Error	Objet d’erreur.	Oui
└─ Code	string	Un ensemble de codes d’erreur définis par le serveur.	Oui
└─ détails	tableau de Azure. Core.Foundations.Error	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.	Non
└' innererror	Azure. Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.	Non
└─ Message	string	Représentation lisible par l’homme de l’erreur.	Oui
Cible └>	string	Cible de l’erreur.	Non

Azure. Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description	Obligatoire
code	string	Un ensemble de codes d’erreur définis par le serveur.	Non
innererror	Azure. Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Selon Azure directives de l’API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.	Non
└─ Code	string	Un ensemble de codes d’erreur définis par le serveur.	Non
└' innererror	Azure. Core.Foundations.InnerError	Erreur interne.	Non

Azure. Core.Foundations.OperationState

Enum décrivant les états de fonctionnement autorisés.

Propriété	Valeur
Description	Enum décrivant les états de fonctionnement autorisés.
Type	string
Valeurs	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure. Core.uuid

Identificateur unique universel

Type : chaîne

Format : uuid

AzureAIAgentTarget

Représente une cible spécifiant un agent IA Azure.

Nom	Type	Description	Obligatoire
nom	string	Identificateur unique de l’agent IA Azure.	Oui
tool_descriptions	tableau de ToolDescription	Paramètres utilisés pour contrôler le comportement d’échantillonnage de l’agent lors de la génération de texte.	Non
type	enum	Le type de cible, toujours `azure_ai_agent`. Valeurs possibles : `azure_ai_agent`	Oui
version	string	Version de l’agent IA Azure.	Non

AzureAIAgentTargetUpdate

Représente une cible spécifiant un agent IA Azure.

Nom	Type	Description	Obligatoire
nom	string	Identificateur unique de l’agent IA Azure.	Non
tool_descriptions	tableau de ToolDescription	Paramètres utilisés pour contrôler le comportement d’échantillonnage de l’agent lors de la génération de texte.	Non
type	enum	Le type de cible, toujours `azure_ai_agent`. Valeurs possibles : `azure_ai_agent`	Oui
version	string	Version de l’agent IA Azure.	Non

AzureAIDataSourceConfig

Nom	Type	Description	Obligatoire
scenario	enum	Scénario de schéma de données. Valeurs possibles : `red_team`, , `responsestraces_preview`,`synthetic_data_gen_preview`	Oui
schema	Objet	Schéma JSON d’objet global pour les éléments de source de données d’exécution.	Oui
type	enum	Type d’objet, qui est toujours `azure_ai_source`. Valeurs possibles : `azure_ai_source`	Oui

AzureAIModelTarget

Représente une cible spécifiant un modèle IA Azure pour des opérations nécessitant une sélection de modèle.

Nom	Type	Description	Obligatoire
model	string	Identificateur unique du modèle IA Azure.	Non
paramètres d'échantillonnage	ModelSamplingParams	Représente un ensemble de paramètres utilisés pour contrôler le comportement d’échantillonnage d’un modèle de langage pendant la génération de texte.	Non
└max_completion_tokens	entier	Nombre maximal de jetons autorisés dans la saisie semi-automatique.	Oui
Graine └─	entier	Valeur initiale aléatoire pour la reproductibilité.	Oui
└─ Température	Numéro	Paramètre de température pour l’échantillonnage.	Oui
└─ top_p	Numéro	Paramètre top-p pour l’échantillonnage du noyau.	Oui
type	enum	Le type de cible, toujours `azure_ai_model`. Valeurs possibles : `azure_ai_model`	Oui

AzureAIModelTargetUpdate

Représente une cible spécifiant un modèle IA Azure pour des opérations nécessitant une sélection de modèle.

Nom	Type	Description	Obligatoire
model	string	Identificateur unique du modèle IA Azure.	Non
paramètres d'échantillonnage	ModelSamplingParamsUpdate	Représente un ensemble de paramètres utilisés pour contrôler le comportement d’échantillonnage d’un modèle de langage pendant la génération de texte.	Non
└max_completion_tokens	entier	Nombre maximal de jetons autorisés dans la saisie semi-automatique.	Non
Graine └─	entier	Valeur initiale aléatoire pour la reproductibilité.	Non
└─ Température	Numéro	Paramètre de température pour l’échantillonnage.	Non
└─ top_p	Numéro	Paramètre top-p pour l’échantillonnage du noyau.	Non
type	enum	Le type de cible, toujours `azure_ai_model`. Valeurs possibles : `azure_ai_model`	Oui

AzureAIResponsesEvalRunDataSource

Représente une source de données pour les exécutions d’évaluation spécifiques aux scénarios d’évaluation continue.

Nom	Type	Description	Obligatoire
event_configuration_id	string	Nom de configuration d’événement associé à cette exécution d’évaluation.	Oui
item_generation_params	ResponseRetrievalItemGenerationParams	Représente les paramètres de génération d’élément de récupération de réponse.	Oui
└data_mapping	Objet	Mappage des champs sources à response_id champ, requis pour récupérer l’historique des conversations.	Oui
└max_num_turns	entier	Nombre maximal de tours d’historique de conversation à évaluer.	Oui
└─ Source	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	Source à partir de laquelle le contenu JSONL est lu.	Oui
└─ Type	enum	Type de paramètres de génération d’élément, toujours `response_retrieval`. Valeurs possibles : `response_retrieval`	Oui
max_runs_hourly	entier	Nombre maximal d’exécutions d’évaluation autorisées par heure.	Oui
type	enum	Type de source de données, toujours `azure_ai_responses`. Valeurs possibles : `azure_ai_responses`	Oui

AzureAISearchIndex

définition d’index Recherche Azure AI

Nom	Type	Description	Obligatoire
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	enum	Type d’index Valeurs possibles : `AzureSearch`	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

AzureAISearchIndexUpdate

définition d’index Recherche Azure AI

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	enum	Type d’index Valeurs possibles : `AzureSearch`	Oui

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

Les informations de définition d’entrée pour un outil de recherche IA Azure utilisées pour configurer un agent.

Nom	Type	Description	Obligatoire
azure_ai_search	AzureAISearchToolResource	Ensemble de ressources d’index utilisées par l’outil `azure_ai_search`.	Oui
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	Oui
type	enum	Le type d’objet, qui est toujours 'azure_ai_search. Valeurs possibles : `azure_ai_search`	Oui

AzureAISearchToolResource

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

Nom	Type	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.	Oui

AzureFunctionBinding

Structure permettant de conserver storage nom de file d’attente et l’URI.

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

AzureFunctionDefinition

La définition de la fonction Azure.

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

AzureFunctionStorageQueue

Structure permettant de conserver storage nom de file d’attente et l’URI.

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

AzureFunctionTool

Les informations de définition d’entrée pour un outil de fonction Azure, telles qu’utilisées pour configurer un agent.

Nom	Type	Description	Obligatoire
azure_function	AzureFunctionDefinition	La définition de la fonction Azure.	Oui
Fonction └>	Objet	Définition de la fonction Azure et de ses paramètres.	Oui
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
└─ Nom	string	Nom de la fonction à appeler.	Oui
└─ Paramètres	Objet	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON.	Oui
└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.	Oui
└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.	Oui
type	enum	Le type d’objet, qui est toujours « browser_automation ». Valeurs possibles : `azure_function`	Oui

AzureOpenAIModelConfiguration

Azure OpenAI configuration de modèles. La version de l’API est sélectionnée par le service pour interroger le modèle.

Nom	Type	Description	Obligatoire	Par défaut
modelDeploymentName	string	Nom du déploiement pour le modèle AOAI. Exemple : gpt-4o si dans AIServices ou la connexion basée `connection_name/deployment_name` (par exemple `my-aoai-connection/gpt-4o`).	Oui
type	enum	Valeurs possibles : `AzureOpenAIModel`	Oui

BaseCredentials

Une classe de base pour les identifiants de connexion

Discriminateur pour BaseCredentials

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

Type de valeur	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	CustomCredential
`SAS`	SASCredentials
`None`	NoAuthenticationCredentials
`AgenticIdentityToken_Preview`	AgenticIdentityPreviewCredentials

Nom	Type	Description	Obligatoire	Par défaut
type	CredentialType (lecture seule)	Type d’informations d’identification utilisé par la connexion	Oui

BingCustomSearchConfiguration

Configuration de recherche personnalisée bing.

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

BingCustomSearchPreviewTool

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

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

BingCustomSearchToolParameters

Paramètres de l’outil de recherche personnalisé bing.

Nom	Type	Description	Obligatoire	Par défaut
search_configurations	tableau de BingCustomSearchConfiguration	Connexions project attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil.	Oui

BingGroundingSearchConfiguration

Rechercher la configuration de Bing grounding

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

BingGroundingSearchToolParameters

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

Nom	Type	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.	Oui

BingGroundingTool

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

Nom	Type	Description	Obligatoire
bing_grounding	BingGroundingSearchToolParameters	Paramètres de l’outil de recherche de base bing.	Oui
└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	Oui
type	enum	Type d’objet, qui est toujours « bing_grounding ». Valeurs possibles : `bing_grounding`	Oui

BlobReference

Détails de référence du blob.

Nom	Type	Description	Obligatoire
blobUri	string	Chemin d’URI d’objet blob pour que le client charge les données. Exemple : `https://blob.windows.core.net/Container/Path`	Oui
credential	SasCredential	Définition des informations d’identification SAS	Oui
└> sasUri	chaîne (en lecture seule)	URI SAP	Oui
└─ Type	enum	Type d’informations d’identification Valeurs possibles : `SAS`	Oui
storageAccountArmId	string	ID ARM du compte de stockage à utiliser.	Oui

BrowserAutomationPreviewTool

Informations de définition d’entrée d’un outil d’automatisation de navigateur, telles qu’elles sont utilisées pour configurer un agent.

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

BrowserAutomationToolConnectionParameters

Définition des paramètres d’entrée pour la connexion utilisée par l’outil d’automatisation du navigateur.

Nom	Type	Description	Obligatoire	Par défaut
project_connection_id	string	ID de la connexion du projet à votre ressource playwright Azure.	Oui

BrowserAutomationToolParameters

Définition des paramètres d’entrée pour l’outil d’automatisation du navigateur.

Nom	Type	Description	Obligatoire	Par défaut
Connexion	BrowserAutomationToolConnectionParameters	Définition des paramètres d’entrée pour la connexion utilisée par l’outil d’automatisation du navigateur.	Oui
└project_connection_id	string	ID de la connexion du projet à votre ressource playwright Azure.	Oui

CaptureStructuredOutputsTool

Un outil pour capturer des sorties structurées

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

ChartCoordinate

Coordonnées de la carte d’analyse.

Nom	Type	Description	Obligatoire
size	entier	Taille de l’élément de graphique.	Oui
x	entier	Coordonnée de l’axe X.	Oui
y	entier	Coordonnée de l’axe Y.	Oui

ChatSummaryMemoryItem

Élément de mémoire contenant un résumé extrait des conversations.

Nom	Type	Description	Obligatoire
contenu	string	Le contenu de la mémoire.	Oui
kind	enum	Type de l’élément de mémoire. Valeurs possibles : `chat_summary`	Oui
memory_id	string	ID unique de l’élément de mémoire.	Oui
scope	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui
updated_at	entier	Heure de la dernière mise à jour de l’élément de mémoire.	Oui

ClusterInsightResult

Enseignements tirés de l’analyse des clusters.

Nom	Type	Description	Obligatoire
clusters	tableau d’InsightCluster	Liste des clusters identifiés dans les insights.	Oui
coordonnées	Objet	Mappage facultatif des ID aux coordonnées 2D utilisées par l’expérience utilisateur pour la visualisation. Les clés cartographiques sont des identificateurs de chaîne (par exemple, un ID de cluster ou un exemple d’ID) et les valeurs sont les coordonnées et la taille visuelle pour le rendu sur un graphique 2D. Cette propriété est omise, sauf si le client demande des coordonnées (par exemple, en passant `includeCoordinates=true` en tant que paramètre de requête). Exemple : `<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>` Les coordonnées sont destinées uniquement à la visualisation côté client et ne sont pas modifiez les résultats des insights canoniques.	Non
summary	InsightSummary	Résumé de l’analyse du cluster d’erreurs.	Oui
Méthode └'	string	Méthode utilisée pour le clustering.	Oui
└> sampleCount	entier	Nombre total d’échantillons analysés.	Oui
└> uniqueClusterCount	entier	Nombre total de clusters uniques.	Oui
└> uniqueSubclusterCount	entier	Nombre total d’étiquettes de sous-cluster uniques.	Oui
└─ utilisation	ClusterTokenUsage	Utilisation des jetons lors de l’analyse du clustering	Oui

ClusterTokenUsage

Utilisation du jeton pour l’analyse de cluster

Nom	Type	Description	Obligatoire
inputTokenUsage	entier	Utilisation des jetons d’entrée	Oui
outputTokenUsage	entier	Utilisation des jetons de sortie	Oui
totalTokenUsage	entier	utilisation totale des jetons	Oui

CodeBasedEvaluatorDefinition

Définition d’un évaluateur basé sur le code python

Nom	Type	Description	Obligatoire
code_text	string	Texte du code inline pour l’évaluateur	Oui
data_schema	Objet	Le schéma JSON (Draft 2020-12) pour les données d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
init_parameters	Objet	Le schéma JSON (Draft 2020-12) pour les paramètres d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
metrics	Objet	Liste des paramètres de production produits par cet évaluateur	Non
type	enum	Valeurs possibles : `code`	Oui

CompletionMessageToolCallChunk

Détails de l’appel de l’outil dans un message.

Nom	Type	Description	Obligatoire
function	FunctionToolCall	Détails d’un appel d’outil de fonction.	Non
└─ Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON.	Oui
└─ Nom	string	Nom de la fonction à appeler.	Oui
id	string	ID de l’appel d’outil.	Oui
type	enum	Type d’appel d’outil, qui est toujours « function ». Valeurs possibles : `function`	Oui

Connexion

Réponse de la liste et opérations d’obtention des connexions

Nom	Type	Description	Obligatoire
credentials	BaseCredentials (en lecture seule)	Une classe de base pour les identifiants de connexion	Oui
└─ Type	CredentialType (lecture seule)	Type d’informations d’identification utilisées par la connexion	Oui
id	chaîne (en lecture seule)	Identificateur unique de la connexion, généré par le service	Oui
isDefault	booléen (en lecture seule)	Indique si la connexion est marquée comme connexion par défaut de son type	Oui
Métadonnées	objet (en lecture seule)	Métadonnées de la connexion	Oui
nom	chaîne (en lecture seule)	Nom convivial de la connexion fournie par l’utilisateur.	Oui
target	chaîne (en lecture seule)	URL de connexion à utiliser pour ce service	Oui
type	ConnectionType (lecture seule)	Type (ou catégorie) de la connexion	Oui

ConnectionType

Type (ou catégorie) de la connexion

Propriété	Valeur
Description	Type (ou catégorie) de la connexion
Type	string
Valeurs	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

Définition de l’agent d’application conteneur.

Nom	Type	Description	Obligatoire
container_app_resource_id	string	ID de ressource de l’application conteneur Azure qui héberge cet agent. Non mutable entre les versions.	Oui
container_protocol_versions	tableau de ProtocolVersionRecord	Protocoles pris en charge par l’agent pour la communication d’entrée des conteneurs.	Oui
ingress_subdomain_suffix	string	Suffixe à appliquer au sous-domaine d’application lors de l’envoi d’entrée à l’agent. Il peut s’agir d’une étiquette (par exemple, « ---current »), d’une révision spécifique (par exemple, « --0000001 »), ou vide pour utiliser le point de terminaison par défaut de l’application conteneur.	Oui
kind	enum	Valeurs possibles : `container_app`	Oui
rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Oui

ContainerDetails

Informations détaillées sur le conteneur.

Nom	Type	Description	Obligatoire
health_state	string	État d’intégrité du conteneur.	Oui
provisioning_error	string	Erreur d’approvisionnement du conteneur, le cas échéant.	Non
provisioning_state	string	État d’approvisionnement du conteneur.	Oui
replicas	tableau de ContainerReplica	Liste des réplicas dans le conteneur.	Oui
state	string	État du conteneur.	Oui
updated_on	string	Heure de la dernière mise à jour du conteneur.	Oui

ContainerLogKind

Type de journaux à diffuser à partir d’un conteneur.

Propriété	Valeur
Type	string
Valeurs	`console` `system`

ContainerReplica

Informations sur un réplica de conteneur.

Nom	Type	Description	Obligatoire
container_state	string	État du conteneur du réplica.	Oui
nom	string	Nom de la réplique.	Oui
state	string	État du réplica.	Oui

ContinuousEvaluationRuleAction

Action de règle d’évaluation pour l’évaluation continue.

Nom	Type	Description	Obligatoire
evalId	string	ID Eval pour ajouter des exécutions d’évaluation continue à.	Oui
maxHourlyRuns	entier	Nombre maximal d’exécutions d’évaluation autorisées par heure.	Non
type	enum	Valeurs possibles : `continuousEvaluation`	Oui

CosmosDBIndex

Définition de l’index CosmosDB Vector Store

Nom	Type	Description	Obligatoire
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	enum	Type d’index Valeurs possibles : `CosmosDBNoSqlVectorStore`	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

CosmosDBIndexUpdate

Définition de l’index CosmosDB Vector Store

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	enum	Type d’index Valeurs possibles : `CosmosDBNoSqlVectorStore`	Oui

CreateAgentFromManifestRequest

Nom	Type	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Oui
Métadonnées	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.	Non
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	Oui
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Oui

CreateAgentRequest

Nom	Type	Description	Obligatoire
Définition	AgentDefinition		Oui
Type └	AgentKind		Oui
└rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
Métadonnées	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.	Non
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	Oui

CreateAgentVersionFromManifestRequest

Nom	Type	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Oui
Métadonnées	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.	Non
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Oui

CreateAgentVersionRequest

Nom	Type	Description	Obligatoire
Définition	AgentDefinition		Oui
Type └	AgentKind		Oui
└rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
Métadonnées	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.	Non

CreateEvalRequest

Nom	Type	Description	Obligatoire
data_source_config	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig ou AzureAIDataSourceConfig	Configuration de la source de données utilisée pour les exécutions d’évaluation. Dicte le schéma des données utilisées dans l’évaluation.	Oui
Métadonnées	OpenAI.Metadata (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.	Non
nom	string	Nom de l’évaluation.	Non
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non
critères_de_test	tableau d’OpenAI.EvalGraderLabelModel ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderAzureAIEvaluator	Liste des correcteurs de toutes les exécutions d’évaluation dans ce groupe. Les nuanceurs peuvent référencer des variables dans la source de données à l’aide d’accolades doubles, comme `{{item.variable_name}}`. Pour référencer la sortie du modèle, utilisez l’espace `sample` de noms (par exemple, `{{sample.output_text}}`).	Oui

CreateEvalRunRequest

Nom	Type	Description	Obligatoire
source de données	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource ou EvalRunDataSource	Détails sur la source de données de l’exécution.	Oui
Métadonnées	OpenAI.Metadata (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.	Non
nom	string	Nom de l’exécution.	Non
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non

CredentialType

Type d’informations d’identification utilisé par la connexion

Propriété	Valeur
Description	Type d’informations d’identification utilisé par la connexion
Type	string
Valeurs	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

Déclencheur basé sur Cron.

Nom	Type	Description	Obligatoire	Par défaut
endTime	string	Heure de fin du calendrier cron au format ISO 8601.	Non
expression	string	Expression Cron qui définit la fréquence de planification.	Oui
startTime	string	Heure de début du calendrier cron au format ISO 8601.	Non
timeZone	string	Fuseau horaire de l’horaire cron.	Non	UTC
type	enum	Valeurs possibles : `Cron`	Oui

CustomCredential

Définition d’informations d’identification personnalisées

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type d’informations d’identification Valeurs possibles : `CustomKeys`	Oui

Cet objet accepte également des propriétés supplémentaires de type : chaîne

DailyRecurrenceSchedule

Calendrier de récurrence quotidien.

Nom	Type	Description	Obligatoire	Par défaut
hours	tableau d’entiers	Heures de la planification de périodicité.	Oui
type	enum	Type de périodicité quotidienne. Valeurs possibles : `Daily`	Oui

DataSourceConfig

Classe de base pour exécuter des sources de données avec prise en charge du discriminateur.

Discriminateur pour DataSourceConfig

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

Type de valeur	Schema

Nom	Type	Description	Obligatoire	Par défaut
schema	Objet	Schéma JSON d’objet global pour les éléments de source de données d’exécution.	Oui
type	string	Discriminateur de type de source de données.	Oui

DatasetType

Énumération pour déterminer le type de données.

Propriété	Valeur
Description	Énumération pour déterminer le type de données.
Type	string
Valeurs	`uri_file` `uri_folder`

DatasetVersion

DatasetVersion définition

Discriminateur pour DatasetVersion

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

Type de valeur	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Nom	Type	Description	Obligatoire
connectionName	string	Nom de connexion de compte stockage Azure. Obligatoire si startPendingUploadVersion n’a pas été appelé avant de créer le jeu de données	Non
dataUri	string	URI des données (exemple) Contraintes : minLength : 1, modèle : `[a-zA-Z0-9_]`	Oui
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
isReference	booléen (en lecture seule)	Indique si le jeu de données contient une référence au stockage, ou si le jeu de données gère lui-même le stockage. Si la valeur est true, les données sous-jacentes ne sont pas supprimées lorsque la version du jeu de données est supprimée	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	DatasetType	Énumération pour déterminer le type de données.	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

DatasetVersionUpdate

DatasetVersion définition

Discriminateur pour DatasetVersionUpdate

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

Type de valeur	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	DatasetType	Énumération pour déterminer le type de données.	Oui

Dayofweek

Jours de la semaine pour la planification de la récurrence.

Propriété	Valeur
Description	Jours de la semaine pour la planification de la récurrence.
Type	string
Valeurs	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Un objet d’agent supprimé

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

DeleteAgentVersionResponse

Une version d’agent supprimée Objet

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

DeleteEvalResponse

Objet d’évaluation supprimé

Nom	Type	Description	Obligatoire
supprimé	booléen	Indique si l’évaluation a été correctement supprimée.	Oui
eval_id	string	ID de l’eval.	Oui
Objet	enum	Type d’objet. Toujours « eval.deleted ». Valeurs possibles : `eval.deleted`	Oui

DeleteEvalRunResponse

Objet d’exécution d’évaluation supprimé.

Nom	Type	Description	Obligatoire
supprimé	booléen	Indique si l’évaluation a été correctement supprimée.	Non
Objet	enum	Type d’objet. Toujours « eval.deleted ». Valeurs possibles : `eval.deleted`	Non
run_id	string	ID de l’eval.	Non

DeleteMemoryStoreResponse

Nom	Type	Description	Obligatoire
supprimé	booléen	Indique si le magasin de mémoire a été correctement supprimé.	Oui
nom	string	Nom du magasin de mémoire.	Oui
Objet	enum	Type d’objet. Toujours « memory_store.deleted ». Valeurs possibles : `memory_store.deleted`	Oui

DeleteResponseResult

Résultat d’une opération de réponse de suppression.

Nom	Type	Description	Obligatoire
supprimé	enum	Toujours retourner true Valeurs possibles : `True`	Oui
id	string	ID d’opération.	Oui
Objet	enum	Retournez toujours « response ». Valeurs possibles : `response`	Oui

Deployment

Définition du déploiement du modèle

Discriminateur pour le déploiement

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

Type de valeur	Schema
`ModelDeployment`	ModelDeployment

Nom	Type	Description	Obligatoire	Par défaut
nom	chaîne (en lecture seule)	Nom du déploiement	Oui
type	DeploymentType		Oui

DeploymentType

Propriété	Valeur
Type	string
Valeurs	`ModelDeployment`

EntraIDCredentials

Entra ID définition des identifiants

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type d’informations d’identification Valeurs possibles : `AAD`	Oui

Eval

Objet Eval avec des critères de configuration et de test de source de données. Une évaluation représente une tâche à effectuer pour votre intégration LLM. Comme:

Améliorer la qualité de mon chatbot
Découvrez comment mon chatbot gère le support client
Vérifiez si o4-mini est préférable à ma casse que gpt-4o

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (en secondes) de la création de l’évaluation.	Oui
created_by	string	nom de la personne qui a créé l’exécution.	Non
data_source_config	OpenAI.CreateEvalCustomDataSourceConfig ou OpenAI.CreateEvalLogsDataSourceConfig ou OpenAI.CreateEvalStoredCompletionsDataSourceConfig ou AzureAIDataSourceConfig	Configuration des sources de données utilisées dans les exécutions de l’évaluation.	Oui
id	string	Identificateur unique de l’évaluation.	Oui
Métadonnées	OpenAI.Metadata (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.	Oui
modified_at	Entier		Non
nom	string	Nom de l’évaluation.	Oui
Objet	enum	Type d’objet. Valeurs possibles : `eval`	Oui
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non
critères_de_test	tableau d’OpenAI.EvalGraderLabelModel ou OpenAI.EvalGraderStringCheck ou OpenAI.EvalGraderTextSimilarity ou OpenAI.EvalGraderPython ou OpenAI.EvalGraderScoreModel ou EvalGraderAzureAIEvaluator	Liste des critères de test.	Oui

EvalCsvFileIdSource

Représente une référence à un fichier CSV chargé utilisé comme source pour les données d’évaluation.

Nom	Type	Description	Obligatoire	Par défaut
id	string	Identificateur du fichier CSV chargé.	Oui
type	enum	Type de source, toujours `file_id`. Valeurs possibles : `file_id`	Oui

EvalCsvRunDataSource

Représente une source de données CSV pour les exécutions d’évaluation.

Nom	Type	Description	Obligatoire
Source	EvalCsvFileIdSource	Représente une référence à un fichier CSV chargé utilisé comme source pour les données d’évaluation.	Oui
└─ identifiant	string	Identificateur du fichier CSV chargé.	Oui
└─ Type	enum	Type de source, toujours `file_id`. Valeurs possibles : `file_id`	Oui
type	enum	Type de source de données, toujours `csv`. Valeurs possibles : `csv`	Oui

EvalGraderAzureAIEvaluator

Nom	Type	Description	Obligatoire
cartographie des données	Objet	Modèle à utiliser pour l’évaluation. Doit prendre en charge les sorties structurées.	Non
evaluator_name	string	Nom de l’évaluateur.	Oui
evaluator_version	string	Version de l’évaluateur. Dernière version si elle n’est pas spécifiée.	Non
initialization_parameters	Objet	Paramètres d’initialisation de l’évaluation. Doit prendre en charge les sorties structurées.	Non
nom	string	Nom du correcteur.	Oui
type	enum	Type d’objet, qui est toujours `azure_ai_evaluator`. Valeurs possibles : `azure_ai_evaluator`	Oui

EvalResult

Résultat de l’évaluation.

Nom	Type	Description	Obligatoire
nom	string	nom de la vérification	Oui
Passé	booléen	indique si la vérification a réussi ou échoué	Oui
Résultat	Numéro	Résultat	Oui
type	string	type de la vérification	Oui

EvalRun

Schéma représentant un processus d’évaluation.

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (en secondes) lorsqu’une exécution du rapport d’évaluation a été créée.	Oui
created_by	string	nom de la personne qui a créé l’exécution.	Non
source de données	OpenAI.CreateEvalJsonlRunDataSource ou OpenAI.CreateEvalCompletionsRunDataSource ou OpenAI.CreateEvalResponsesRunDataSource ou EvalRunDataSource	Informations sur la source de données de l’exécution.	Oui
erreur	OpenAI.EvalApiError	Objet représentant une réponse d’erreur de l’API Eval.	Oui
eval_id	string	Identificateur de l’évaluation associée.	Oui
id	string	Identificateur unique pour la réalisation de l’évaluation.	Oui
Métadonnées	OpenAI.Metadata (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.	Oui
model	string	Modèle évalué, le cas échéant.	Oui
modified_at	Entier		Non
nom	string	Nom de l’exécution de l’évaluation.	Oui
Objet	enum	Type de l’objet. Toujours « eval.run ». Valeurs possibles : `eval.run`	Oui
per_model_usage	tableau d’OpenAI.EvalRunPerModelUsage	Statistiques d’utilisation pour chaque modèle pendant l’exécution de l’évaluation.	Oui
résultats_par_critères_de_test	tableau d’OpenAI.EvalRunPerTestingCriteriaResults	Résultats par critères de test appliqués pendant l’exécution de l’évaluation.	Oui
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non
report_url	string	URL du rapport d’exécution d’évaluation rendu sur le tableau de bord de l’interface utilisateur.	Oui
nombre_de_résultats	OpenAI.EvalRunResultCounts		Oui
└' erreur	OpenAI.integer		Oui
Échec	OpenAI.integer		Oui
└─ réussi	OpenAI.integer		Oui
└─ Total	OpenAI.integer		Oui
status	string	État de l’exécution de l’évaluation.	Oui

EvalRunDataSource

Classe de base pour exécuter des sources de données avec prise en charge du discriminateur.

Discriminateur pour EvalRunDataSource

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

Type de valeur	Schema
`azure_ai_traces_preview`	TracesPreviewEvalRunDataSource
`azure_ai_synthetic_data_gen_preview`	SyntheticDataGenerationPreviewEvalRunDataSource
`azure_ai_responses`	AzureAIResponsesEvalRunDataSource
`azure_ai_target_completions`	TargetCompletionEvalRunDataSource
`csv`	EvalCsvRunDataSource
`azure_ai_red_team`	RedTeamEvalRunDataSource

Nom	Type	Description	Obligatoire	Par défaut
type	string	Discriminateur de type de source de données.	Oui

EvalRunOutputItem

Schéma représentant un élément de sortie d'une exécution d'évaluation.

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (en secondes) lorsqu’une exécution du rapport d’évaluation a été créée.	Oui
datasource_item	Objet	Détails de l’élément de source de données d’entrée.	Oui
datasource_item_id	OpenAI.integer		Oui
eval_id	string	Identificateur du groupe d’évaluation.	Oui
id	string	Identificateur unique de l’élément de sortie d’exécution d’évaluation.	Oui
Objet	enum	Type de l’objet. Toujours « eval.run.output_item ». Valeurs possibles : `eval.run.output_item`	Oui
results	tableau d’EvalRunOutputItemResult	Liste des résultats du classateur pour cet élément de sortie.	Oui
run_id	string	Identificateur de l’exécution d’évaluation associée à cet élément de sortie.	Oui
échantillon	OpenAI.EvalRunOutputItemSample		Oui
Erreur └ ;	OpenAI.EvalApiError	Objet représentant une réponse d’erreur de l’API Eval.	Oui
└─ raison_de_fin	string		Oui
└─ Entrée	tableau d’EvalRunOutputItemSampleInput		Oui
└max_completion_tokens	OpenAI.integer		Oui
└─ Modèle	string		Oui
└─ Sortie	tableau d’EvalRunOutputItemSampleOutput		Oui
Graine └─	OpenAI.integer		Oui
└─ Température	OpenAI.numeric		Oui
└─ top_p	OpenAI.numeric		Oui
└─ utilisation	OpenAI.EvalRunOutputItemSampleUsage		Oui
status	string	État de l’exécution de l’évaluation.	Oui

EvalRunOutputItemResult

Résultat d’un seul gradeur pour un élément de sortie d’exécution d’évaluation.

Nom	Type	Description	Obligatoire
label	string	Étiquette associée à la métrique des critères de test (par exemple, « pass », « fail », « good », « bad »).	Non
metric	string	Nom de la métrique (par exemple, « fluency », « f1_score »).	Non
nom	string	Nom du correcteur.	Oui
Passé	booléen	Indique si le classateur a considéré la sortie comme une passe.	Oui
properties	Objet	Détails supplémentaires sur la métrique des critères de test.	Non
raison	string	Raison de la métrique des critères de test.	Non
échantillon	objet (nullable)	Exemples facultatifs ou données intermédiaires produites par le classateur.	Non
Résultat	OpenAI.numeric		Oui
threshold	Numéro	Seuil utilisé pour déterminer la réussite/échec pour ce critère de test, s’il est numérique.	Non
type	string	Type de grade (par exemple, « string-check-grader »).	Non

Cet objet accepte également des propriétés supplémentaires.

EvalRunOutputItemSampleInput

Message dans l’exécution de l’évaluation.

Nom	Type	Description	Obligatoire
contenu	string		Oui
role	string		Oui
tool_calls	tableau de CompletionMessageToolCallChunk	Appels d’outil effectués dans le message, le cas échéant.	Oui

EvalRunOutputItemSampleOutput

Message dans l’exécution de l’évaluation.

Nom	Type	Description	Obligatoire
contenu	string		Non
role	string		Non
tool_calls	tableau de CompletionMessageToolCallChunk	Appels d’outil effectués dans le message, le cas échéant.	Oui

EvalRunResultCompareItem

Comparaison des paramètres d’un traitement par rapport à la ligne de base.

Nom	Type	Description	Obligatoire
deltaEstimate	Numéro	Différence estimée entre le traitement et la base de référence.	Oui
pValue	Numéro	Valeur P pour l’effet de traitement.	Oui
traitementEffect	TreatmentEffectType	Type d’effet de traitement.	Oui
treatmentRunId	string	ID d’exécution du traitement.	Oui
treatmentRunSummary	EvalRunResultSummary	Statistiques récapitulatives d’une métrique dans une exécution d’évaluation.	Oui
Moyenne └>	Numéro	Valeur moyenne de la métrique dans l’exécution d’évaluation.	Oui
└} runId	string	ID d’exécution de l’évaluation.	Oui
└> sampleCount	entier	Nombre d’exemples dans l’exécution de l’évaluation.	Oui
└> standardDeviation	Numéro	Écart type de la métrique dans l’exécution d’évaluation.	Oui

EvalRunResultComparison

Résultats de comparaison des cycles de traitement par rapport à la ligne de base.

Nom	Type	Description	Obligatoire
baselineRunSummary	EvalRunResultSummary	Statistiques récapitulatives d’une métrique dans une exécution d’évaluation.	Oui
Moyenne └>	Numéro	Valeur moyenne de la métrique dans l’exécution d’évaluation.	Oui
└} runId	string	ID d’exécution de l’évaluation.	Oui
└> sampleCount	entier	Nombre d’exemples dans l’exécution de l’évaluation.	Oui
└> standardDeviation	Numéro	Écart type de la métrique dans l’exécution d’évaluation.	Oui
compareItems	tableau d’EvalRunResultCompareItem	Liste des résultats de comparaison pour chaque série de traitement.	Oui
Évaluateur	string	Nom de l’évaluateur pour ces critères de test.	Oui
metric	string	Métrique évaluée.	Oui
testingCriteria	string	Nom des critères de test.	Oui

EvalRunResultSummary

Statistiques récapitulatives d’une métrique dans une exécution d’évaluation.

Nom	Type	Description	Obligatoire
Moyenne	Numéro	Valeur moyenne de la métrique dans l’exécution d’évaluation.	Oui
Identifiant d'exécution	string	ID d’exécution de l’évaluation.	Oui
sampleCount	entier	Nombre d’exemples dans l’exécution de l’évaluation.	Oui
standardDeviation	Numéro	Écart type de la métrique dans l’exécution d’évaluation.	Oui

EvaluationComparisonInsightRequest

Demande de comparaison d’évaluation

Nom	Type	Description	Obligatoire
baselineRunId	string	ID d’exécution de la base de référence pour la comparaison.	Oui
evalId	string	Identificateur de l’évaluation.	Oui
treatmentRunIds	tableau de chaînes	Liste des ID de traitement à des fins de comparaison.	Oui
type	enum	Type de requête. Valeurs possibles : `EvaluationComparison`	Oui

EvaluationComparisonInsightResult

Aperçu de la comparaison des évaluations.

Nom	Type	Description	Obligatoire
Comparaisons	tableau d’EvalRunResultComparison	Les résultats de comparaison pour chaque traitement s’exécutent par rapport à la base de référence.	Oui
method	string	Méthode statistique utilisée pour la comparaison.	Oui
type	enum	Type de résultat d’insights. Valeurs possibles : `EvaluationComparison`	Oui

EvaluationResultSample

Un échantillon du résultat de l’évaluation.

Nom	Type	Description	Obligatoire
correlationInfo	Objet	Informations sur la corrélation de l’exemple d’analyse.	Oui
evaluationResult	EvalResult	Résultat de l’évaluation.	Oui
└─ Nom	string	nom de la vérification	Oui
└─ réussi	booléen	indique si la vérification a réussi ou échoué	Oui
Score └ ;	Numéro	Résultat	Oui
└─ Type	string	type de la vérification	Oui
features	Objet	Fonctionnalités permettant de faciliter le filtrage supplémentaire des données dans l’expérience utilisateur.	Oui
id	string	Identificateur unique de l’exemple d’analyse.	Oui
type	enum	Exemple de type de résultat d’évaluation Valeurs possibles : `EvaluationResultSample`	Oui

Règle d’évaluation

Modèle de règle d’évaluation.

Nom	Type	Description	Obligatoire
action	EvaluationRuleAction	Modèle d’action d’évaluation.	Oui
└─ Type	EvaluationRuleActionType	Type d’action d’évaluation.	Oui
description	string	Description de la règle d’évaluation.	Non
displayName	string	Nom complet de la règle d’évaluation.	Non
enabled	booléen	Indique si la règle d’évaluation est activée. La valeur par défaut est true.	Oui
eventType	EvaluationRuleEventType	Type de l’événement de règle d’évaluation.	Oui
filter	EvaluationRuleFilter	Modèle de filtre d’évaluation.	Non
└} agentName	string	Filtrez par nom d’agent.	Oui
id	chaîne (en lecture seule)	Identificateur unique de la règle d’évaluation.	Oui
données système	objet (en lecture seule)	Métadonnées système pour la règle d’évaluation.	Oui

EvaluationRuleAction

Modèle d’action d’évaluation.

Discriminateur pour EvaluationRuleAction

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

Type de valeur	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

Nom	Type	Description	Obligatoire	Par défaut
type	EvaluationRuleActionType	Type d’action d’évaluation.	Oui

EvaluationRuleActionType

Type d’action d’évaluation.

Propriété	Valeur
Description	Type d’action d’évaluation.
Type	string
Valeurs	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

Type de l’événement de règle d’évaluation.

Propriété	Valeur
Description	Type de l’événement de règle d’évaluation.
Type	string
Valeurs	`responseCompleted` `manual`

EvaluationRuleFilter

Modèle de filtre d’évaluation.

Nom	Type	Description	Obligatoire	Par défaut
agentNom	string	Filtrez par nom d’agent.	Oui

EvaluationRunClusterInsightRequest

Aperçu de l’ensemble des résultats de l’évaluation

Nom	Type	Description	Obligatoire
evalId	string	ID d’évaluation pour les insights.	Oui
modèleConfiguration	InsightModelConfiguration	Configuration du modèle utilisé dans la génération d’insights.	Non
└} modelDeploymentName	string	Déploiement du modèle à évaluer. Accepte le nom de déploiement seul ou avec le nom de connexion en tant que `{connectionName}/<modelDeploymentName>`.	Oui
runIds	tableau de chaînes	Liste des ID d’exécution d’évaluation pour les insights.	Oui
type	enum	Type de requête Insights. Valeurs possibles : `EvaluationRunClusterInsight`	Oui

EvaluationRunClusterInsightResult

Les informations tirées de l’analyse de cluster d’exécution de l’évaluation.

Nom	Type	Description	Obligatoire	Par défaut
clusterInsight	ClusterInsightResult	Enseignements tirés de l’analyse des clusters.	Oui
type	enum	Type de résultat d’insights. Valeurs possibles : `EvaluationRunClusterInsight`	Oui

EvaluationScheduleTask

Tâche d’évaluation de la planification.

Nom	Type	Description	Obligatoire
configuration	Objet	Configuration de la tâche.	Non
evalId	string	Identificateur du groupe d’évaluation.	Oui
evalRun	Objet	Charge utile d’exécution de l’évaluation.	Oui
type	enum	Valeurs possibles : `Evaluation`	Oui

EvaluationTaxonomy

Taxonomie d’évaluation Définition

Nom	Type	Description	Obligatoire
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
properties	Objet	Propriétés supplémentaires pour la taxonomie d’évaluation.	Non
taxonomyCategories	tableau de TaxonomyCategory	Liste des catégories de taxonomie.	Non
taxonomyInput	EvaluationTaxonomyInput	Configuration d’entrée pour la taxonomie d’évaluation.	Oui
└─ Type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

EvaluationTaxonomyCreateOrUpdate

Taxonomie d’évaluation Définition

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
properties	Objet	Propriétés supplémentaires pour la taxonomie d’évaluation.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
taxonomyCategories	tableau de TaxonomyCategory	Liste des catégories de taxonomie.	Non
taxonomyInput	EvaluationTaxonomyInput	Configuration d’entrée pour la taxonomie d’évaluation.	Oui
└─ Type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui

EvaluationTaxonomyInput

Configuration d’entrée pour la taxonomie d’évaluation.

Discriminateur pour EvaluationTaxonomyInput

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

Type de valeur	Schema
`agent`	AgentTaxonomyInput

Nom	Type	Description	Obligatoire	Par défaut
type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui

EvaluationTaxonomyInputType

Type d’entrée de la taxonomie d’évaluation.

Propriété	Valeur
Description	Type d’entrée de la taxonomie d’évaluation.
Type	string
Valeurs	`agent` `policy`

EvaluationTaxonomyInputUpdate

Configuration d’entrée pour la taxonomie d’évaluation.

Discriminateur pour EvaluationTaxonomyInputUpdate

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

Type de valeur	Schema
`agent`	AgentTaxonomyInputUpdate

Nom	Type	Description	Obligatoire	Par défaut
type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui

EvaluationTaxonomyUpdate

Taxonomie d’évaluation Définition

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
properties	Objet	Propriétés supplémentaires pour la taxonomie d’évaluation.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
taxonomyCategories	tableau de TaxonomyCategory	Liste des catégories de taxonomie.	Non
taxonomyInput	EvaluationTaxonomyInputUpdate	Configuration d’entrée pour la taxonomie d’évaluation.	Non
└─ Type	EvaluationTaxonomyInputType	Type d’entrée de la taxonomie d’évaluation.	Oui

ÉvaluateurCategory

La catégorie de l’évaluateur

Propriété	Valeur
Description	La catégorie de l’évaluateur
Type	string
Valeurs	`quality` `safety` `agents`

ÉvaluateurDefinition

Configuration de l’évaluateur de base avec discriminateur

Discriminateur pour l’évaluateurDefinition

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

Type de valeur	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

Nom	Type	Description	Obligatoire
data_schema	Objet	Le schéma JSON (Draft 2020-12) pour les données d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
init_parameters	Objet	Le schéma JSON (Draft 2020-12) pour les paramètres d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
metrics	Objet	Liste des paramètres de production produits par cet évaluateur	Non
type	AssessDefinitionType	Définition du type d’évaluateur	Oui

AssessDefinitionType

Définition du type d’évaluateur

Propriété	Valeur
Description	Définition du type d’évaluateur
Type	string
Valeurs	`prompt` `code` `prompt_and_code` `service` `openai_graders`

ÉvaluateurMetric

Mesure de l’évaluateur

Nom	Type	Description	Obligatoire
desirable_direction	ÉvaluateurMetricDirection	Direction de la métrique indiquant si une valeur supérieure est meilleure, une valeur inférieure est meilleure ou neutre	Non
is_primary	booléen	Indique si cette métrique est primaire lorsqu’il existe plusieurs métriques.	Non
max_value	Numéro	Valeur maximale de la métrique. S’il n’est pas spécifié, il est supposé être non lié.	Non
min_value	Numéro	Valeur minimale pour la métrique	Non
type	AssessMetricType	Le type d’évaluateur	Non

ÉvaluateurMetricDirection

Direction de la métrique indiquant si une valeur supérieure est meilleure, une valeur inférieure est meilleure ou neutre

Propriété	Valeur
Description	Direction de la métrique indiquant si une valeur supérieure est meilleure, une valeur inférieure est meilleure ou neutre
Type	string
Valeurs	`increase` `decrease` `neutral`

AssessMetricType

Le type d’évaluateur

Propriété	Valeur
Description	Le type d’évaluateur
Type	string
Valeurs	`ordinal` `continuous` `boolean`

AssessType

Le type d’évaluateur

Propriété	Valeur
Description	Le type d’évaluateur
Type	string
Valeurs	`builtin` `custom`

AssessVersion

Définition de l’évaluateur

Nom	Type	Description	Obligatoire
categories	tableau d’évaluateurCategory	Les catégories de l’évaluateur	Oui
date_de_création	chaîne (en lecture seule)	Date/heure de création de l’évaluateur	Oui
created_by	chaîne (en lecture seule)	Créateur de l’évaluateur	Oui
Définition	ÉvaluateurDefinition	Configuration de l’évaluateur de base avec discriminateur	Oui
└data_schema	Objet	Le schéma JSON (Draft 2020-12) pour les données d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
└init_parameters	Objet	Le schéma JSON (Draft 2020-12) pour les paramètres d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
Métriques └>	Objet	Liste des paramètres de production produits par cet évaluateur	Non
└─ Type	AssessDefinitionType	Définition du type d’évaluateur	Oui
display_name	string	Nom d’affichage de l’évaluateur. Cela aide à trouver facilement l’évaluateur dans AI Foundry. Il n’a pas besoin d’être unique.	Non
evaluator_type	AssessType	Le type d’évaluateur	Oui
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
Métadonnées	Objet	Métadonnées sur l’évaluateur	Non
modified_at	chaîne (en lecture seule)	Date/heure de la dernière modification de l’évaluateur	Oui
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

EvaluateVersionCreate

Définition de l’évaluateur

Nom	Type	Description	Obligatoire
categories	tableau d’évaluateurCategory	Les catégories de l’évaluateur	Oui
Définition	ÉvaluateurDefinition	Configuration de l’évaluateur de base avec discriminateur	Oui
└data_schema	Objet	Le schéma JSON (Draft 2020-12) pour les données d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
└init_parameters	Objet	Le schéma JSON (Draft 2020-12) pour les paramètres d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
Métriques └>	Objet	Liste des paramètres de production produits par cet évaluateur	Non
└─ Type	AssessDefinitionType	Définition du type d’évaluateur	Oui
description	string	Texte de description de la ressource.	Non
display_name	string	Nom d’affichage de l’évaluateur. Cela aide à trouver facilement l’évaluateur dans AI Foundry. Il n’a pas besoin d’être unique.	Non
evaluator_type	AssessType	Le type d’évaluateur	Oui
Métadonnées	Objet	Métadonnées sur l’évaluateur	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non

AssessVersionUpdate

Définition de l’évaluateur

Nom	Type	Description	Obligatoire
categories	tableau d’évaluateurCategory	Les catégories de l’évaluateur	Non
description	string	Texte de description de la ressource.	Non
display_name	string	Nom d’affichage de l’évaluateur. Cela aide à trouver facilement l’évaluateur dans AI Foundry. Il n’a pas besoin d’être unique.	Non
Métadonnées	Objet	Métadonnées sur l’évaluateur	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non

FabricDataAgentToolParameters

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

Nom	Type	Description	Obligatoire	Par défaut
project_connections	tableau d’ToolProjectConnection	Connexions project attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil.	Non

FileDatasetVersion

FileDatasetDéfinition de version

Nom	Type	Description	Obligatoire
connectionName	string	Nom de connexion de compte stockage Azure. Obligatoire si startPendingUploadVersion n’a pas été appelé avant de créer le jeu de données	Non
dataUri	string	URI des données (exemple) Contraintes : minLength : 1, modèle : `[a-zA-Z0-9_]`	Oui
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
isReference	booléen (en lecture seule)	Indique si le jeu de données contient une référence au stockage, ou si le jeu de données gère lui-même le stockage. Si la valeur est true, les données sous-jacentes ne sont pas supprimées lorsque la version du jeu de données est supprimée	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	enum	Type de jeu de données Valeurs possibles : `uri_file`	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

FileDatasetVersionUpdate

FileDatasetDéfinition de version

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	enum	Type de jeu de données Valeurs possibles : `uri_file`	Oui

FolderDatasetVersion

FileDatasetDéfinition de version

Nom	Type	Description	Obligatoire
connectionName	string	Nom de connexion de compte stockage Azure. Obligatoire si startPendingUploadVersion n’a pas été appelé avant de créer le jeu de données	Non
dataUri	string	URI des données (exemple) Contraintes : minLength : 1, modèle : `[a-zA-Z0-9_]`	Oui
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
isReference	booléen (en lecture seule)	Indique si le jeu de données contient une référence au stockage, ou si le jeu de données gère lui-même le stockage. Si la valeur est true, les données sous-jacentes ne sont pas supprimées lorsque la version du jeu de données est supprimée	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	enum	Type de jeu de données Valeurs possibles : `uri_folder`	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

FolderDatasetVersionUpdate

FileDatasetDéfinition de version

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	enum	Type de jeu de données Valeurs possibles : `uri_folder`	Oui

FunctionToolCall

Détails d’un appel d’outil de fonction.

Nom	Type	Description	Obligatoire	Par défaut
Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON.	Oui
nom	string	Nom de la fonction à appeler.	Oui

HostedAgentDefinition

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

Nom	Type	Description	Obligatoire
container_protocol_versions	tableau de ProtocolVersionRecord	Protocoles pris en charge par l’agent pour la communication d’entrée des conteneurs.	Oui
cpu	string	Configuration de l’UC de l’agent hébergé.	Oui
environment_variables	Objet	Variables d’environnement à définir dans le conteneur de l’agent hébergé.	Non
image	string	ID d’image de l’agent, applicable aux agents hébergés en fonction de l’image.	Non
kind	enum	Valeurs possibles : `hosted`	Oui
memory	string	Configuration de la mémoire de l’agent hébergé.	Oui
rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Oui
Outils	tableau d’OpenAI.Tool	Un ensemble 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.	Non

HourlyRecurrenceSchedule

Calendrier de récurrence horaire.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `Hourly`	Oui

HumanEvaluationPreviewRuleAction

Action de règle d’évaluation pour l’évaluation humaine.

Nom	Type	Description	Obligatoire	Par défaut
templateId	AssetId	Identificateur d’une ressource enregistrée.	Oui
type	enum	Valeurs possibles : `humanEvaluationPreview`	Oui

Index

Définition de ressource d’index

Discriminateur pour index

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

Type de valeur	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Nom	Type	Description	Obligatoire
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	IndexType		Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

IndexType

Propriété	Valeur
Type	string
Valeurs	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

Définition de ressource d’index

Discriminateur pour IndexUpdate

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

Type de valeur	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	IndexType		Oui

Perspicacité

Corps de la réponse pour les informations sur le cluster.

Nom	Type	Description	Obligatoire
displayName	string	Nom d’affichage convivial pour l’insight.	Oui
id	chaîne (en lecture seule)	Identificateur unique du rapport Insights.	Oui
Métadonnées	InsightsMetadata (en lecture seule)	Métadonnées sur les informations.	Oui
└' completedAt	string	Horodatage lorsque les insights ont été terminés.	Non
└> createdAt	string	Horodatage lorsque les insights ont été créés.	Oui
request	InsightRequest	La demande du rapport d’analyses.	Oui
└─ Type	InsightType	Type de requête.	Oui
result	InsightResult (en lecture seule)	Le résultat de ces idées.	Non
└─ Type	InsightType	Type de résultat d’insights.	Oui
state	Azure. Core.Foundations.OperationState (lecture seule)	Enum décrivant les états de fonctionnement autorisés.	Oui

InsightCluster

Un groupe d’échantillons d’analyse.

Nom	Type	Description	Obligatoire
description	string	Description du cluster d’analyse.	Oui
id	string	ID du cluster d’analyse.	Oui
label	string	Étiquette du cluster	Oui
Échantillons	tableau d’InsightSample	Liste d’exemples appartenant à ce cluster. Vide si les exemples font partie des sous-cluster.	Non
sous-cluster	tableau d’InsightCluster	Liste des sous-clusters au sein de ce cluster. Vide si aucun sous-cluster n’existe.	Non
Suggestion	string	Suggestion pour le cluster	Oui
suggestionTitle	string	Titre de la suggestion pour le cluster	Oui
weight	entier	Poids du cluster d’analyse. Cela indique le nombre d’exemples dans le cluster.	Oui

InsightModelConfiguration

Configuration du modèle utilisé dans la génération d’insights.

Nom	Type	Description	Obligatoire	Par défaut
modelDeploymentName	string	Déploiement du modèle à évaluer. Accepte le nom de déploiement seul ou avec le nom de connexion en tant que `{connectionName}/<modelDeploymentName>`.	Oui

InsightRequest

La demande du rapport d’analyses.

Discriminateur pour InsightRequest

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

Type de valeur	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

Nom	Type	Description	Obligatoire	Par défaut
type	InsightType	La demande des insights.	Oui

InsightResult

Le résultat de ces idées.

Discriminateur pour InsightResult

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

Type de valeur	Schema
`EvaluationComparison`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Nom	Type	Description	Obligatoire	Par défaut
type	InsightType	La demande des insights.	Oui

InsightSample

Un échantillon de l’analyse.

Discriminateur pour InsightSample

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

Type de valeur	Schema
`EvaluationResultSample`	EvaluationResultSample

Nom	Type	Description	Obligatoire
correlationInfo	Objet	Informations sur la corrélation de l’exemple d’analyse.	Oui
features	Objet	Fonctionnalités permettant de faciliter le filtrage supplémentaire des données dans l’expérience utilisateur.	Oui
id	string	Identificateur unique de l’exemple d’analyse.	Oui
type	SampleType	Le type d’échantillon utilisé dans l’analyse.	Oui

InsightScheduleTask

Tâche d’aperçu pour la planification.

Nom	Type	Description	Obligatoire
configuration	Objet	Configuration de la tâche.	Non
aperçu	Informations	Corps de la réponse pour les informations sur le cluster.	Oui
└> displayName	string	Nom d’affichage convivial pour l’insight.	Oui
└─ identifiant	chaîne (en lecture seule)	Identificateur unique du rapport Insights.	Oui
└─ Métadonnées	InsightsMetadata (en lecture seule)	Métadonnées relatives au rapport Insights.	Oui
Demande └>	InsightRequest	Demande d’analyse des insights.	Oui
Résultat └ ;	InsightResult (en lecture seule)	Résultat du rapport d’insights.	Non
État └>	Azure. Core.Foundations.OperationState (lecture seule)	État actuel des insights.	Oui
type	enum	Valeurs possibles : `Insight`	Oui

InsightSummary

Résumé de l’analyse du cluster d’erreurs.

Nom	Type	Description	Obligatoire
method	string	Méthode utilisée pour le clustering.	Oui
sampleCount	entier	Nombre total d’échantillons analysés.	Oui
uniqueClusterCount	entier	Nombre total de clusters uniques.	Oui
uniqueSubclusterCount	entier	Nombre total d’étiquettes de sous-cluster uniques.	Oui
utilisation	ClusterTokenUsage	Utilisation du jeton pour l’analyse de cluster	Oui
└> inputTokenUsage	entier	Utilisation des jetons d’entrée	Oui
└> outputTokenUsage	entier	Utilisation des jetons de sortie	Oui
└> totalTokenUsage	entier	utilisation totale des jetons	Oui

InsightType

La demande des insights.

Propriété	Valeur
Description	La demande des insights.
Type	string
Valeurs	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Métadonnées sur les informations.

Nom	Type	Description	Obligatoire	Par défaut
completedAt	string	Horodatage lorsque les insights ont été terminés.	Non
createdAt	string	Horodatage lorsque les insights ont été créés.	Oui

ItemGenerationParams

Représente l’ensemble des paramètres utilisés pour contrôler les opérations de génération d’éléments.

Discriminateur pour ItemGenerationParams

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

Type de valeur	Schema
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

Nom	Type	Description	Obligatoire	Par défaut
type	ItemGenerationParamsType	Types de paramètres pour la génération d’éléments d’équipe rouge.	Oui

ItemGenerationParamsType

Types de paramètres pour la génération d’éléments d’équipe rouge.

Propriété	Valeur
Description	Types de paramètres pour la génération d’éléments d’équipe rouge.
Type	string
Valeurs	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Définition d’index de Recherche Azure AI managée

Nom	Type	Description	Obligatoire
id	chaîne (en lecture seule)	ID de l’actif, un identifiant unique pour l’actif	Non
nom	chaîne (en lecture seule)	nom de la ressource.	Oui
type	enum	Type d’index Valeurs possibles : `ManagedAzureSearch`	Oui
version	chaîne (en lecture seule)	La version de la ressource	Oui

ManagedAzureAISearchIndexUpdate

Définition d’index de Recherche Azure AI managée

Nom	Type	Description	Obligatoire
description	string	Texte de description de la ressource.	Non
tags	Objet	Dictionnaire de balises. Les balises peuvent être ajoutées, supprimées et mises à jour.	Non
type	enum	Type d’index Valeurs possibles : `ManagedAzureSearch`	Oui

MemoryItem

Élément de mémoire unique stocké dans la mémoire et contenant du contenu et des métadonnées.

Discriminateur pour MemoryItem

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

Type de valeur	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

Nom	Type	Description	Obligatoire
contenu	string	Le contenu de la mémoire.	Oui
kind	MemoryItemKind	Type d’élément de mémoire.	Oui
memory_id	string	ID unique de l’élément de mémoire.	Oui
scope	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui
updated_at	entier	Heure de la dernière mise à jour de l’élément de mémoire.	Oui

MemoryItemKind

Type d’élément de mémoire.

Propriété	Valeur
Description	Type d’élément de mémoire.
Type	string
Valeurs	`user_profile` `chat_summary`

MemoryOperation

Représente une opération de mémoire unique (création, mise à jour ou suppression) effectuée sur un élément de mémoire.

Nom	Type	Description	Obligatoire
kind	MemoryOperationKind	Type d’opération de mémoire.	Oui
memory_item	MemoryItem	Élément de mémoire unique stocké dans la mémoire et contenant du contenu et des métadonnées.	Oui
└─ Contenu	string	Le contenu de la mémoire.	Oui
Type └	MemoryItemKind	Type de l’élément de mémoire.	Oui
└memory_id	string	ID unique de l’élément de mémoire.	Oui
Étendue └ ;	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui
└updated_at	entier	Heure de la dernière mise à jour de l’élément de mémoire.	Oui

MemoryOperationKind

Type d’opération de mémoire.

Propriété	Valeur
Description	Type d’opération de mémoire.
Type	string
Valeurs	`create` `update` `delete`

MemorySearchItem

Élément de mémoire récupéré à partir de la recherche de mémoire.

Nom	Type	Description	Obligatoire
memory_item	MemoryItem	Élément de mémoire unique stocké dans la mémoire et contenant du contenu et des métadonnées.	Oui
└─ Contenu	string	Le contenu de la mémoire.	Oui
Type └	MemoryItemKind	Type de l’élément de mémoire.	Oui
└memory_id	string	ID unique de l’élément de mémoire.	Oui
Étendue └ ;	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui
└updated_at	entier	Heure de la dernière mise à jour de l’élément de mémoire.	Oui

MemorySearchOptions

Options de recherche de mémoire.

Nom	Type	Description	Obligatoire	Par défaut
max_memories	entier	Nombre maximal d’éléments de mémoire à retourner.	Non

MemorySearchPreviewTool

Un outil d’intégration de souvenirs dans l’agent.

Nom	Type	Description	Obligatoire	Par défaut
memory_store_name	string	Nom de la mémoire à utiliser.	Oui
scope	string	Espace de noms utilisé pour regrouper et isoler les souvenirs, tel qu’un ID utilisateur. Limite les souvenirs qui peuvent être récupérés ou mis à jour. Utilisez une variable `{{$userId}}` spéciale pour étendre les souvenirs à l’utilisateur actuellement connecté.	Oui
search_options	MemorySearchOptions	Options de recherche de mémoire.	Non
└max_memories	entier	Nombre maximal d’éléments de mémoire à retourner.	Non
type	enum	Type de l’outil. A toujours la valeur `memory_search_preview`. Valeurs possibles : `memory_search_preview`	Oui
update_delay	entier	Temps d’attente avant de mettre à jour les mémoires après l’inactivité (secondes). Par défaut 300.	Non	300

MemorySearchToolCallItemParam

Nom	Type	Description	Obligatoire	Par défaut
results	tableau de MemorySearchItem	Résultats retournés par la recherche en mémoire.	Non
type	enum	Valeurs possibles : `memory_search_call`	Oui

MemorySearchToolCallItemResource

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
response_id	string	Réponse sur laquelle l’élément est créé.	Non
results	tableau de MemorySearchItem	Résultats retournés par la recherche en mémoire.	Non
status	enum	État de l’appel de l’outil de recherche de mémoire. Valeurs possibles : `in_progress`, `searching`, `completed`ou `incompletefailed`, Valeurs possibles : `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Oui
type	enum	Valeurs possibles : `memory_search_call`	Oui

MemoryStoreDefaultDefinition

Implémentation de la mémoire par défaut.

Nom	Type	Description	Obligatoire	Par défaut
chat_model	string	Nom ou identificateur du déploiement du modèle d’achèvement de conversation utilisé pour le traitement de la mémoire.	Oui
embedding_model	string	Nom ou identificateur du déploiement du modèle d’incorporation utilisé pour le traitement de la mémoire.	Oui
kind	enum	Type de magasin de mémoire. Valeurs possibles : `default`	Oui
options	MemoryStoreDefaultOptions	Configurations de stockage de mémoire par défaut.	Non
└chat_summary_enabled	booléen	Indique s’il faut activer l’extraction récapitulative de conversation et storage. La valeur par défaut est true.	Oui	True
└user_profile_details	string	Des catégories ou des types spécifiques d’informations de profil utilisateur à extraire et à stocker.	Non
└user_profile_enabled	booléen	Indique s’il faut activer l’extraction de profil utilisateur et storage. La valeur par défaut est true.	Oui	True

MemoryStoreDefaultOptions

Configurations de stockage de mémoire par défaut.

Nom	Type	Description	Obligatoire	Par défaut
chat_summary_enabled	booléen	Indique s’il faut activer l’extraction récapitulative de conversation et storage. La valeur par défaut est true.	Oui	True
user_profile_details	string	Des catégories ou des types spécifiques d’informations de profil utilisateur à extraire et à stocker.	Non
user_profile_enabled	booléen	Indique s’il faut activer l’extraction de profil utilisateur et storage. La valeur par défaut est true.	Oui	True

MemoryStoreDefinition

Définition de base pour les configurations de stockage de mémoire.

Discriminateur pour MemoryStoreDefinition

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

Type de valeur	Schema
`default`	MemoryStoreDefaultDefinition

Nom	Type	Description	Obligatoire	Par défaut
kind	MemoryStoreKind	Type d’implémentation de la mémoire à utiliser.	Oui

MemoryStoreDeleteScopeResponse

Réponse à la suppression de mémoires d’une étendue.

Nom	Type	Description	Obligatoire
supprimé	booléen	Indique si l’opération de suppression a réussi.	Oui
nom	string	Nom du magasin de mémoire.	Oui
Objet	enum	Type d’objet. Toujours « memory_store.scope.deleted ». Valeurs possibles : `memory_store.scope.deleted`	Oui
scope	string	Étendue à partir de laquelle les mémoires ont été supprimées.	Oui

MemoryStoreKind

Type d’implémentation de la mémoire à utiliser.

Propriété	Valeur
Description	Type d’implémentation de la mémoire à utiliser.
Type	string
Valeurs	`default`

MemoryStoreObject

Mémoire qui permet de stocker et de récupérer les mémoires des utilisateurs.

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (secondes) lors de la création du magasin de mémoire.	Oui
Définition	MemoryStoreDefinition	Définition de base pour les configurations de stockage de mémoire.	Oui
Type └	MemoryStoreKind	Type de magasin de mémoire.	Oui
description	string	Description lisible par l’homme du magasin de mémoire. Contraintes : maxLength : 512	Non
id	string	Identificateur unique du magasin de mémoire.	Oui
Métadonnées	Objet	Métadonnées de clé-valeur arbitraires à associer au magasin de mémoire.	Non
nom	string	Nom du magasin de mémoire. Contraintes : maxLength : 256	Oui
Objet	enum	Type d’objet, qui est toujours « memory_store ». Valeurs possibles : `memory_store`	Oui
updated_at	entier	Horodatage Unix (secondes) lors de la dernière mise à jour du magasin de mémoire.	Oui

MemoryStoreOperationUsage

Statistiques d’utilisation d’une opération de stockage de mémoire.

Nom	Type	Description	Obligatoire
embedding_tokens	entier	Nombre de jetons d’incorporation.	Oui
input_tokens	OpenAI.integer		Oui
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Oui
└cached_tokens	OpenAI.integer		Oui
output_tokens	OpenAI.integer		Oui
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Oui
└─ jetons_de_raisonnement	OpenAI.integer		Oui
total_tokens	OpenAI.integer		Oui

MemoryStoreSearchResponse

Réponse de recherche en mémoire.

Nom	Type	Description	Obligatoire
Souvenirs	tableau de MemorySearchItem	Éléments de mémoire associés trouvés pendant l’opération de recherche.	Oui
search_id	string	ID unique de cette requête de recherche. Utilisez cette valeur comme previous_search_id dans les requêtes suivantes pour effectuer des recherches incrémentielles.	Oui
utilisation	MemoryStoreOperationUsage	Statistiques d’utilisation d’une opération de stockage de mémoire.	Oui
└embedding_tokens	entier	Nombre de jetons d’incorporation.	Oui
└input_tokens	OpenAI.integer	Nombre de jetons d’entrée.	Oui
└ détails_des_jets_d'entrée	OpenAI.ResponseUsageInputTokensDetails	Répartition détaillée des jetons d’entrée.	Oui
└output_tokens	OpenAI.integer	Nombre de jetons de sortie.	Oui
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Répartition détaillée des jetons de sortie.	Oui
└total_tokens	OpenAI.integer	Nombre total de jetons utilisés.	Oui

MemoryStoreUpdateCompletedResult

Résultat de la mise à jour de la mémoire.

Nom	Type	Description	Obligatoire
memory_operations	tableau de MemoryOperation	Liste des opérations de mémoire individuelles effectuées pendant la mise à jour.	Oui
utilisation	MemoryStoreOperationUsage	Statistiques d’utilisation d’une opération de stockage de mémoire.	Oui
└embedding_tokens	entier	Nombre de jetons d’incorporation.	Oui
└input_tokens	OpenAI.integer	Nombre de jetons d’entrée.	Oui
└ détails_des_jets_d'entrée	OpenAI.ResponseUsageInputTokensDetails	Répartition détaillée des jetons d’entrée.	Oui
└output_tokens	OpenAI.integer	Nombre de jetons de sortie.	Oui
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Répartition détaillée des jetons de sortie.	Oui
└total_tokens	OpenAI.integer	Nombre total de jetons utilisés.	Oui

MemoryStoreUpdateResponse

Fournit l’état d’une opération de mise à jour de la mémoire précieuse.

Nom	Type	Description	Obligatoire
erreur	OpenAI.Error		Non
└> additionalInfo	Objet		Non
└─ Code	chaîne (nullable)		Oui
└> debugInfo	Objet		Non
└─ détails	tableau d’OpenAI.Error		Non
└─ Message	string		Oui
└> param	chaîne (nullable)		Non
└─ Type	string		Non
result	MemoryStoreUpdateCompletedResult	Résultat de la mise à jour de la mémoire.	Non
└memory_operations	tableau de MemoryOperation	Liste des opérations de mémoire individuelles effectuées pendant la mise à jour.	Oui
└─ utilisation	MemoryStoreOperationUsage	Statistiques d’utilisation associées à l’opération de mise à jour de la mémoire.	Oui
status	MemoryStoreUpdateStatus	État d’une opération de mise à jour de la mémoire stockée.	Oui
superseded_by	string	La update_id l’opération a été remplacée par le moment où l’état est « remplacé ».	Non
update_id	string	ID unique de cette demande de mise à jour. Utilisez cette valeur comme previous_update_id dans les requêtes suivantes pour effectuer des mises à jour incrémentielles.	Oui

MemoryStoreUpdateStatus

État d’une opération de mise à jour de la mémoire stockée.

Propriété	Valeur
Type	string
Valeurs	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

Les informations de définition d’entrée pour un outil Microsoft Fabric utilisées pour configurer un agent.

Nom	Type	Description	Obligatoire
fabric_dataagent_preview	FabricDataAgentToolParameters	Paramètres de l’outil Agent de données de fabric.	Oui
└project_connections	tableau d’ToolProjectConnection	Connexions project attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	Non
type	enum	Le type d’objet, qui est toujours « fabric_dataagent_preview ». Valeurs possibles : `fabric_dataagent_preview`	Oui

ModèleDéploiement

Définition du déploiement du modèle

Nom	Type	Description	Obligatoire
capabilities	objet (en lecture seule)	Fonctionnalités du modèle déployé	Oui
connectionName	chaîne (en lecture seule)	Le nom de la connexion du déploiement provient de	Non
modelName	chaîne (en lecture seule)	nom spécifique Publisher du modèle déployé	Oui
modelPublisher	chaîne (en lecture seule)	Nom de l’éditeur du modèle déployé	Oui
modelVersion	chaîne (en lecture seule)	version spécifique Publisher du modèle déployé	Oui
nom	chaîne (en lecture seule)	Nom du déploiement	Oui
sku	Référence SKU (lecture seule)	Informations sur la référence SKU	Oui
Capacité └<	entier	Capacité de référence SKU	Oui
Famille └ ;	string	Famille de références SKU	Oui
└─ Nom	string	Nom de la référence SKU	Oui
Taille de └>	string	Taille de la référence SKU	Oui
Niveau └>	string	Niveau de référence SKU	Oui
type	enum	Type du déploiement Valeurs possibles : `ModelDeployment`	Oui

ModelSamplingParams

Représente un ensemble de paramètres utilisés pour contrôler le comportement d’échantillonnage d’un modèle de langage pendant la génération de texte.

Nom	Type	Description	Obligatoire
max_completion_tokens	entier	Nombre maximal de jetons autorisés dans la saisie semi-automatique.	Oui
seed	entier	Valeur initiale aléatoire pour la reproductibilité.	Oui
Température	Numéro	Paramètre de température pour l’échantillonnage.	Oui
top_p	Numéro	Paramètre top-p pour l’échantillonnage du noyau.	Oui

ModelSamplingParamsUpdate

Représente un ensemble de paramètres utilisés pour contrôler le comportement d’échantillonnage d’un modèle de langage pendant la génération de texte.

Nom	Type	Description	Obligatoire
max_completion_tokens	entier	Nombre maximal de jetons autorisés dans la saisie semi-automatique.	Non
seed	entier	Valeur initiale aléatoire pour la reproductibilité.	Non
Température	Numéro	Paramètre de température pour l’échantillonnage.	Non
top_p	Numéro	Paramètre top-p pour l’échantillonnage du noyau.	Non

MonthlyRecurrenceSchedule

Calendrier mensuel de récurrence.

Nom	Type	Description	Obligatoire	Par défaut
daysOfMonth	tableau d’entiers	Jours du mois pour la planification de périodicité.	Oui
type	enum	Type de périodicité mensuelle. Valeurs possibles : `Monthly`	Oui

NoAuthenticationCredentials

Informations d’identification qui ne nécessitent pas d’authentification

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type d’informations d’identification Valeurs possibles : `None`	Oui

OAuthConsentRequestOutputItem

Demandez au service à l’utilisateur d’effectuer le consentement OAuth.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
consent_link	string	Lien que l’utilisateur peut utiliser pour effectuer le consentement OAuth.	Oui
id	string		Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
server_label	string	Étiquette du serveur pour la demande de consentement OAuth.	Oui
type	enum	Valeurs possibles : `oauth_consent_request`	Oui

OneTimeTrigger

Déclencheur unique.

Nom	Type	Description	Obligatoire	Par défaut
timeZone	string	Fuseau horaire pour le déclencheur à usage unique.	Non	UTC
triggerAt	string	Date et heure du déclencheur unique au format ISO 8601.	Oui
type	enum	Valeurs possibles : `OneTime`	Oui

OpenAI.Annotation

Annotation qui s’applique à une étendue de texte de sortie.

Discriminant pour OpenAI.Annotation

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

Type de valeur	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.AnnotationType		Oui

OpenAI.AnnotationType

Propriété	Valeur
Type	string
Valeurs	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Propriété	Valeur
Type	string
Valeurs	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Valeurs de résultat signalées pour les sorties d’appel de l’outil apply_patch.

Propriété	Valeur
Type	string
Valeurs	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Valeurs d’état signalées pour les appels d’outils apply_patch.

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Instructions décrivant comment créer un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire
Diff	string	Différences à appliquer.	Oui
path	string	Chemin d’accès du fichier à créer.	Oui
type	enum	Créez un fichier avec le diff fourni. Valeurs possibles : `create_file`	Oui

OpenAI.ApplyPatchCreateFileOperationParam

Instructions pour la création d’un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire
Diff	string	Contenu de différences unifié à appliquer lors de la création du fichier. Contraintes : maxLength : 10485760	Oui
path	string	Chemin d’accès du fichier à créer par rapport à la racine de l’espace de travail. Contraintes : minLength : 1	Oui
type	enum	Type d’opération. A toujours la valeur `create_file`. Valeurs possibles : `create_file`	Oui

OpenAI.ApplyPatchDeleteFileOperation

Instructions décrivant comment supprimer un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire	Par défaut
path	string	Chemin d’accès du fichier à supprimer.	Oui
type	enum	Supprimez le fichier spécifié. Valeurs possibles : `delete_file`	Oui

OpenAI.ApplyPatchDeleteFileOperationParam

Instructions pour supprimer un fichier existant via l’outil apply_patch.

Nom	Type	Description	Obligatoire	Par défaut
path	string	Chemin du fichier à supprimer par rapport à la racine de l’espace de travail. Contraintes : minLength : 1	Oui
type	enum	Type d’opération. A toujours la valeur `delete_file`. Valeurs possibles : `delete_file`	Oui

OpenAI.ApplyPatchFileOperation

Une des opérations create_file, delete_file ou update_file appliquées via apply_patch.

Discriminateur pour OpenAI.ApplyPatchFileOperation

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

Type de valeur	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ApplyPatchFileOperationType		Oui

OpenAI.ApplyPatchFileOperationType

Propriété	Valeur
Type	string
Valeurs	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

Une des opérations create_file, delete_file ou update_file fournies à l’outil apply_patch.

Discriminateur pour OpenAI.ApplyPatchOperationParam

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

Type de valeur	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ApplyPatchOperationParamType		Oui

OpenAI.ApplyPatchOperationParamType

Propriété	Valeur
Type	string
Valeurs	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

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

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type de l’outil. A toujours la valeur `apply_patch`. Valeurs possibles : `apply_patch`	Oui

OpenAI.ApplyPatchUpdateFileOperation

Instructions décrivant comment mettre à jour un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire
Diff	string	Différences à appliquer.	Oui
path	string	Chemin d’accès du fichier à mettre à jour.	Oui
type	enum	Mettez à jour un fichier existant avec le diff fourni. Valeurs possibles : `update_file`	Oui

OpenAI.ApplyPatchUpdateFileOperationParam

Instructions pour mettre à jour un fichier existant via l’outil apply_patch.

Nom	Type	Description	Obligatoire
Diff	string	Contenu de différences unifié à appliquer au fichier existant. Contraintes : maxLength : 10485760	Oui
path	string	Chemin du fichier à mettre à jour par rapport à la racine de l’espace de travail. Contraintes : minLength : 1	Oui
type	enum	Type d’opération. A toujours la valeur `update_file`. Valeurs possibles : `update_file`	Oui

OpenAI.ApproximateLocation

Nom	Type	Description	Obligatoire
Ville	chaîne (nullable)		Non
country	chaîne (nullable)		Non
region	chaîne (nullable)		Non
timezone	chaîne (nullable)		Non
type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Oui

Outil de Complétion de Chat d'OpenAI

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

Nom	Type	Description	Obligatoire	Par défaut
function	OpenAI.FunctionObject		Oui
type	enum	Type de l’outil. Actuellement, seule `function` est prise en charge. Valeurs possibles : `function`	Oui

OpenAI.ChatModel

Propriété Valeur

Type string

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

OpenAI.ClickButtonType

Propriété	Valeur
Type	string
Valeurs	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Action de clic.

Nom	Type	Description	Obligatoire
Bouton	OpenAI.ClickButtonType		Oui
type	enum	Spécifie le type d’événement. Pour une action de clic, cette propriété est toujours `click`. Valeurs possibles : `click`	Oui
x	OpenAI.integer		Oui
y	OpenAI.integer		Oui

OpenAI.CodeInterpreterContainerAuto

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

Nom	Type	Description	Obligatoire
identifiants_de_fichiers	tableau de chaînes	Une liste facultative de fichiers chargés à mettre au service de votre code.	Non
limite_de_mémoire	OpenAI.ContainerMemoryLimit (annulable)		Non
type	enum	A toujours la valeur `auto`. Valeurs possibles : `auto`	Oui

OpenAI.CodeInterpreterOutputImage

Sortie de l’image de l’interpréteur de code.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type de la sortie. A toujours la valeur `image`. Valeurs possibles : `image`	Oui
url	string	URL de la sortie de l’image à partir de l’interpréteur de code.	Oui

OpenAI.CodeInterpreterOutputLogs

Sortie des journaux à partir de l’interpréteur de code.

Nom	Type	Description	Obligatoire	Par défaut
logs	string	Sortie des journaux à partir de l’interpréteur de code.	Oui
type	enum	Type de la sortie. A toujours la valeur `logs`. Valeurs possibles : `logs`	Oui

OpenAI.CodeInterpreterTool

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

Nom	Type	Description	Obligatoire	Par défaut
container	string ou OpenAI.CodeInterpreterContainerAuto	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.	Non
type	enum	Type de l’outil d’interpréteur de code. A toujours la valeur `code_interpreter`. Valeurs possibles : `code_interpreter`	Oui

OpenAI.CompactResource

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (en secondes) lors de la création de la conversation compactée.	Oui
id	string	Identificateur unique de la réponse compactée.	Oui
Objet	enum	Type d’objet. A toujours la valeur `response.compaction`. Valeurs possibles : `response.compaction`	Oui
sortie	tableau d’OpenAI.OutputItem	Liste compacte des éléments de sortie. Il s’agit d’une liste de tous les messages utilisateur, suivis d’un seul élément de compactage.	Oui
utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Oui
└input_tokens	OpenAI.integer	Nombre de jetons d’entrée.	Oui
└ détails_des_jets_d'entrée	OpenAI.ResponseUsageInputTokensDetails	Répartition détaillée des jetons d’entrée.	Oui
└output_tokens	OpenAI.integer	Nombre de jetons de sortie.	Oui
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Répartition détaillée des jetons de sortie.	Oui
└total_tokens	OpenAI.integer	Nombre total de jetons utilisés.	Oui

OpenAI.CompactResponseMethodPublicBody

Nom	Type	Description	Obligatoire
input	chaîne ou tableau d’OpenAI.InputItem		Non
Instructions	chaîne (nullable)		Non
model	OpenAI.ModelIdsCompaction	ID de modèle utilisé pour générer la réponse, comme `gpt-5` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, caractéristiques de performances et points de prix. Reportez-vous au guide de modèle pour parcourir et comparer les modèles disponibles.	Oui
previous_response_id	chaîne (nullable)		Non

OpenAI.ComparisonFilter

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.

Nom	Type	Description	Obligatoire
key	string	La clé à comparer avec la valeur.	Oui
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`	Oui
value	chaîne ou OpenAI.numeric ou booléen ou tableau d’OpenAI.ComparisonFilterValueItems	Valeur à comparer à la clé d’attribut ; prend en charge les types chaîne, nombre ou booléen.	Oui

OpenAI.ComparisonFilterValueItems

Type : chaîne ou OpenAI.numeric

OpenAI.CompoundFilter

Combinez plusieurs filtres à l’aide and ou or.

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

OpenAI.ComputerAction

Discriminant pour OpenAI.ComputerAction

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

Type de valeur	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Capture d’écran
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ComputerActionType		Oui

OpenAI.ComputerActionType

Propriété	Valeur
Type	string
Valeurs	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

Une vérification de sécurité en attente pour l'appel informatique.

Nom	Type	Description	Obligatoire
code	chaîne (nullable)		Non
id	string	ID de la vérification de sécurité en attente.	Oui
message	chaîne (nullable)		Non

OpenAI.ComputerEnvironment

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

OpenAI.ComputerScreenshotContent

Capture d’écran d’un ordinateur.

Nom	Type	Description	Obligatoire
identifiant_de_fichier	chaîne (nullable)		Oui
image_url	string		Oui
type	enum	Spécifie le type d’événement. Pour une capture d’écran d’ordinateur, cette propriété est toujours définie sur `computer_screenshot`. Valeurs possibles : `computer_screenshot`	Oui

OpenAI.ComputerScreenshotImage

Image de capture d’écran d’ordinateur utilisée avec l’outil d’utilisation de l’ordinateur.

Nom	Type	Description	Obligatoire
identifiant_de_fichier	string	Identificateur d’un fichier chargé qui contient la capture d’écran.	Non
image_url	string	URL de l’image de capture d’écran.	Non
type	enum	Spécifie le type d’événement. Pour une capture d’écran d’ordinateur, cette propriété est toujours défini sur `computer_screenshot`. Valeurs possibles : `computer_screenshot`	Oui

OpenAI.ComputerUsePreviewTool

Outil qui contrôle un ordinateur virtuel.

Nom	Type	Description	Obligatoire
hauteur_affichage	OpenAI.integer		Oui
largeur d'affichage	OpenAI.integer		Oui
environment	OpenAI.ComputerEnvironment		Oui
type	enum	Type de l’outil d’utilisation de l’ordinateur. A toujours la valeur `computer_use_preview`. Valeurs possibles : `computer_use_preview`	Oui

OpenAI.ContainerFileCitationBody

Citation d’un fichier conteneur utilisé pour générer une réponse de modèle.

Nom	Type	Description	Obligatoire
container_id	string	ID du fichier conteneur.	Oui
end_index	OpenAI.integer		Oui
identifiant_de_fichier	string	L’ID du dossier.	Oui
filename	string	Nom de fichier du fichier conteneur cité.	Oui
start_index	OpenAI.integer		Oui
type	enum	Type de la citation de fichier conteneur. A toujours la valeur `container_file_citation`. Valeurs possibles : `container_file_citation`	Oui

OpenAI.ContainerMemoryLimit

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

OpenAI.ConversationItem

Élément unique au sein d’une conversation. L’ensemble de types possibles est identique au output type d’un objet Response.

Discriminateur pour OpenAI.ConversationItem

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

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

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ConversationItemType		Oui

OpenAI.ConversationItemApplyPatchToolCall

Appel d’outil qui applique des différences de fichier en créant, supprimant ou mettant à jour des fichiers.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cet appel d’outil.	Non
id	string	ID unique de l’appel de l’outil apply patch. Renseigné lorsque cet élément est retourné via l’API.	Oui
fonctionnement	OpenAI.ApplyPatchFileOperation	Une des opérations create_file, delete_file ou update_file appliquées via apply_patch.	Oui
└─ Type	OpenAI.ApplyPatchFileOperationType		Oui
status	OpenAI.ApplyPatchCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call`. Valeurs possibles : `apply_patch_call`	Oui

OpenAI.ConversationItemApplyPatchToolCallOutput

Sortie émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cette sortie d’appel d’outil.	Non
id	string	ID unique de la sortie d’appel de l’outil appliquer le correctif. Renseigné lorsque cet élément est retourné via l’API.	Oui
sortie	chaîne (nullable)		Non
status	OpenAI.ApplyPatchCallOutputStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call_output`. Valeurs possibles : `apply_patch_call_output`	Oui

OpenAI.ConversationItemCodeInterpreterToolCall

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire
code	chaîne (nullable)		Oui
container_id	string	ID du conteneur utilisé pour exécuter le code.	Oui
id	string	ID unique de l’appel de l’outil interpréteur de code.	Oui
outputs	tableau d’OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Oui
status	enum	Le statut de l’appel de l’outil Interpréteur de code. Les valeurs acceptables sont : `in_progress`, `completed`, `incomplete`, `interpreting` et `failed`. Valeurs possibles : `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Oui
type	enum	Type de l’appel de l’outil interpréteur de code. A toujours la valeur `code_interpreter_call`. Valeurs possibles : `code_interpreter_call`	Oui

OpenAI.ConversationItemComputerToolCall

Un appel d’outil à un outil d’utilisation d’ordinateur. Pour plus d’informations, consultez le guide d’utilisation de l’ordinateur .

Nom	Type	Description	Obligatoire
action	OpenAI.ComputerAction		Oui
call_id	string	Identificateur utilisé lors de la réponse à l’appel de l’outil avec sortie.	Oui
id	string	ID unique de l’appel informatique.	Oui
pending_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité en attente pour l'appel informatique.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’ordinateur. A toujours la valeur `computer_call`. Valeurs possibles : `computer_call`	Oui

OpenAI.ConversationItemComputerToolCallOutputResource

Nom	Type	Description	Obligatoire
acknowledged_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité signalées par l’API qui ont été reconnues par le développeur	Non
call_id	string	L'identifiant de l’appel de l’outil informatique qui a produit la sortie.	Oui
id	string	Identifiant de la sortie de l'outil informatique utilisé.	Non
sortie	OpenAI.ComputerScreenshotImage	Image de capture d’écran d’ordinateur utilisée avec l’outil d’utilisation de l’ordinateur.	Oui
status	enum	État de l’entrée de message. Un des `in_progress`, ou `completed` `incomplete`. Rempli lorsque les éléments d’entrée sont retournés via l’API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de sortie de l’appel de l’outil informatique. A toujours la valeur `computer_call_output`. Valeurs possibles : `computer_call_output`	Oui

OpenAI.ConversationItemCustomToolCall

Appel à un outil personnalisé créé par le modèle.

Nom	Type	Description	Obligatoire
call_id	string	Identificateur utilisé pour mapper cet appel d’outil personnalisé à une sortie d’appel d’outil.	Oui
id	string	ID unique de l’appel d’outil personnalisé dans la plateforme OpenAI.	Non
input	string	Entrée de l’appel d’outil personnalisé généré par le modèle.	Oui
nom	string	Nom de l’outil personnalisé appelé.	Oui
type	enum	Type de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call`. Valeurs possibles : `custom_tool_call`	Oui

OpenAI.ConversationItemCustomToolCallOutput

Sortie d’un appel d’outil personnalisé à partir de votre code, renvoyé au modèle.

Nom	Type	Description	Obligatoire
call_id	string	ID d’appel, utilisé pour mapper cette sortie d’appel d’outil personnalisé à un appel d’outil personnalisé.	Oui
id	string	ID unique de la sortie d’appel d’outil personnalisé dans la plateforme OpenAI.	Non
sortie	chaîne ou tableau d’OpenAI.FunctionAndCustomToolCallOutput	Sortie de l’appel d’outil personnalisé généré par votre code. Il peut s’agir d’une chaîne ou d’une liste de contenu de sortie.	Oui
type	enum	Type de sortie de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call_output`. Valeurs possibles : `custom_tool_call_output`	Oui

OpenAI.ConversationItemFileSearchToolCall

Résultats d’un appel d’outil de recherche de fichiers. Pour plus d’informations, consultez le guide de recherche de fichiers .

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil de recherche de fichiers.	Oui
queries	tableau de chaînes	Requêtes utilisées pour rechercher des fichiers.	Oui
results	tableau d’OpenAI.FileSearchToolCallResults		Non
status	enum	État de l'accès à l’outil de recherche de fichiers. Valeurs possibles : `in_progress`, `searching`, `incomplete`, ou `failed` Valeurs possibles : `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche de fichiers. A toujours la valeur `file_search_call`. Valeurs possibles : `file_search_call`	Oui

OpenAI.ConversationItemFunctionShellCall

Appel d’outil qui exécute une ou plusieurs commandes shell dans un environnement managé.

Nom	Type	Description	Obligatoire
action	OpenAI.FunctionShellAction	Exécutez une commande shell.	Oui
Commandes └ ;	tableau de chaînes		Oui
└max_output_length	OpenAI.integer (annulable)		Oui
└timeout_ms	OpenAI.integer (annulable)		Oui
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cet appel d’outil.	Non
id	string	ID unique de l’appel de l’outil shell. Renseigné lorsque cet élément est retourné via l’API.	Oui
status	OpenAI.LocalShellCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui

OpenAI.ConversationItemFunctionShellCallOutput

Sortie d’un appel d’outil shell émis.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle.	Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
id	string	ID unique de la sortie de l’appel d’interpréteur de commandes. Renseigné lorsque cet élément est retourné via l’API.	Oui
max_output_length	OpenAI.integer (annulable)		Oui
sortie	tableau d’OpenAI.FunctionShellCallOutputContent	Tableau de contenu de sortie d’appel d’interpréteur de commandes	Oui
type	enum	Type de sortie de l’appel d’interpréteur de commandes. A toujours la valeur `shell_call_output`. Valeurs possibles : `shell_call_output`	Oui

OpenAI.ConversationItemFunctionToolCallOutputResource

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de sortie de l'outil fonctionnel. Renseigné lorsque cet élément est renseigné est retourné via l’API.	Non
sortie	chaîne ou tableau d’OpenAI.FunctionAndCustomToolCallOutput	Sortie de l’appel de fonction généré par votre code. Il peut s’agir d’une chaîne ou d’une liste de contenu de sortie.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de sortie de l'outil de fonctionnel. A toujours la valeur `function_call_output`. Valeurs possibles : `function_call_output`	Oui

OpenAI.ConversationItemFunctionToolCallResource

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON des arguments à passer à la fonction.	Oui
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de l'outil fonctionnel.	Non
nom	string	Nom de la fonction à exécuter.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de l'outil fonctionnel. A toujours la valeur `function_call`. Valeurs possibles : `function_call`	Oui

OpenAI.ConversationItemImageGenToolCall

Demande de génération d’image effectuée par le modèle.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de génération d’image.	Oui
result	chaîne (nullable)		Oui
status	enum	État de l’appel de génération d’image. Valeurs possibles : `in_progress`, , `completedgenerating`,`failed`	Oui
type	enum	Type de l’appel de génération d’image. A toujours la valeur `image_generation_call`. Valeurs possibles : `image_generation_call`	Oui

OpenAI.ConversationItemList

Liste des éléments de conversation.

Nom	Type	Description	Obligatoire
data	tableau d’OpenAI.ConversationItem	Liste des éléments de conversation.	Oui
premier_identifiant	string	ID du premier élément de la liste.	Oui
has_more	booléen	Indique s’il existe d’autres éléments disponibles.	Oui
last_id	string	ID du dernier élément de la liste.	Oui
Objet	enum	Le type d’objet retourné doit être `list`. Valeurs possibles : `list`	Oui

OpenAI.ConversationItemLocalShellToolCall

Un appel d’outil pour exécuter une commande sur l’interpréteur de commandes local.

Nom	Type	Description	Obligatoire
action	OpenAI.LocalShellExecAction	Exécutez une commande shell sur le serveur.	Oui
call_id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
id	string	ID unique de l’appel d’interpréteur de commandes local.	Oui
status	enum	État de l’appel d’interpréteur de commandes local. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’interpréteur de commandes local. A toujours la valeur `local_shell_call`. Valeurs possibles : `local_shell_call`	Oui

OpenAI.ConversationItemLocalShellToolCallOutput

Sortie d’un appel d’outil shell local.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
sortie	string	Chaîne JSON de la sortie de l’appel de l’outil shell local.	Oui
status	enum	Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de sortie de l’appel de l’outil shell local. A toujours la valeur `local_shell_call_output`. Valeurs possibles : `local_shell_call_output`	Oui

OpenAI.ConversationItemMcpApprovalRequest

Demande d'approbation humaine pour l'invocation d'un outil.

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON d’arguments pour l’outil.	Oui
id	string	ID unique de la demande d’approbation.	Oui
nom	string	Nom de l’outil à exécuter.	Oui
server_label	string	Étiquette du serveur MCP effectuant la requête.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_request`. Valeurs possibles : `mcp_approval_request`	Oui

OpenAI.ConversationItemMcpApprovalResponseResource

Une réponse à une requête d’approbation de MCP.

Nom	Type	Description	Obligatoire
approval_request_id	string	L’ID de la requête d’approbation à laquelle on répond.	Oui
Approuver	booléen	Indique si la demande a été approuvée.	Oui
id	string	ID unique de la réponse d’approbation	Oui
raison	chaîne (nullable)		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.ConversationItemMcpListTools

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	chaîne (nullable)		Non
id	string	ID unique de la liste.	Oui
server_label	string	Étiquette du serveur MCP.	Oui
Outils	tableau d’OpenAI.MCPListToolsTools	Outils disponibles sur le serveur.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_list_tools`. Valeurs possibles : `mcp_list_tools`	Oui

OpenAI.ConversationItemMcpToolCall

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne (nullable)		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	chaîne (nullable)		Non
id	string	ID unique de l’appel d’outil.	Oui
nom	string	Le nom de l’outil qui a été exécuté.	Oui
sortie	chaîne (nullable)		Non
server_label	string	Étiquette du serveur MCP exécutant l’outil.	Oui
status	OpenAI.MCPToolCallStatus		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_call`. Valeurs possibles : `mcp_call`	Oui

OpenAI.ConversationItemMessage

Message vers ou depuis le modèle.

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.MessageContent	Contenu du message	Oui
id	string	ID unique du message.	Oui
role	OpenAI.MessageRole		Oui
status	OpenAI.MessageStatus		Oui
type	enum	Type du message. Toujours défini sur `message`. Valeurs possibles : `message`	Oui

OpenAI.ConversationItemReasoningItem

Description de la chaîne de pensée utilisée par un modèle de raisonnement lors de la génération d’une réponse. Veillez à inclure ces éléments dans votre input API Réponses pour les tours suivants d’une conversation si vous gérez manuellement le contexte.

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.ReasoningTextContent	Contenu du texte de raisonnement.	Non
encrypted_content	chaîne (nullable)		Non
id	string	Identificateur unique du contenu du raisonnement.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
summary	tableau d’OpenAI.Summary	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.ConversationItemType

Propriété Valeur

Type string

Valeurs message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Résultats d’un appel d’outil de recherche web. Pour plus d’informations, consultez le guide de recherche web .

Nom	Type	Description	Obligatoire
action	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Objet décrivant l’action spécifique effectuée dans cet appel de recherche web. Inclut des détails sur la façon dont le modèle a utilisé le web (recherche, open_page, recherche).	Oui
id	string	ID unique de l’appel de l’outil de recherche web.	Oui
status	enum	L’état de l’appel d’outil de recherche web. Valeurs possibles : `in_progress`, , `searchingcompleted`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche web. A toujours la valeur `web_search_call`. Valeurs possibles : `web_search_call`	Oui

OpenAI.ConversationParam

Conversation à laquelle cette réponse appartient. Les éléments de cette conversation sont ajoutés à input_items cette demande de réponse. Les éléments d’entrée et les éléments de sortie de cette réponse sont automatiquement ajoutés à cette conversation une fois cette réponse terminée.

Type : chaîne ou OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Conversation à laquelle cette réponse appartient.

Nom	Type	Description	Obligatoire	Par défaut
id	string	ID unique de la conversation.	Oui

OpenAI.ConversationReference

Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.

Nom	Type	Description	Obligatoire	Par défaut
id	string	ID unique de la conversation à laquelle cette réponse a été associée.	Oui

OpenAI.ConversationResource

Nom	Type	Description	Obligatoire
date_de_création	entier	Heure à laquelle la conversation a été créée, mesurée en secondes depuis l’époque Unix.	Oui
id	string	ID unique de la conversation.	Oui
Métadonnées	OpenAI.Metadata	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.	Oui
Objet	enum	Type d’objet, qui est toujours `conversation`. Valeurs possibles : `conversation`	Oui

OpenAI.CreateChatCompletionRequestResponseFormat

Objet spécifiant le format que le modèle doit générer. Paramètre permettant d’activer { "type": "json_schema", "json_schema": {...} } les sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Configurer { "type": "json_object" } active l’ancien mode JSON afin de garantir 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.CreateChatCompletionRequestResponseFormat

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

Type de valeur	Schema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Oui

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

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.

Nom	Type	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`	Oui

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

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

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

OpenAI.CreateChatCompletionRequestResponseFormatType

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

OpenAI.CreateConversationBody

Nom	Type	Description	Obligatoire	Par défaut
items	tableau d’OpenAI.InputItem		Non
Métadonnées	OpenAI.Metadata (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.	Non

OpenAI.CreateEvalCompletionsRunDataSource

Objet CompletionsRunDataSource décrivant une configuration d’échantillonnage de modèle.

Nom	Type	Description	Obligatoire
messages_d'entrée	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Utilisé lors de l’échantillonnage à partir d’un modèle. Dicte la structure des messages passés dans le modèle. Peut être une référence à une trajectoire prédéfinie (par exemple, `item.input_trajectory`ou un modèle avec des références de variable à l’espace `item` de noms).	Non
model	string	Nom du modèle à utiliser pour générer des achèvements (par exemple, « o3-mini »).	Non
paramètres d'échantillonnage	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Non
Source	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalStoredCompletionsSource	Détermine ce qui remplit l’espace `item` de noms dans la source de données de cette exécution.	Oui
type	enum	Type de source de données d’exécution. A toujours la valeur `completions`. Valeurs possibles : `completions`	Oui

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Nom	Type	Description	Obligatoire	Par défaut
item_reference	string		Oui
type	enum	Valeurs possibles : `item_reference`	Oui

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Nom	Type	Description	Obligatoire	Par défaut
template	tableau d’OpenAI.EasyInputMessage ou OpenAI.EvalItem		Oui
type	enum	Valeurs possibles : `template`	Oui

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Nom	Type	Description	Obligatoire	Par défaut
max_completion_tokens	OpenAI.integer		Non
effort de raisonnement	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`.	Non
format_de_réponse	OpenAI.ResponseFormatText ou OpenAI.ResponseFormatJsonSchema ou OpenAI.ResponseFormatJsonObject		Non
seed	OpenAI.integer		Non	42
Température	OpenAI.numeric		Non	1
Outils	tableau d’OpenAI.ChatCompletionTool		Non
top_p	OpenAI.numeric		Non	1

OpenAI.CreateEvalCustomDataSourceConfig

Objet CustomDataSourceConfig qui définit le schéma de la source de données utilisée pour les exécutions d’évaluation. Ce schéma est utilisé pour définir la forme des données qui seront :

Utilisé pour définir vos critères de test et
Quelles données sont requises lors de la création d’une exécution

Nom	Type	Description	Obligatoire
inclure_exemple_schéma	booléen	Indique si l’évaluation doit s’attendre à ce que vous remplissiez l’espace de noms d’exemple (par exemple, en générant des réponses à partir de votre source de données)	Non
item_schema	Objet	Schéma json pour chaque ligne de la source de données.	Oui
type	enum	Le type de source de données. A toujours la valeur `custom`. Valeurs possibles : `custom`	Oui

OpenAI.CreateEvalJsonlRunDataSource

Un objet JsonlRunDataSource spécifiant un fichier JSONL qui correspond à l'évaluation

Nom	Type	Description	Obligatoire	Par défaut
Source	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	Détermine ce qui remplit l’espace `item` de noms dans la source de données.	Oui
type	enum	Le type de source de données. A toujours la valeur `jsonl`. Valeurs possibles : `jsonl`	Oui

OpenAI.CreateEvalLogsDataSourceConfig

Configuration de source de données qui spécifie la propriété de métadonnées de votre requête de journaux d’activité. Il s’agit généralement de métadonnées telles que usecase=chatbot ou prompt-version=v2, etc.

Nom	Type	Description	Obligatoire	Par défaut
Métadonnées	Objet	Filtres de métadonnées pour la source de données des journaux.	Non
type	enum	Le type de source de données. A toujours la valeur `logs`. Valeurs possibles : `logs`	Oui

OpenAI.CreateEvalResponsesRunDataSource

Objet ResponsesRunDataSource décrivant une configuration d’échantillonnage de modèle.

Nom	Type	Description	Obligatoire
messages_d'entrée	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate ou OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Utilisé lors de l’échantillonnage à partir d’un modèle. Dicte la structure des messages passés dans le modèle. Peut être une référence à une trajectoire prédéfinie (par exemple, `item.input_trajectory`ou un modèle avec des références de variable à l’espace `item` de noms).	Non
model	string	Nom du modèle à utiliser pour générer des achèvements (par exemple, « o3-mini »).	Non
paramètres d'échantillonnage	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Non
Source	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource ou OpenAI.EvalResponsesSource	Détermine ce qui remplit l’espace `item` de noms dans la source de données de cette exécution.	Oui
type	enum	Type de source de données d’exécution. A toujours la valeur `responses`. Valeurs possibles : `responses`	Oui

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Nom	Type	Description	Obligatoire	Par défaut
item_reference	string		Oui
type	enum	Valeurs possibles : `item_reference`	Oui

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Nom	Type	Description	Obligatoire	Par défaut
template	tableau d’objet ou OpenAI.EvalItem		Oui
type	enum	Valeurs possibles : `template`	Oui

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Nom	Type	Description	Obligatoire	Par défaut
max_completion_tokens	OpenAI.integer		Non
effort de raisonnement	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`.	Non
seed	OpenAI.integer		Non	42
Température	OpenAI.numeric		Non	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Non
Outils	tableau d’OpenAI.Tool		Non
top_p	OpenAI.numeric		Non	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Nom	Type	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 gpt-4o et les modèles plus récents :* 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.	Non

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Déconseillé en faveur de LogsDataSourceConfig.

Nom	Type	Description	Obligatoire	Par défaut
Métadonnées	Objet	Filtres de métadonnées pour la source de données de saisie semi-automatique stockée.	Non
type	enum	Le type de source de données. A toujours la valeur `stored_completions`. Valeurs possibles : `stored_completions`	Oui

OpenAI.CreateFineTuningJobRequest

Modèles valides :

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

Nom	Type	Description	Obligatoire	Par défaut
hyperparameters	OpenAI.CreateFineTuningJobRequestHyperparameters		Non
└ taille_du_lot	string ou OpenAI.integer		Non	auto
─ learning_rate_multiplier	string ou OpenAI.numeric		Non
└n_epochs	string ou OpenAI.integer		Non	auto
Intégrations	array d’OpenAI.CreateFineTuningJobRequestIntegrations	Liste des intégrations à activer pour votre travail de réglage précis.	Non
Métadonnées	OpenAI.Metadata (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.	Non
method	OpenAI.FineTuneMethod	Méthode utilisée pour le réglage précis.	Non
model	chaîne (voir les modèles valides ci-dessous)	Nom du modèle à ajuster. Vous pouvez sélectionner l’une des modèles pris en charge.	Oui
seed	OpenAI.integer (annulable)		Non
Suffixe	chaîne (nullable)	Chaîne de jusqu’à 64 caractères qui seront ajoutés au nom de votre modèle affiné. Par exemple, un `suffix` « custom-model-name » produit un nom de modèle comme `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Contraintes : minLength : 1, maxLength : 64	Non
fichier d'entraînement	string	ID d’un fichier chargé qui contient des données d’apprentissage. Consultez le fichier de chargement pour savoir comment charger un fichier. Votre jeu de données doit être mis en forme en tant que fichier JSONL. En outre, vous devez charger votre fichier à l’aide de l’objectif `fine-tune`. Le contenu du fichier doit différer selon que le modèle utilise la conversation, le format de saisie semi-automatique ou si la méthode de réglage précis utilise le format de préférence . Consultez le guide d'ajustement pour plus de détails.	Oui
fichier_de_validation	chaîne (nullable)	ID d’un fichier chargé qui contient des données de validation. Si vous fournissez ce fichier, les données sont utilisées pour générer la validation métriques régulièrement pendant le réglage précis. Ces métriques peuvent être consultées dans le fichier de résultats de réglage précis. Les mêmes données ne doivent pas être présentes dans les fichiers d’apprentissage et de validation. Votre jeu de données doit être mis en forme en tant que fichier JSONL. Vous devez charger votre fichier à l’aide de l’objectif `fine-tune`. Consultez le guide d'ajustement pour plus de détails.	Non

OpenAI.CreateFineTuningJobRequestHyperparameters

Nom	Type	Obligatoire
taille de lot	string ou OpenAI.integer	Non
multiplicateur de taux d'apprentissage	string ou OpenAI.numeric	Non
nombre_d'époques	string ou OpenAI.integer	Non

OpenAI.CreateFineTuningJobRequestIntegrations

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `wandb`	Oui
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Oui

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Nom	Type	Obligatoire
entité	chaîne (nullable)	Non
nom	chaîne (nullable)	Non
project	string	Oui
tags	tableau de chaînes	Non

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

Grammaire définie par l’utilisateur.

Nom	Type	Description	Obligatoire
Définition	string	Définition de grammaire.	Oui
Syntaxe	OpenAI.GrammarSyntax1		Oui
type	enum	Format de grammaire. A toujours la valeur `grammar`. Valeurs possibles : `grammar`	Oui

OpenAI.CustomTextFormatParam

Texte sans forme libre non contrainte.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Format de texte non contraint. A toujours la valeur `text`. Valeurs possibles : `text`	Oui

OpenAI.CustomToolParam

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

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

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 :

Type de valeur	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.CustomToolParamFormatType		Oui

OpenAI.CustomToolParamFormatType

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

OpenAI.DeletedConversationResource

Nom	Type	Description	Obligatoire
supprimé	booléen		Oui
id	string		Oui
Objet	enum	Valeurs possibles : `conversation.deleted`	Oui

OpenAI.DetailEnum

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

OpenAI.DoubleClickAction

L'action de double clic

Nom	Type	Description	Obligatoire
type	enum	Spécifie le type d’événement. Pour une action à double-clic, cette propriété est toujours définie sur `double_click`. Valeurs possibles : `double_click`	Oui
x	OpenAI.integer		Oui
y	OpenAI.integer		Oui

OpenAI.Drag

Action glisser.

Nom	Type	Description	Obligatoire	Par défaut
path	tableau d’OpenAI.DragPoint	Tableau de coordonnées représentant le parcours de l'action de glisser. Les coordonnées s’affichent sous forme de tableau d’objets, par exemple `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	Oui
type	enum	Spécifie le type d’événement. Pour une action glisser, cette propriété est toujours défini sur `drag`. Valeurs possibles : `drag`	Oui

OpenAI.DragPoint

Paire de coordonnées x/y, par exemple { x: 100, y: 200 }.

Nom	Type	Description	Obligatoire	Par défaut
x	OpenAI.integer		Oui
y	OpenAI.integer		Oui

OpenAI.EasyInputMessage

Un message d'entrée pour le modèle avec un rôle indiquant une hiérarchie de suivi des instructions. Les instructions fournies avec le rôle developer ou system priment sur les instructions fournies avec le rôle user. Les messages avec le assistant rôle sont présumés avoir été générés par le modèle dans les interactions précédentes.

Nom	Type	Description	Obligatoire
contenu	string ou OpenAI.InputMessageContentList	Texte, image ou entrée audio du modèle utilisé pour générer une réponse. Peut également contenir des réponses d’assistant précédentes.	Oui
role	enum	Rôle de la saisie de message. Un des `user`, , `assistant`, `system`ou `developer`. Valeurs possibles : `user`, , `assistantsystem`,`developer`	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de l’entrée de message. A toujours la valeur `message`. Valeurs possibles : `message`	Oui

OpenAI.Error

Nom	Type	Obligatoire
informations supplémentaires	Objet	Non
code	chaîne (nullable)	Oui
debugInfo	Objet	Non
details	tableau d’OpenAI.Error	Non
message	string	Oui
param	chaîne (nullable)	Non
type	string	Non

OpenAI.EvalApiError

Objet représentant une réponse d’erreur de l’API Eval.

Nom	Type	Description	Obligatoire	Par défaut
code	string	Code d’erreur.	Oui
message	string	Message d’erreur.	Oui

OpenAI.EvalGraderLabelModel

Nom	Type	Description	Obligatoire
input	tableau d’OpenAI.EvalItem		Oui
labels	tableau de chaînes	Étiquettes à affecter à chaque élément de l’évaluation.	Oui
model	string	Modèle à utiliser pour l’évaluation. Doit prendre en charge les sorties structurées.	Oui
nom	string	Nom du correcteur.	Oui
passing_labels	tableau de chaînes	Étiquettes qui indiquent un résultat de passage. Doit être un sous-ensemble d’étiquettes.	Oui
type	enum	Type d’objet, qui est toujours `label_model`. Valeurs possibles : `label_model`	Oui

OpenAI.EvalGraderPython

Nom	Type	Description	Obligatoire
image_tag	string	Balise d’image à utiliser pour le script Python.	Non
nom	string	Nom du correcteur.	Oui
seuil de passage	OpenAI.numeric		Non
Source	string	Code source du script Python.	Oui
type	enum	Type d’objet, qui est toujours `python`. Valeurs possibles : `python`	Oui

OpenAI.EvalGraderScoreModel

Nom	Type	Description	Obligatoire	Par défaut
input	tableau d’OpenAI.EvalItem	Les messages d’entrée évalués par le classateur. Prend en charge le texte, le texte de sortie, l’image d’entrée et les blocs de contenu audio d’entrée, et peut inclure des chaînes de modèle.	Oui
model	string	Modèle à utiliser pour l’évaluation.	Oui
nom	string	Nom du correcteur.	Oui
seuil de passage	OpenAI.numeric		Non
Gamme	tableau d’OpenAI.numeric	Échelle du score. La valeur par défaut est `[0, 1]`.	Non
paramètres d'échantillonnage	OpenAI.EvalGraderScoreModelSamplingParams		Non
└max_completions_tokens	OpenAI.integer (annulable)		Non
└effort_de_raisonnement	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`.	Non
Graine └─	OpenAI.integer (annulable)		Non
└─ Température	OpenAI.numeric (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
type	enum	Type d’objet, qui est toujours `score_model`. Valeurs possibles : `score_model`	Oui

OpenAI.EvalGraderScoreModelSamplingParams

Nom	Type	Description	Obligatoire	Par défaut
max_completions_tokens	OpenAI.integer (annulable)		Non
effort de raisonnement	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`.	Non
seed	OpenAI.integer (annulable)		Non
Température	OpenAI.numeric (annulable)		Non
top_p	OpenAI.numeric (annulable)		Non	1

OpenAI.EvalGraderStringCheck

Nom	Type	Description	Obligatoire
input	string	Le texte d’entrée. Cela peut inclure des chaînes de modèles.	Oui
nom	string	Nom du correcteur.	Oui
fonctionnement	enum	Opération de vérification de chaîne à effectuer. Un des `eq`, , `ne`, `like`ou `ilike`. Valeurs possibles : `eq`, , `nelike`,`ilike`	Oui
référence	string	Le texte de référence. Cela peut inclure des chaînes de modèles.	Oui
type	enum	Type d’objet, qui est toujours `string_check`. Valeurs possibles : `string_check`	Oui

OpenAI.EvalGraderTextSimilarity

Nom	Type	Description	Obligatoire
métrique d'évaluation	enum	Métrique d’évaluation à utiliser. Un des `cosine`, , `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valeurs possibles : `cosine`, , , `fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l`	Oui
input	string	Le texte en cours d'évaluation.	Oui
nom	string	Nom du correcteur.	Oui
seuil de passage	OpenAI.numeric		Oui
référence	string	Le texte servant de référence pour l'évaluation.	Oui
type	enum	Le type de niveleuse. Valeurs possibles : `text_similarity`	Oui

OpenAI.EvalItem

Nom	Type	Description	Obligatoire
contenu	OpenAI.EvalItemContent	Entrées dans le modèle : peut contenir des chaînes de modèle. Prend en charge le texte, le texte de sortie, les images d’entrée et l’audio d’entrée, sous la forme d’un élément unique ou d’un tableau d’éléments.	Oui
role	enum	Rôle de la saisie de message. Un des `user`, , `assistant`, `system`ou `developer`. Valeurs possibles : `user`, , `assistantsystem`,`developer`	Oui
type	enum	Type de l’entrée de message. A toujours la valeur `message`. Valeurs possibles : `message`	Non

OpenAI.EvalItemContent

Entrées dans le modèle : peut contenir des chaînes de modèle. Prend en charge le texte, le texte de sortie, les images d’entrée et l’audio d’entrée, sous la forme d’un élément unique ou d’un tableau d’éléments.

Type : OpenAI.EvalItemContentItem ou OpenAI.EvalItemContentArray

OpenAI.EvalItemContentArray

Liste des entrées, chacune pouvant être un texte d’entrée, un texte de sortie, une image d’entrée ou un objet audio d’entrée.

Tableau de : OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Élément de contenu unique : texte d’entrée, texte de sortie, image d’entrée ou audio d’entrée.

Type : OpenAI.EvalItemContentText ou OpenAI.EvalItemContentItemObject

Élément de contenu unique : texte d’entrée, texte de sortie, image d’entrée ou audio d’entrée.

OpenAI.EvalItemContentItemObject

Élément de contenu unique : texte d’entrée, texte de sortie, image d’entrée ou audio d’entrée.

Discriminateur pour OpenAI.EvalItemContentItemObject

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

Type de valeur	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContentContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.EvalItemContentItemObjectType		Oui

OpenAI.EvalItemContentItemObjectInputTextContentContent

Entrée de texte dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Entrée de texte dans le modèle.	Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_text`. Valeurs possibles : `input_text`	Oui

OpenAI.EvalItemContentItemObjectType

Propriété	Valeur
Type	string
Valeurs	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Le texte généré par le modèle.	Oui
type	enum	Type du texte de sortie. A toujours la valeur `output_text`. Valeurs possibles : `output_text`	Oui

OpenAI.EvalItemContentText

Entrée de texte dans le modèle.

Type : chaîne

OpenAI.EvalItemInputImage

Bloc d’entrée d’image utilisé dans les tableaux de contenu EvalItem.

Nom	Type	Description	Obligatoire
detail	string	Niveau de détail de l’image à envoyer au modèle. Un des `high`, `low`ou `auto`. La valeur par défaut est `auto`.	Non
image_url	string	URL de l’entrée d’image.	Oui
type	enum	Type de l’entrée d’image. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui

OpenAI.EvalJsonlFileContentSource

Nom	Type	Description	Obligatoire	Par défaut
contenu	tableau d’OpenAI.EvalJsonlFileContentSourceContentContent	Contenu du fichier jsonl.	Oui
type	enum	Type de source jsonl. A toujours la valeur `file_content`. Valeurs possibles : `file_content`	Oui

OpenAI.EvalJsonlFileContentSourceContentContent

Nom	Type	Description	Obligatoire	Par défaut
item	Objet		Oui
échantillon	Objet		Non

OpenAI.EvalJsonlFileIdSource

Nom	Type	Description	Obligatoire	Par défaut
id	string	L’identifiant du fichier.	Oui
type	enum	Type de source jsonl. A toujours la valeur `file_id`. Valeurs possibles : `file_id`	Oui

OpenAI.EvalResponsesSource

Objet EvalResponsesSource décrivant une configuration de source de données d’exécution.

Nom	Type	Description	Obligatoire
created_after	OpenAI.integer (annulable)		Non
créé_avant	OpenAI.integer (annulable)		Non
instructions_search	chaîne (nullable)		Non
Métadonnées	objet (nullable)		Non
model	chaîne (nullable)		Non
effort de raisonnement	OpenAI.ReasoningEffort (annulable)	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`.	Non
Température	OpenAI.numeric (annulable)		Non
Outils	tableau de chaînes		Non
top_p	OpenAI.numeric (annulable)		Non
type	enum	Type de source de données d’exécution. A toujours la valeur `responses`. Valeurs possibles : `responses`	Oui
users	tableau de chaînes		Non

OpenAI.EvalRunOutputItemSample

Nom	Type	Description	Obligatoire
erreur	OpenAI.EvalApiError	Objet représentant une réponse d’erreur de l’API Eval.	Oui
finish_reason	string		Oui
input	tableau d’EvalRunOutputItemSampleInput		Oui
max_completion_tokens	OpenAI.integer		Oui
model	string		Oui
sortie	tableau d’EvalRunOutputItemSampleOutput		Oui
seed	OpenAI.integer		Oui
Température	OpenAI.numeric		Oui
top_p	OpenAI.numeric		Oui
utilisation	OpenAI.EvalRunOutputItemSampleUsage		Oui

OpenAI.EvalRunOutputItemSampleUsage

Nom	Type	Obligatoire
cached_tokens	OpenAI.integer	Oui
completion_tokens	OpenAI.integer	Oui
prompt_tokens	OpenAI.integer	Oui
total_tokens	OpenAI.integer	Oui

OpenAI.EvalRunPerModelUsage

Nom	Type	Obligatoire
cached_tokens	OpenAI.integer	Oui
completion_tokens	OpenAI.integer	Oui
invocation_count	OpenAI.integer	Oui
model_name	string	Oui
prompt_tokens	OpenAI.integer	Oui
total_tokens	OpenAI.integer	Oui

OpenAI.EvalRunPerTestingCriteriaResults

Nom	Type	Obligatoire
a échoué	OpenAI.integer	Oui
Passé	OpenAI.integer	Oui
critères_de_test	string	Oui

OpenAI.EvalRunResultCounts

Nom	Type	Obligatoire
erreur	OpenAI.integer	Oui
a échoué	OpenAI.integer	Oui
Passé	OpenAI.integer	Oui
Total	OpenAI.integer	Oui

OpenAI.EvalStoredCompletionsSource

Configuration StoredCompletionsRunDataSource décrivant un ensemble de filtres

Nom	Type	Description	Obligatoire
created_after	OpenAI.integer (annulable)		Non
créé_avant	OpenAI.integer (annulable)		Non
limit	OpenAI.integer (annulable)		Non
Métadonnées	OpenAI.Metadata (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.	Non
model	chaîne (nullable)		Non
type	enum	Type de source. A toujours la valeur `stored_completions`. Valeurs possibles : `stored_completions`	Oui

OpenAI.FileCitationBody

Citation d'un fichier.

Nom	Type	Description	Obligatoire
identifiant_de_fichier	string	L’ID du dossier.	Oui
filename	string	Nom de fichier cité.	Oui
index	OpenAI.integer		Oui
type	enum	Type de la citation de fichier. A toujours la valeur `file_citation`. Valeurs possibles : `file_citation`	Oui

OpenAI.FilePath

Chemin d’accès à un fichier.

Nom	Type	Description	Obligatoire
identifiant_de_fichier	string	L’ID du dossier.	Oui
index	OpenAI.integer		Oui
type	enum	Type du chemin d’accès au fichier. A toujours la valeur `file_path`. Valeurs possibles : `file_path`	Oui

OpenAI.FileSearchTool

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

Nom	Type	Description	Obligatoire
Filtres	OpenAI.Filters (annulable)		Non
nombre_maximal_de_résultats	OpenAI.integer		Non
options_de_classement	OpenAI.RankingOptions		Non
└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.	Non
└─ classificateur	OpenAI.RankerVersionType	Outil de classement à utiliser pour la recherche de fichiers.	Non
└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.	Non
type	enum	Type de l’outil de recherche de fichiers. A toujours la valeur `file_search`. Valeurs possibles : `file_search`	Oui
vector_store_ids	tableau de chaînes	ID des magasins vectoriels à rechercher.	Oui

OpenAI.FileSearchToolCallResults

Nom	Type	Description	Obligatoire
attributes	OpenAI.VectorStoreFileAttributes (annulable)	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 avec une longueur maximale de 64 caractères. Les valeurs sont des chaînes avec un maximum longueur de 512 caractères sous forme de booléens ou de nombres.	Non
identifiant_de_fichier	string		Non
filename	string		Non
Résultat	Numéro		Non
text	string		Non

OpenAI.Filters

Type : OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

Hyperparamètres utilisés pour le travail d’optimisation de l’objet de stratégie de domaine.

Nom	Type	Description	Obligatoire
taille de lot	string ou OpenAI.integer	Nombre d’exemples dans chaque lot. Une taille de lot plus grande signifie que les paramètres de modèle sont mis à jour moins souvent, mais avec une variance plus faible.	Non
bêta	string ou OpenAI.numeric	Valeur bêta de la méthode DPO. Une valeur bêta plus élevée augmente le poids de la pénalité entre la stratégie et le modèle de référence.	Non
multiplicateur de taux d'apprentissage	string ou OpenAI.numeric	Facteur de mise à l’échelle pour le taux d’apprentissage. Un taux d’apprentissage plus petit peut être utile pour éviter le surajustement.	Non
nombre_d'époques	string ou OpenAI.integer	Nombre d'époques pendant lequel effectuer la formation du modèle. Une époque fait référence à un cycle complet dans le jeu de données d’apprentissage.	Non

OpenAI.FineTuneDPOMethod

Configuration de la méthode d’optimisation de l’objet de stratégie de domaine.

Nom	Type	Description	Obligatoire	Par défaut
hyperparameters	OpenAI.FineTuneDPOHyperparameters	Hyperparamètres utilisés pour le travail d’optimisation de l’objet de stratégie de domaine.	Non

OpenAI.FineTuneMethod

Méthode utilisée pour le réglage précis.

Nom	Type	Description	Obligatoire
dpo	OpenAI.FineTuneDPOMethod	Configuration de la méthode d’optimisation de l’objet de stratégie de domaine.	Non
Renforcement	OpenAI.FineTuneReinforcementMethod	Configuration de la méthode de réglage précis du renforcement.	Non
Supervisé	OpenAI.FineTuneSupervisedMethod	Configuration de la méthode de réglage affiné supervisée.	Non
type	enum	Type de méthode. Est soit `supervised`, `dpo`ou `reinforcement`. Valeurs possibles : `supervised`, , `dporeinforcement`	Oui

OpenAI.FineTuneReinforcementHyperparameters

Les hyperparamètres utilisés pour le travail de réglage précis du renforcement.

Nom	Type	Description	Obligatoire
taille de lot	string ou OpenAI.integer	Nombre d’exemples dans chaque lot. Une taille de lot plus grande signifie que les paramètres de modèle sont mis à jour moins souvent, mais avec une variance plus faible.	Non
compute_multiplier	string ou OpenAI.numeric	Multiplicateur sur la quantité de calcul utilisée pour explorer l’espace de recherche pendant l’entraînement.	Non
eval_interval	string ou OpenAI.integer	Nombre d’étapes d’entraînement entre les mesures d’évaluation.	Non
eval_samples	string ou OpenAI.integer	Nombre d’échantillons d’évaluation à générer par étape d’apprentissage.	Non
multiplicateur de taux d'apprentissage	string ou OpenAI.numeric	Facteur de mise à l’échelle pour le taux d’apprentissage. Un taux d’apprentissage plus petit peut être utile pour éviter le surajustement.	Non
nombre_d'époques	string ou OpenAI.integer	Nombre d'époques pendant lequel effectuer la formation du modèle. Une époque fait référence à un cycle complet dans le jeu de données d’apprentissage.	Non
effort de raisonnement	enum	Niveau d’effort de raisonnement. Valeurs possibles : `default`, , `lowmedium`,`high`	Non

OpenAI.FineTuneReinforcementMethod

Configuration de la méthode de réglage précis du renforcement.

Nom	Type	Description	Obligatoire	Par défaut
Niveleuse	OpenAI.GraderStringCheck ou OpenAI.GraderTextSimilarity ou OpenAI.GraderPython ou OpenAI.GraderScoreModel ou OpenAI.GraderMulti	Classe utilisée pour le travail de réglage précis.	Oui
hyperparameters	OpenAI.FineTuneReinforcementHyperparameters	Les hyperparamètres utilisés pour le travail de réglage précis du renforcement.	Non

OpenAI.FineTuneSupervisedHyperparameters

Hyperparamètres utilisés pour le travail de réglage précis.

Nom	Type	Description	Obligatoire
taille de lot	string ou OpenAI.integer	Nombre d’exemples dans chaque lot. Une taille de lot plus grande signifie que les paramètres de modèle sont mis à jour moins souvent, mais avec une variance plus faible.	Non
multiplicateur de taux d'apprentissage	string ou OpenAI.numeric	Facteur de mise à l’échelle pour le taux d’apprentissage. Un taux d’apprentissage plus petit peut être utile pour éviter le surajustement.	Non
nombre_d'époques	string ou OpenAI.integer	Nombre d'époques pendant lequel effectuer la formation du modèle. Une époque fait référence à un cycle complet dans le jeu de données d’apprentissage.	Non

OpenAI.FineTuneSupervisedMethod

Configuration de la méthode de réglage affiné supervisée.

Nom	Type	Description	Obligatoire	Par défaut
hyperparameters	OpenAI.FineTuneSupervisedHyperparameters	Hyperparamètres utilisés pour le travail de réglage précis.	Non

OpenAI.FineTuningIntegration

Nom	Type	Description	Obligatoire
type	enum	Type de l’intégration activée pour le travail de réglage précis Valeurs possibles : `wandb`	Oui
wandb	OpenAI.FineTuningIntegrationWandb		Oui
Entité └─	chaîne (nullable)		Non
└─ Nom	chaîne (nullable)		Non
└─ Projet	string		Oui
Balises └>	tableau de chaînes		Non

OpenAI.FineTuningIntegrationWandb

Nom	Type	Obligatoire
entité	chaîne (nullable)	Non
nom	chaîne (nullable)	Non
project	string	Oui
tags	tableau de chaînes	Non

OpenAI.FineTuningJob

L’objet fine_tuning.job représente un travail de réglage précis qui a été créé via l’API.

Nom	Type	Description	Obligatoire	Par défaut
date_de_création	entier	Horodatage Unix (en secondes) pour lequel le travail de réglage a été créé.	Oui
erreur	OpenAI.FineTuningJobError (annulable)		Oui
└─ Code	string		Oui
└─ Message	string		Oui
└> param	chaîne (nullable)		Oui
fin estimée	entier		Non
fine_tuned_model	chaîne (nullable)		Oui
finished_at	entier		Oui
hyperparameters	OpenAI.FineTuningJobHyperparameters		Oui
└ taille_du_lot	string ou OpenAI.integer		Non	auto
─ learning_rate_multiplier	string ou OpenAI.numeric		Non
└n_epochs	string ou OpenAI.integer		Non	auto
id	string	Identificateur d’objet, qui peut être référencé dans les points de terminaison d’API.	Oui
Intégrations	tableau d’OpenAI.FineTuningIntegration		Non
Métadonnées	OpenAI.Metadata (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.	Non
method	OpenAI.FineTuneMethod	Méthode utilisée pour le réglage précis.	Non
model	string	Modèle de base en cours d’optimisation.	Oui
Objet	enum	Type d’objet, qui est toujours « fine_tuning.job ». Valeurs possibles : `fine_tuning.job`	Oui
organization_id	string	Organisation propriétaire du travail d’optimisation.	Oui
fichiers_résultat	tableau de chaînes	ID(s) du ou des fichiers de résultats compilés pour le travail de réglage précis. Vous pouvez récupérer les résultats avec l’API Files.	Oui
seed	OpenAI.integer		Oui
status	enum	État actuel du travail de réglage précis, qui peut être `validating_files`soit , `queued`, `running`, , `succeeded`, , `failed`ou `cancelled`. Valeurs possibles : `validating_files`, , `queuedrunning`, `succeeded`, `failedcancelled`	Oui
trained_tokens	OpenAI.integer (annulable)		Oui
fichier d'entraînement	string	ID de fichier utilisé pour l’entraînement. Vous pouvez récupérer les données d’apprentissage avec l’API Files.	Oui
fichier_de_validation	chaîne (nullable)		Oui

OpenAI.FineTuningJobCheckpoint

L’objet fine_tuning.job.checkpoint représente un point de contrôle de modèle pour un travail de réglage précis prêt à être utilisé.

Nom	Type	Description	Obligatoire
date_de_création	entier	L’horodatage Unix (en secondes) indique la création du point de contrôle.	Oui
fine_tuned_model_checkpoint	string	Nom du modèle de point de contrôle affiné créé.	Oui
fine_tuning_job_id	string	Nom du travail de réglage précis à partir duquel ce point de contrôle a été créé.	Oui
id	string	Identificateur de point de contrôle, qui peut être référencé dans les points de terminaison d’API.	Oui
metrics	OpenAI.FineTuningJobCheckpointMetrics		Oui
└full_valid_loss	OpenAI.numeric		Non
└Précision_moyenne_du_token_valide_complet	OpenAI.numeric		Non
└─ Étape	OpenAI.numeric		Non
└─ perte_d'entraînement	OpenAI.numeric		Non
└─ précision_moyenne_des_tokens_entraînement	OpenAI.numeric		Non
└valid_loss	OpenAI.numeric		Non
Précision_moyenne_valide_par_jeton	OpenAI.numeric		Non
Objet	enum	Type d’objet, qui est toujours « fine_tuning.job.checkpoint ». Valeurs possibles : `fine_tuning.job.checkpoint`	Oui
numéro_étape	OpenAI.integer		Oui

OpenAI.FineTuningJobCheckpointMetrics

Nom	Type	Obligatoire
full_valid_loss	OpenAI.numeric	Non
full_valid_mean_token_accuracy	OpenAI.numeric	Non
étape	OpenAI.numeric	Non
train_loss	OpenAI.numeric	Non
train_mean_token_accuracy	OpenAI.numeric	Non
valid_loss	OpenAI.numeric	Non
valid_mean_token_accuracy	OpenAI.numeric	Non

OpenAI.FineTuningJobError

Nom	Type	Obligatoire
code	string	Oui
message	string	Oui
param	chaîne (nullable)	Oui

OpenAI.FineTuningJobEvent

Objet d’événement de travail de réglage précis

Nom	Type	Description	Obligatoire
date_de_création	entier	Horodatage Unix (en secondes) pour lequel le travail de réglage a été créé.	Oui
data	OpenAI.FineTuningJobEventData		Non
id	string	Identificateur d’objet.	Oui
level	enum	Niveau de journal de l’événement. Valeurs possibles : `info`, , `warnerror`	Oui
message	string	Message de l’événement.	Oui
Objet	enum	Type d’objet, qui est toujours « fine_tuning.job.event ». Valeurs possibles : `fine_tuning.job.event`	Oui
type	enum	le type d’événement ; Valeurs possibles : `message`, `metrics`	Non

OpenAI.FineTuningJobEventData

Type : objet

OpenAI.FineTuningJobHyperparameters

Nom	Type	Obligatoire
taille de lot	string ou OpenAI.integer	Non
multiplicateur de taux d'apprentissage	string ou OpenAI.numeric	Non
nombre_d'époques	string ou OpenAI.integer	Non

OpenAI.FunctionAndCustomToolCallOutput

Discriminateur pour OpenAI.FunctionAndCustomToolCallOutput

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

Type de valeur	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.FunctionAndCustomToolCallOutputType		Oui

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne (nullable)		Non
file_url	string	URL du fichier à envoyer au modèle.	Non
filename	string	Nom du fichier à envoyer au modèle.	Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_file`. Valeurs possibles : `input_file`	Oui

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Entrée d’image dans le modèle. Découvrez les entrées d’image.

Nom	Type	Description	Obligatoire
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne (nullable)		Non
image_url	string		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Entrée de texte dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Entrée de texte dans le modèle.	Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_text`. Valeurs possibles : `input_text`	Oui

OpenAI.FunctionAndCustomToolCallOutputType

Propriété	Valeur
Type	string
Valeurs	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

Nom	Type	Description	Obligatoire
description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
nom	string	Nom de la fonction à appeler. Doit être de A à Z, de A à Z, de 0 à 9, ou contenir des sous-traits et des titres, avec une longueur maximale de 64.	Oui
parameters	OpenAI.FunctionParameters	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, et la référence JSON Schema pour la documentation sur le format. Omettre `parameters` définit une fonction avec une liste de paramètres vide.	Non
strict	booléen (nullable)		Non

OpenAI.FunctionParameters

Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, et la référence JSON Schema pour la documentation sur le format. Omettre parameters définit une fonction avec une liste de paramètres vide.

Type : objet

OpenAI.FunctionShellAction

Exécutez une commande shell.

Nom	Type	Obligatoire
commands	tableau de chaînes	Oui
max_output_length	OpenAI.integer (annulable)	Oui
timeout (délai en ms)	OpenAI.integer (annulable)	Oui

OpenAI.FunctionShellActionParam

Commandes et limites décrivant comment exécuter l’appel de l’outil shell.

Nom	Type	Description	Obligatoire
commands	tableau de chaînes	Commandes shell ordonnées pour que l’environnement d’exécution s’exécute.	Oui
max_output_length	OpenAI.integer (annulable)		Non
timeout (délai en ms)	OpenAI.integer (annulable)		Non

OpenAI.FunctionShellCallItemStatus

Valeurs d’état signalées pour les appels d’outil shell.

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Contenu d’une sortie d’appel d’outil shell qui a été émise.

Nom	Type	Description	Obligatoire
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
résultat	OpenAI.FunctionShellCallOutputOutcome	Représente un résultat de sortie (avec un code de sortie) ou un résultat de délai d’expiration pour un bloc de sortie d’appel d’interpréteur de commandes.	Oui
└─ Type	OpenAI.FunctionShellCallOutputOutcomeType		Oui
Stderr	string	Sortie d’erreur standard capturée.	Oui
stdout	string	Sortie standard capturée.	Oui

OpenAI.FunctionShellCallOutputContentParam

Capture stdout et stderr pour une partie d’une sortie d’appel d’outil shell.

Nom	Type	Description	Obligatoire
résultat	OpenAI.FunctionShellCallOutputOutcomeParam	Résultat de sortie ou de délai d’expiration associé à cet appel d’interpréteur de commandes.	Oui
└─ Type	OpenAI.FunctionShellCallOutputOutcomeParamType		Oui
Stderr	string	Sortie stderr capturée pour l’appel d’interpréteur de commandes. Contraintes : maxLength : 10485760	Oui
stdout	string	Sortie stdout capturée pour l’appel d’interpréteur de commandes. Contraintes : maxLength : 10485760	Oui

OpenAI.FunctionShellCallOutputExitOutcome

Indique que les commandes de l’interpréteur de commandes ont terminé et retourné un code de sortie.

Nom	Type	Description	Obligatoire	Par défaut
exit_code	OpenAI.integer		Oui
type	enum	Type de résultat. A toujours la valeur `exit`. Valeurs possibles : `exit`	Oui

OpenAI.FunctionShellCallOutputExitOutcomeParam

Indique que les commandes de l’interpréteur de commandes ont terminé et retourné un code de sortie.

Nom	Type	Description	Obligatoire	Par défaut
exit_code	OpenAI.integer		Oui
type	enum	Type de résultat. A toujours la valeur `exit`. Valeurs possibles : `exit`	Oui

OpenAI.FunctionShellCallOutputOutcome

Représente un résultat de sortie (avec un code de sortie) ou un résultat de délai d’expiration pour un bloc de sortie d’appel d’interpréteur de commandes.

Discriminateur pour OpenAI.FunctionShellCallOutputOutcome

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

Type de valeur	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.FunctionShellCallOutputOutcomeType		Oui

OpenAI.FunctionShellCallOutputOutcomeParam

Résultat de sortie ou de délai d’expiration associé à cet appel d’interpréteur de commandes.

Discriminateur pour OpenAI.FunctionShellCallOutputOutcomeParam

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

Type de valeur	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Oui

OpenAI.FunctionShellCallOutputOutcomeParamType

Propriété	Valeur
Type	string
Valeurs	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Propriété	Valeur
Type	string
Valeurs	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Indique que l’appel d’interpréteur de commandes a dépassé sa limite de temps configurée.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type de résultat. A toujours la valeur `timeout`. Valeurs possibles : `timeout`	Oui

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Indique que l’appel d’interpréteur de commandes a dépassé sa limite de temps configurée.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type de résultat. A toujours la valeur `timeout`. Valeurs possibles : `timeout`	Oui

OpenAI.FunctionShellToolParam

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

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type de l’outil shell. A toujours la valeur `shell`. Valeurs possibles : `shell`	Oui

OpenAI.FunctionTool

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

Nom	Type	Description	Obligatoire
description	chaîne (nullable)		Non
nom	string	Nom de la fonction à appeler.	Oui
parameters	objet (nullable)		Oui
strict	booléen (nullable)		Oui
type	enum	Type de l’outil de fonction. A toujours la valeur `function`. Valeurs possibles : `function`	Oui

OpenAI.GraderLabelModel

Objet LabelModelGrader qui utilise un modèle pour affecter des étiquettes à chaque élément de l’évaluation.

Nom	Type	Description	Obligatoire
input	tableau d’OpenAI.EvalItem		Oui
labels	tableau de chaînes	Étiquettes à affecter à chaque élément de l’évaluation.	Oui
model	string	Modèle à utiliser pour l’évaluation. Doit prendre en charge les sorties structurées.	Oui
nom	string	Nom du correcteur.	Oui
passing_labels	tableau de chaînes	Étiquettes qui indiquent un résultat de passage. Doit être un sous-ensemble d’étiquettes.	Oui
type	enum	Type d’objet, qui est toujours `label_model`. Valeurs possibles : `label_model`	Oui

OpenAI.GraderMulti

Un objet MultiGrader combine la sortie de plusieurs classateurs pour produire un score unique.

Nom	Type	Description	Obligatoire
calculate_output	string	Formule permettant de calculer la sortie en fonction des résultats du classateur.	Oui
Niveleuses	OpenAI.GraderStringCheck ou OpenAI.GraderTextSimilarity ou OpenAI.GraderPython ou OpenAI.GraderScoreModel ou OpenAI.GraderLabelModel		Oui
nom	string	Nom du correcteur.	Oui
type	enum	Type d’objet, qui est toujours `multi`. Valeurs possibles : `multi`	Oui

OpenAI.GraderPython

Objet PythonGrader qui exécute un script Python sur l’entrée.

Nom	Type	Description	Obligatoire
image_tag	string	Balise d’image à utiliser pour le script Python.	Non
nom	string	Nom du correcteur.	Oui
Source	string	Code source du script Python.	Oui
type	enum	Type d’objet, qui est toujours `python`. Valeurs possibles : `python`	Oui

OpenAI.GraderScoreModel

Objet ScoreModelGrader qui utilise un modèle pour affecter un score à l’entrée.

Nom	Type	Description	Obligatoire	Par défaut
input	tableau d’OpenAI.EvalItem	Les messages d’entrée évalués par le classateur. Prend en charge le texte, le texte de sortie, l’image d’entrée et les blocs de contenu audio d’entrée, et peut inclure des chaînes de modèle.	Oui
model	string	Modèle à utiliser pour l’évaluation.	Oui
nom	string	Nom du correcteur.	Oui
Gamme	tableau d’OpenAI.numeric	Échelle du score. La valeur par défaut est `[0, 1]`.	Non
paramètres d'échantillonnage	OpenAI.EvalGraderScoreModelSamplingParams		Non
└max_completions_tokens	OpenAI.integer (annulable)		Non
└effort_de_raisonnement	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`.	Non
Graine └─	OpenAI.integer (annulable)		Non
└─ Température	OpenAI.numeric (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
type	enum	Type d’objet, qui est toujours `score_model`. Valeurs possibles : `score_model`	Oui

OpenAI.GraderStringCheck

Objet StringCheckGrader qui effectue une comparaison de chaînes entre l’entrée et la référence à l’aide d’une opération spécifiée.

Nom	Type	Description	Obligatoire
input	string	Le texte d’entrée. Cela peut inclure des chaînes de modèles.	Oui
nom	string	Nom du correcteur.	Oui
fonctionnement	enum	Opération de vérification de chaîne à effectuer. Un des `eq`, , `ne`, `like`ou `ilike`. Valeurs possibles : `eq`, , `nelike`,`ilike`	Oui
référence	string	Le texte de référence. Cela peut inclure des chaînes de modèles.	Oui
type	enum	Type d’objet, qui est toujours `string_check`. Valeurs possibles : `string_check`	Oui

OpenAI.GraderTextSimilarity

Objet TextSimilarityGrader qui classe le texte en fonction des métriques de similarité.

Nom	Type	Description	Obligatoire
métrique d'évaluation	enum	Métrique d’évaluation à utiliser. Un des `cosine`, , `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valeurs possibles : `cosine`, , , `fuzzy_matchbleugleumeteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l`	Oui
input	string	Le texte en cours d'évaluation.	Oui
nom	string	Nom du correcteur.	Oui
référence	string	Le texte servant de référence pour l'évaluation.	Oui
type	enum	Le type de niveleuse. Valeurs possibles : `text_similarity`	Oui

OpenAI.GrammarSyntax1

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

OpenAI.HybridSearchOptions

Nom	Type	Description	Obligatoire	Par défaut
embedding_weight	OpenAI.numeric		Oui
text_weight	OpenAI.numeric		Oui

OpenAI.ImageDetail

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

OpenAI.ImageGenTool

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

Nom	Type	Description	Obligatoire	Par défaut
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`	Non
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`. Non pris en charge pour `gpt-image-1-mini`. Prend en charge `high` et `low`. La valeur par défaut est `low`.	Non
masque_d'image_d'entrée	OpenAI.ImageGenToolInputImageMask		Non
└ file_id	string		Non
└ image_url	string		Non
model	chaîne (voir les modèles valides ci-dessous)		Non
Modération	enum	Niveau de modération de l’image générée. Valeur par défaut : `auto`. Valeurs possibles : `auto`, `low`	Non
compression_de_sortie	OpenAI.integer		Non	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`	Non
images partielles	OpenAI.integer		Non
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`	Non
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`	Non
type	enum	Type de l’outil de génération d’images. A toujours la valeur `image_generation`. Valeurs possibles : `image_generation`	Oui

OpenAI.ImageGenToolInputImageMask

Nom	Type	Description	Obligatoire	Par défaut
identifiant_de_fichier	string		Non
image_url	string		Non

OpenAI.IncludeEnum

Spécifiez des données de sortie supplémentaires à inclure dans la réponse du modèle. Les valeurs actuellement prises en charge sont les suivantes :

web_search_call.action.sources: incluez les sources de l’appel de l’outil de recherche web.
code_interpreter_call.outputs: inclut les sorties de l’exécution de code Python dans les éléments d’appel de l’outil d’interpréteur de code.
computer_call_output.output.image_url : incluez des URL d’image à partir de la sortie de l’appel d’ordinateur.
file_search_call.results : incluez les résultats de recherche de l’appel de l’outil de recherche de fichiers.
message.input_image.image_url: incluez des URL d’image à partir du message d’entrée.
message.output_text.logprobs: incluez des journaux d’activité avec des messages d’assistant.
reasoning.encrypted_content : inclut une version chiffrée des jetons de raisonnement dans les sorties d’éléments de raisonnement. Cela permet d'utiliser des éléments de raisonnement dans des conversations à plusieurs tours lors de l'utilisation de l'API Réponses de manière sans état (comme lorsque le paramètre store est défini sur false, ou lorsqu'une organisation est inscrite dans le programme de rétention de données zéro).

Propriété	Valeur
Description	Spécifiez des données de sortie supplémentaires à inclure dans la réponse du modèle. Les valeurs actuellement prises en charge sont les suivantes :

web_search_call.action.sources: incluez les sources de l’appel de l’outil de recherche web.
code_interpreter_call.outputs: inclut les sorties de l’exécution de code Python dans les éléments d’appel de l’outil d’interpréteur de code.
computer_call_output.output.image_url : incluez des URL d’image à partir de la sortie de l’appel d’ordinateur.
file_search_call.results : incluez les résultats de recherche de l’appel de l’outil de recherche de fichiers.
message.input_image.image_url: incluez des URL d’image à partir du message d’entrée.
message.output_text.logprobs: incluez des journaux d’activité avec des messages d’assistant.
reasoning.encrypted_content : inclut une version chiffrée des jetons de raisonnement dans les sorties d’éléments de raisonnement. Cela permet d'utiliser des éléments de raisonnement dans des conversations à plusieurs tours lors de l'utilisation de l'API Réponses de manière sans état (comme lorsque le paramètre store est défini sur false, ou lorsqu'une organisation est inscrite dans le programme de rétention de données zéro). | | Type | chaîne de caractères | | Valeurs | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

Entrée audio au modèle.

Nom	Type	Description	Obligatoire	Par défaut
input_audio	OpenAI.InputAudioInputAudio		Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_audio`. Valeurs possibles : `input_audio`	Oui

OpenAI.InputAudioInputAudio

Nom	Type	Description	Obligatoire	Par défaut
data	string		Oui
Format	enum	Valeurs possibles : `mp3`, `wav`	Oui

OpenAI.InputContent

Discriminateur pour OpenAI.InputContent

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

Type de valeur	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.InputContentType		Oui

OpenAI.InputContentInputFileContent

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne (nullable)		Non
file_url	string	URL du fichier à envoyer au modèle.	Non
filename	string	Nom du fichier à envoyer au modèle.	Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_file`. Valeurs possibles : `input_file`	Oui

OpenAI.InputContentInputImageContent

Entrée d’image dans le modèle. Découvrez les entrées d’image.

Nom	Type	Description	Obligatoire
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne (nullable)		Non
image_url	string		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui

OpenAI.InputContentInputTextContent

Entrée de texte dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Entrée de texte dans le modèle.	Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_text`. Valeurs possibles : `input_text`	Oui

OpenAI.InputContentType

Propriété	Valeur
Type	string
Valeurs	`input_text` `input_image` `input_file`

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. Non pris en charge pour gpt-image-1-mini. Prend en charge high et low. La valeur par défaut est low.

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

OpenAI.InputFileContent

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne (nullable)		Non
file_url	string	URL du fichier à envoyer au modèle.	Non
filename	string	Nom du fichier à envoyer au modèle.	Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_file`. Valeurs possibles : `input_file`	Oui

OpenAI.InputFileContentParam

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire
file_data	chaîne (nullable)		Non
identifiant_de_fichier	chaîne (nullable)		Non
file_url	string		Non
filename	chaîne (nullable)		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_file`. Valeurs possibles : `input_file`	Oui

OpenAI.InputImageContent

Entrée d’image dans le modèle. Découvrez les entrées d’image.

Nom	Type	Description	Obligatoire
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne (nullable)		Non
image_url	string		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui

OpenAI.InputImageContentParamAutoParam

Entrée d’image dans le modèle. En savoir plus sur les entrées d’image

Nom	Type	Description	Obligatoire
detail	OpenAI.DetailEnum (nullable)		Non
identifiant_de_fichier	chaîne (nullable)		Non
image_url	string		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui

OpenAI.InputItem

Élément représentant une partie du contexte de la réponse à générer par le modèle. Peut contenir du texte, des images et des entrées audio, ainsi que des réponses d’assistant précédentes et des sorties d’appel d’outil.

Discriminateur pour OpenAI.InputItem

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

Type de valeur	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.InputItemType		Oui

OpenAI.InputItemApplyPatchToolCallItemParam

Appel d’outil représentant une demande de création, de suppression ou de mise à jour de fichiers à l’aide de correctifs différents.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
fonctionnement	OpenAI.ApplyPatchOperationParam	Une des opérations create_file, delete_file ou update_file fournies à l’outil apply_patch.	Oui
└─ Type	OpenAI.ApplyPatchOperationParamType		Oui
status	OpenAI.ApplyPatchCallStatusParam	Valeurs d’état signalées pour les appels d’outils apply_patch.	Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call`. Valeurs possibles : `apply_patch_call`	Oui

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Sortie diffusée émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
sortie	chaîne (nullable)		Non
status	OpenAI.ApplyPatchCallOutputStatusParam	Valeurs de résultat signalées pour les sorties d’appel de l’outil apply_patch.	Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call_output`. Valeurs possibles : `apply_patch_call_output`	Oui

OpenAI.InputItemCodeInterpreterToolCall

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire
code	chaîne (nullable)		Oui
container_id	string	ID du conteneur utilisé pour exécuter le code.	Oui
id	string	ID unique de l’appel de l’outil interpréteur de code.	Oui
outputs	tableau d’OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Oui
status	enum	Le statut de l’appel de l’outil Interpréteur de code. Les valeurs acceptables sont : `in_progress`, `completed`, `incomplete`, `interpreting` et `failed`. Valeurs possibles : `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Oui
type	enum	Type de l’appel de l’outil interpréteur de code. A toujours la valeur `code_interpreter_call`. Valeurs possibles : `code_interpreter_call`	Oui

OpenAI.InputItemCompactionSummaryItemParam

Élément de compactage généré par l’APIv1/responses/compact.

Nom	Type	Description	Obligatoire
encrypted_content	string	Contenu chiffré du résumé du compactage. Contraintes : maxLength : 10485760	Oui
id	chaîne (nullable)		Non
type	enum	Type de l’élément. A toujours la valeur `compaction`. Valeurs possibles : `compaction`	Oui

OpenAI.InputItemComputerCallOutputItemParam

Sortie d’un appel d’outil informatique.

Nom	Type	Description	Obligatoire
acknowledged_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam		Non
call_id	string	L'identifiant de l’appel de l’outil informatique qui a produit la sortie. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
sortie	OpenAI.ComputerScreenshotImage	Image de capture d’écran d’ordinateur utilisée avec l’outil d’utilisation de l’ordinateur.	Oui
status	OpenAI.FunctionCallItemStatus (annulable)		Non
type	enum	Type de sortie de l’appel de l’outil informatique. A toujours la valeur `computer_call_output`. Valeurs possibles : `computer_call_output`	Oui

OpenAI.InputItemComputerToolCall

Un appel d’outil à un outil d’utilisation d’ordinateur. Pour plus d’informations, consultez le guide d’utilisation de l’ordinateur .

Nom	Type	Description	Obligatoire
action	OpenAI.ComputerAction		Oui
call_id	string	Identificateur utilisé lors de la réponse à l’appel de l’outil avec sortie.	Oui
id	string	ID unique de l’appel informatique.	Oui
pending_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité en attente pour l'appel informatique.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’ordinateur. A toujours la valeur `computer_call`. Valeurs possibles : `computer_call`	Oui

OpenAI.InputItemCustomToolCall

Appel à un outil personnalisé créé par le modèle.

Nom	Type	Description	Obligatoire
call_id	string	Identificateur utilisé pour mapper cet appel d’outil personnalisé à une sortie d’appel d’outil.	Oui
id	string	ID unique de l’appel d’outil personnalisé dans la plateforme OpenAI.	Non
input	string	Entrée de l’appel d’outil personnalisé généré par le modèle.	Oui
nom	string	Nom de l’outil personnalisé appelé.	Oui
type	enum	Type de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call`. Valeurs possibles : `custom_tool_call`	Oui

OpenAI.InputItemCustomToolCallOutput

Sortie d’un appel d’outil personnalisé à partir de votre code, renvoyé au modèle.

Nom	Type	Description	Obligatoire
call_id	string	ID d’appel, utilisé pour mapper cette sortie d’appel d’outil personnalisé à un appel d’outil personnalisé.	Oui
id	string	ID unique de la sortie d’appel d’outil personnalisé dans la plateforme OpenAI.	Non
sortie	chaîne ou tableau d’OpenAI.FunctionAndCustomToolCallOutput	Sortie de l’appel d’outil personnalisé généré par votre code. Il peut s’agir d’une chaîne ou d’une liste de contenu de sortie.	Oui
type	enum	Type de sortie de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call_output`. Valeurs possibles : `custom_tool_call_output`	Oui

OpenAI.InputItemFileSearchToolCall

Résultats d’un appel d’outil de recherche de fichiers. Pour plus d’informations, consultez le guide de recherche de fichiers .

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil de recherche de fichiers.	Oui
queries	tableau de chaînes	Requêtes utilisées pour rechercher des fichiers.	Oui
results	tableau d’OpenAI.FileSearchToolCallResults		Non
status	enum	État de l'accès à l’outil de recherche de fichiers. Valeurs possibles : `in_progress`, `searching`, `incomplete`, ou `failed` Valeurs possibles : `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche de fichiers. A toujours la valeur `file_search_call`. Valeurs possibles : `file_search_call`	Oui

OpenAI.InputItemFunctionCallOutputItemParam

Sortie d’un appel d’outil de fonction.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
sortie	chaîne ou tableau d’OpenAI.InputTextContentParam ou OpenAI.InputImageContentParamAutoParam ou OpenAI.InputFileContentParam	Texte, image ou sortie de fichier de l’appel de l’outil de fonction.	Oui
status	OpenAI.FunctionCallItemStatus (annulable)		Non
type	enum	Type d'appel de sortie de l'outil de fonctionnel. A toujours la valeur `function_call_output`. Valeurs possibles : `function_call_output`	Oui

OpenAI.InputItemFunctionShellCallItemParam

Outil représentant une demande d’exécution d’une ou plusieurs commandes shell.

Nom	Type	Description	Obligatoire
action	OpenAI.FunctionShellActionParam	Commandes et limites décrivant comment exécuter l’appel de l’outil shell.	Oui
Commandes └ ;	tableau de chaînes	Commandes shell ordonnées pour que l’environnement d’exécution s’exécute.	Oui
└max_output_length	OpenAI.integer (annulable)		Non
└timeout_ms	OpenAI.integer (annulable)		Non
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
status	OpenAI.FunctionShellCallItemStatus (nullable)	Valeurs d’état signalées pour les appels d’outil shell.	Non
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui

OpenAI.InputItemFunctionShellCallOutputItemParam

Éléments de sortie diffusés émis par un appel d’outil shell.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
max_output_length	OpenAI.integer (annulable)		Non
sortie	tableau d’OpenAI.FunctionShellCallOutputContentParam	Segments capturés de sortie stdout et stderr, ainsi que leurs résultats associés.	Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call_output`. Valeurs possibles : `shell_call_output`	Oui

OpenAI.InputItemFunctionToolCall

Un appel d’outil pour exécuter une fonction. Pour plus d’informations, consultez le guide d’appel de fonction .

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON des arguments à passer à la fonction.	Oui
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de l'outil fonctionnel.	Non
nom	string	Nom de la fonction à exécuter.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de l'outil fonctionnel. A toujours la valeur `function_call`. Valeurs possibles : `function_call`	Oui

OpenAI.InputItemImageGenToolCall

Demande de génération d’image effectuée par le modèle.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de génération d’image.	Oui
result	chaîne (nullable)		Oui
status	enum	État de l’appel de génération d’image. Valeurs possibles : `in_progress`, , `completedgenerating`,`failed`	Oui
type	enum	Type de l’appel de génération d’image. A toujours la valeur `image_generation_call`. Valeurs possibles : `image_generation_call`	Oui

OpenAI.InputItemLocalShellToolCall

Un appel d’outil pour exécuter une commande sur l’interpréteur de commandes local.

Nom	Type	Description	Obligatoire
action	OpenAI.LocalShellExecAction	Exécutez une commande shell sur le serveur.	Oui
call_id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
id	string	ID unique de l’appel d’interpréteur de commandes local.	Oui
status	enum	État de l’appel d’interpréteur de commandes local. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’interpréteur de commandes local. A toujours la valeur `local_shell_call`. Valeurs possibles : `local_shell_call`	Oui

OpenAI.InputItemLocalShellToolCallOutput

Sortie d’un appel d’outil shell local.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
sortie	string	Chaîne JSON de la sortie de l’appel de l’outil shell local.	Oui
status	enum	Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de sortie de l’appel de l’outil shell local. A toujours la valeur `local_shell_call_output`. Valeurs possibles : `local_shell_call_output`	Oui

OpenAI.InputItemMcpApprovalRequest

Demande d'approbation humaine pour l'invocation d'un outil.

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON d’arguments pour l’outil.	Oui
id	string	ID unique de la demande d’approbation.	Oui
nom	string	Nom de l’outil à exécuter.	Oui
server_label	string	Étiquette du serveur MCP effectuant la requête.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_request`. Valeurs possibles : `mcp_approval_request`	Oui

OpenAI.InputItemMcpApprovalResponse

Une réponse à une requête d’approbation de MCP.

Nom	Type	Description	Obligatoire
approval_request_id	string	L’ID de la requête d’approbation à laquelle on répond.	Oui
Approuver	booléen	Indique si la demande a été approuvée.	Oui
id	chaîne (nullable)		Non
raison	chaîne (nullable)		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.InputItemMcpListTools

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	chaîne (nullable)		Non
id	string	ID unique de la liste.	Oui
server_label	string	Étiquette du serveur MCP.	Oui
Outils	tableau d’OpenAI.MCPListToolsTools	Outils disponibles sur le serveur.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_list_tools`. Valeurs possibles : `mcp_list_tools`	Oui

OpenAI.InputItemMcpToolCall

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne (nullable)		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	chaîne (nullable)		Non
id	string	ID unique de l’appel d’outil.	Oui
nom	string	Le nom de l’outil qui a été exécuté.	Oui
sortie	chaîne (nullable)		Non
server_label	string	Étiquette du serveur MCP exécutant l’outil.	Oui
status	OpenAI.MCPToolCallStatus		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_call`. Valeurs possibles : `mcp_call`	Oui

OpenAI.InputItemOutputMessage

Message de sortie du modèle.

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.OutputMessageContent	Contenu du message de sortie.	Oui
id	string	ID unique du message de sortie.	Oui
role	enum	Rôle du message de sortie. A toujours la valeur `assistant`. Valeurs possibles : `assistant`	Oui
status	enum	État de l’entrée de message. Un des `in_progress`, ou `completed` `incomplete`. Rempli lorsque les éléments d’entrée sont retournés via l’API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type du message de sortie. A toujours la valeur `message`. Valeurs possibles : `output_message`	Oui

OpenAI.InputItemReasoningItem

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.ReasoningTextContent	Contenu du texte de raisonnement.	Non
encrypted_content	chaîne (nullable)		Non
id	string	Identificateur unique du contenu du raisonnement.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
summary	tableau d’OpenAI.Summary	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.InputItemType

Propriété Valeur

Type string

Valeurs message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference

OpenAI.InputItemWebSearchToolCall

Résultats d’un appel d’outil de recherche web. Pour plus d’informations, consultez le guide de recherche web .

Nom	Type	Description	Obligatoire
action	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Objet décrivant l’action spécifique effectuée dans cet appel de recherche web. Inclut des détails sur la façon dont le modèle a utilisé le web (recherche, open_page, recherche).	Oui
id	string	ID unique de l’appel de l’outil de recherche web.	Oui
status	enum	L’état de l’appel d’outil de recherche web. Valeurs possibles : `in_progress`, , `searchingcompleted`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche web. A toujours la valeur `web_search_call`. Valeurs possibles : `web_search_call`	Oui

OpenAI.InputMessage

Nom	Type	Description	Obligatoire
contenu	OpenAI.InputMessageContentList	Liste d’un ou de plusieurs éléments d’entrée dans le modèle, contenant un contenu différent types.	Oui
role	enum	Rôle de la saisie de message. Un des `user`, `system`ou `developer`. Valeurs possibles : `user`, , `systemdeveloper`	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de l’entrée de message. Toujours défini sur `message`. Valeurs possibles : `message`	Oui

OpenAI.InputMessageContentList

Liste d’un ou de plusieurs éléments d’entrée dans le modèle, contenant différents types de contenu.

Tableau de : OpenAI.InputContent

OpenAI.InputMessageResource

Nom	Type	Description	Obligatoire
contenu	OpenAI.InputMessageContentList	Liste d’un ou de plusieurs éléments d’entrée dans le modèle, contenant un contenu différent types.	Oui
id	string	L’ID unique de l’entrée du message.	Oui
role	enum	Rôle de la saisie de message. Un des `user`, `system`ou `developer`. Valeurs possibles : `user`, , `systemdeveloper`	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de l’entrée de message. Toujours défini sur `message`. Valeurs possibles : `message`	Oui

OpenAI.InputParam

Entrées de texte, d’image ou de fichier dans le modèle, utilisées pour générer une réponse. Pour en savoir plus:

Type : chaîne ou tableau d’OpenAI.InputItem

Entrées de texte, d’image ou de fichier dans le modèle, utilisées pour générer une réponse. Pour en savoir plus:

OpenAI.InputTextContent

Entrée de texte dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Entrée de texte dans le modèle.	Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_text`. Valeurs possibles : `input_text`	Oui

OpenAI.InputTextContentParam

Entrée de texte dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Entrée de texte dans le modèle. Contraintes : maxLength : 10485760	Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_text`. Valeurs possibles : `input_text`	Oui

OpenAI.Item

Élément de contenu utilisé pour générer une réponse.

Discriminateur pour OpenAI.Item

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

Type de valeur	Schema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ItemType		Oui

OpenAI.ItemApplyPatchToolCallItemParam

Appel d’outil représentant une demande de création, de suppression ou de mise à jour de fichiers à l’aide de correctifs différents.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
fonctionnement	OpenAI.ApplyPatchOperationParam	Une des opérations create_file, delete_file ou update_file fournies à l’outil apply_patch.	Oui
└─ Type	OpenAI.ApplyPatchOperationParamType		Oui
status	OpenAI.ApplyPatchCallStatusParam	Valeurs d’état signalées pour les appels d’outils apply_patch.	Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call`. Valeurs possibles : `apply_patch_call`	Oui

OpenAI.ItemApplyPatchToolCallOutputItemParam

Sortie diffusée émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
sortie	chaîne (nullable)		Non
status	OpenAI.ApplyPatchCallOutputStatusParam	Valeurs de résultat signalées pour les sorties d’appel de l’outil apply_patch.	Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call_output`. Valeurs possibles : `apply_patch_call_output`	Oui

OpenAI.ItemCodeInterpreterToolCall

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire
code	chaîne (nullable)		Oui
container_id	string	ID du conteneur utilisé pour exécuter le code.	Oui
id	string	ID unique de l’appel de l’outil interpréteur de code.	Oui
outputs	tableau d’OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Oui
status	enum	Le statut de l’appel de l’outil Interpréteur de code. Les valeurs acceptables sont : `in_progress`, `completed`, `incomplete`, `interpreting` et `failed`. Valeurs possibles : `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Oui
type	enum	Type de l’appel de l’outil interpréteur de code. A toujours la valeur `code_interpreter_call`. Valeurs possibles : `code_interpreter_call`	Oui

OpenAI.ItemCompactionSummaryItemParam

Élément de compactage généré par l’APIv1/responses/compact.

Nom	Type	Description	Obligatoire
encrypted_content	string	Contenu chiffré du résumé du compactage. Contraintes : maxLength : 10485760	Oui
id	chaîne (nullable)		Non
type	enum	Type de l’élément. A toujours la valeur `compaction`. Valeurs possibles : `compaction`	Oui

OpenAI.ItemComputerCallOutputItemParam

Sortie d’un appel d’outil informatique.

Nom	Type	Description	Obligatoire
acknowledged_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam		Non
call_id	string	L'identifiant de l’appel de l’outil informatique qui a produit la sortie. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
sortie	OpenAI.ComputerScreenshotImage	Image de capture d’écran d’ordinateur utilisée avec l’outil d’utilisation de l’ordinateur.	Oui
status	OpenAI.FunctionCallItemStatus (annulable)		Non
type	enum	Type de sortie de l’appel de l’outil informatique. A toujours la valeur `computer_call_output`. Valeurs possibles : `computer_call_output`	Oui

OpenAI.ItemComputerToolCall

Un appel d’outil à un outil d’utilisation d’ordinateur. Pour plus d’informations, consultez le guide d’utilisation de l’ordinateur .

Nom	Type	Description	Obligatoire
action	OpenAI.ComputerAction		Oui
call_id	string	Identificateur utilisé lors de la réponse à l’appel de l’outil avec sortie.	Oui
id	string	ID unique de l’appel informatique.	Oui
pending_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité en attente pour l'appel informatique.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’ordinateur. A toujours la valeur `computer_call`. Valeurs possibles : `computer_call`	Oui

OpenAI.ItemCustomToolCall

Appel à un outil personnalisé créé par le modèle.

Nom	Type	Description	Obligatoire
call_id	string	Identificateur utilisé pour mapper cet appel d’outil personnalisé à une sortie d’appel d’outil.	Oui
id	string	ID unique de l’appel d’outil personnalisé dans la plateforme OpenAI.	Non
input	string	Entrée de l’appel d’outil personnalisé généré par le modèle.	Oui
nom	string	Nom de l’outil personnalisé appelé.	Oui
type	enum	Type de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call`. Valeurs possibles : `custom_tool_call`	Oui

OpenAI.ItemCustomToolCallOutput

Sortie d’un appel d’outil personnalisé à partir de votre code, renvoyé au modèle.

Nom	Type	Description	Obligatoire
call_id	string	ID d’appel, utilisé pour mapper cette sortie d’appel d’outil personnalisé à un appel d’outil personnalisé.	Oui
id	string	ID unique de la sortie d’appel d’outil personnalisé dans la plateforme OpenAI.	Non
sortie	chaîne ou tableau d’OpenAI.FunctionAndCustomToolCallOutput	Sortie de l’appel d’outil personnalisé généré par votre code. Il peut s’agir d’une chaîne ou d’une liste de contenu de sortie.	Oui
type	enum	Type de sortie de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call_output`. Valeurs possibles : `custom_tool_call_output`	Oui

OpenAI.ItemFileSearchToolCall

Résultats d’un appel d’outil de recherche de fichiers. Pour plus d’informations, consultez le guide de recherche de fichiers .

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil de recherche de fichiers.	Oui
queries	tableau de chaînes	Requêtes utilisées pour rechercher des fichiers.	Oui
results	tableau d’OpenAI.FileSearchToolCallResults		Non
status	enum	État de l'accès à l’outil de recherche de fichiers. Valeurs possibles : `in_progress`, `searching`, `incomplete`, ou `failed` Valeurs possibles : `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche de fichiers. A toujours la valeur `file_search_call`. Valeurs possibles : `file_search_call`	Oui

OpenAI.ItemFunctionCallOutputItemParam

Sortie d’un appel d’outil de fonction.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
sortie	chaîne ou tableau d’OpenAI.InputTextContentParam ou OpenAI.InputImageContentParamAutoParam ou OpenAI.InputFileContentParam	Texte, image ou sortie de fichier de l’appel de l’outil de fonction.	Oui
status	OpenAI.FunctionCallItemStatus (annulable)		Non
type	enum	Type d'appel de sortie de l'outil de fonctionnel. A toujours la valeur `function_call_output`. Valeurs possibles : `function_call_output`	Oui

OpenAI.ItemFunctionShellCallItemParam

Outil représentant une demande d’exécution d’une ou plusieurs commandes shell.

Nom	Type	Description	Obligatoire
action	OpenAI.FunctionShellActionParam	Commandes et limites décrivant comment exécuter l’appel de l’outil shell.	Oui
Commandes └ ;	tableau de chaînes	Commandes shell ordonnées pour que l’environnement d’exécution s’exécute.	Oui
└max_output_length	OpenAI.integer (annulable)		Non
└timeout_ms	OpenAI.integer (annulable)		Non
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
status	OpenAI.FunctionShellCallItemStatus (nullable)	Valeurs d’état signalées pour les appels d’outil shell.	Non
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui

OpenAI.ItemFunctionShellCallOutputItemParam

Éléments de sortie diffusés émis par un appel d’outil shell.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle. Contraintes : minLength : 1, maxLength : 64	Oui
id	chaîne (nullable)		Non
max_output_length	OpenAI.integer (annulable)		Non
sortie	tableau d’OpenAI.FunctionShellCallOutputContentParam	Segments capturés de sortie stdout et stderr, ainsi que leurs résultats associés.	Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call_output`. Valeurs possibles : `shell_call_output`	Oui

OpenAI.ItemFunctionToolCall

Un appel d’outil pour exécuter une fonction. Pour plus d’informations, consultez le guide d’appel de fonction .

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON des arguments à passer à la fonction.	Oui
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de l'outil fonctionnel.	Non
nom	string	Nom de la fonction à exécuter.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de l'outil fonctionnel. A toujours la valeur `function_call`. Valeurs possibles : `function_call`	Oui

OpenAI.ItemImageGenToolCall

Demande de génération d’image effectuée par le modèle.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de génération d’image.	Oui
result	chaîne (nullable)		Oui
status	enum	État de l’appel de génération d’image. Valeurs possibles : `in_progress`, , `completedgenerating`,`failed`	Oui
type	enum	Type de l’appel de génération d’image. A toujours la valeur `image_generation_call`. Valeurs possibles : `image_generation_call`	Oui

OpenAI.ItemLocalShellToolCall

Un appel d’outil pour exécuter une commande sur l’interpréteur de commandes local.

Nom	Type	Description	Obligatoire
action	OpenAI.LocalShellExecAction	Exécutez une commande shell sur le serveur.	Oui
call_id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
id	string	ID unique de l’appel d’interpréteur de commandes local.	Oui
status	enum	État de l’appel d’interpréteur de commandes local. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’interpréteur de commandes local. A toujours la valeur `local_shell_call`. Valeurs possibles : `local_shell_call`	Oui

OpenAI.ItemLocalShellToolCallOutput

Sortie d’un appel d’outil shell local.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
sortie	string	Chaîne JSON de la sortie de l’appel de l’outil shell local.	Oui
status	enum	Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de sortie de l’appel de l’outil shell local. A toujours la valeur `local_shell_call_output`. Valeurs possibles : `local_shell_call_output`	Oui

OpenAI.ItemMcpApprovalRequest

Demande d'approbation humaine pour l'invocation d'un outil.

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON d’arguments pour l’outil.	Oui
id	string	ID unique de la demande d’approbation.	Oui
nom	string	Nom de l’outil à exécuter.	Oui
server_label	string	Étiquette du serveur MCP effectuant la requête.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_request`. Valeurs possibles : `mcp_approval_request`	Oui

OpenAI.ItemMcpApprovalResponse

Une réponse à une requête d’approbation de MCP.

Nom	Type	Description	Obligatoire
approval_request_id	string	L’ID de la requête d’approbation à laquelle on répond.	Oui
Approuver	booléen	Indique si la demande a été approuvée.	Oui
id	chaîne (nullable)		Non
raison	chaîne (nullable)		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.ItemMcpListTools

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	chaîne (nullable)		Non
id	string	ID unique de la liste.	Oui
server_label	string	Étiquette du serveur MCP.	Oui
Outils	tableau d’OpenAI.MCPListToolsTools	Outils disponibles sur le serveur.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_list_tools`. Valeurs possibles : `mcp_list_tools`	Oui

OpenAI.ItemMcpToolCall

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne (nullable)		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	chaîne (nullable)		Non
id	string	ID unique de l’appel d’outil.	Oui
nom	string	Le nom de l’outil qui a été exécuté.	Oui
sortie	chaîne (nullable)		Non
server_label	string	Étiquette du serveur MCP exécutant l’outil.	Oui
status	OpenAI.MCPToolCallStatus		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_call`. Valeurs possibles : `mcp_call`	Oui

OpenAI.ItemOutputMessage

Message de sortie du modèle.

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.OutputMessageContent	Contenu du message de sortie.	Oui
id	string	ID unique du message de sortie.	Oui
role	enum	Rôle du message de sortie. A toujours la valeur `assistant`. Valeurs possibles : `assistant`	Oui
status	enum	État de l’entrée de message. Un des `in_progress`, ou `completed` `incomplete`. Rempli lorsque les éléments d’entrée sont retournés via l’API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type du message de sortie. A toujours la valeur `message`. Valeurs possibles : `output_message`	Oui

OpenAI.ItemReasoningItem

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.ReasoningTextContent	Contenu du texte de raisonnement.	Non
encrypted_content	chaîne (nullable)		Non
id	string	Identificateur unique du contenu du raisonnement.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
summary	tableau d’OpenAI.Summary	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.ItemReferenceParam

Identificateur interne d’un élément à référencer.

Nom	Type	Description	Obligatoire	Par défaut
id	string	ID de l’élément à référencer.	Oui
type	enum	Type d’élément à référencer. A toujours la valeur `item_reference`. Valeurs possibles : `item_reference`	Oui

OpenAI.ItemResource

Élément de contenu utilisé pour générer une réponse.

Discriminant pour OpenAI.ItemResource

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

Type de valeur	Schema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ItemResourceType		Oui

OpenAI.ItemResourceApplyPatchToolCall

Appel d’outil qui applique des différences de fichier en créant, supprimant ou mettant à jour des fichiers.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cet appel d’outil.	Non
id	string	ID unique de l’appel de l’outil apply patch. Renseigné lorsque cet élément est retourné via l’API.	Oui
fonctionnement	OpenAI.ApplyPatchFileOperation	Une des opérations create_file, delete_file ou update_file appliquées via apply_patch.	Oui
└─ Type	OpenAI.ApplyPatchFileOperationType		Oui
status	OpenAI.ApplyPatchCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call`. Valeurs possibles : `apply_patch_call`	Oui

OpenAI.ItemResourceApplyPatchToolCallOutput

Sortie émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cette sortie d’appel d’outil.	Non
id	string	ID unique de la sortie d’appel de l’outil appliquer le correctif. Renseigné lorsque cet élément est retourné via l’API.	Oui
sortie	chaîne (nullable)		Non
status	OpenAI.ApplyPatchCallOutputStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call_output`. Valeurs possibles : `apply_patch_call_output`	Oui

OpenAI.ItemResourceCodeInterpreterToolCall

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire
code	chaîne (nullable)		Oui
container_id	string	ID du conteneur utilisé pour exécuter le code.	Oui
id	string	ID unique de l’appel de l’outil interpréteur de code.	Oui
outputs	tableau d’OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Oui
status	enum	Le statut de l’appel de l’outil Interpréteur de code. Les valeurs acceptables sont : `in_progress`, `completed`, `incomplete`, `interpreting` et `failed`. Valeurs possibles : `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Oui
type	enum	Type de l’appel de l’outil interpréteur de code. A toujours la valeur `code_interpreter_call`. Valeurs possibles : `code_interpreter_call`	Oui

OpenAI.ItemResourceComputerToolCall

Un appel d’outil à un outil d’utilisation d’ordinateur. Pour plus d’informations, consultez le guide d’utilisation de l’ordinateur .

Nom	Type	Description	Obligatoire
action	OpenAI.ComputerAction		Oui
call_id	string	Identificateur utilisé lors de la réponse à l’appel de l’outil avec sortie.	Oui
id	string	ID unique de l’appel informatique.	Oui
pending_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité en attente pour l'appel informatique.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’ordinateur. A toujours la valeur `computer_call`. Valeurs possibles : `computer_call`	Oui

OpenAI.ItemResourceComputerToolCallOutputResource

Nom	Type	Description	Obligatoire
acknowledged_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité signalées par l’API qui ont été reconnues par le développeur	Non
call_id	string	L'identifiant de l’appel de l’outil informatique qui a produit la sortie.	Oui
id	string	Identifiant de la sortie de l'outil informatique utilisé.	Non
sortie	OpenAI.ComputerScreenshotImage	Image de capture d’écran d’ordinateur utilisée avec l’outil d’utilisation de l’ordinateur.	Oui
status	enum	État de l’entrée de message. Un des `in_progress`, ou `completed` `incomplete`. Rempli lorsque les éléments d’entrée sont retournés via l’API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de sortie de l’appel de l’outil informatique. A toujours la valeur `computer_call_output`. Valeurs possibles : `computer_call_output`	Oui

OpenAI.ItemResourceFileSearchToolCall

Résultats d’un appel d’outil de recherche de fichiers. Pour plus d’informations, consultez le guide de recherche de fichiers .

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil de recherche de fichiers.	Oui
queries	tableau de chaînes	Requêtes utilisées pour rechercher des fichiers.	Oui
results	tableau d’OpenAI.FileSearchToolCallResults		Non
status	enum	État de l'accès à l’outil de recherche de fichiers. Valeurs possibles : `in_progress`, `searching`, `incomplete`, ou `failed` Valeurs possibles : `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche de fichiers. A toujours la valeur `file_search_call`. Valeurs possibles : `file_search_call`	Oui

OpenAI.ItemResourceFunctionShellCall

Appel d’outil qui exécute une ou plusieurs commandes shell dans un environnement managé.

Nom	Type	Description	Obligatoire
action	OpenAI.FunctionShellAction	Exécutez une commande shell.	Oui
Commandes └ ;	tableau de chaînes		Oui
└max_output_length	OpenAI.integer (annulable)		Oui
└timeout_ms	OpenAI.integer (annulable)		Oui
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cet appel d’outil.	Non
id	string	ID unique de l’appel de l’outil shell. Renseigné lorsque cet élément est retourné via l’API.	Oui
status	OpenAI.LocalShellCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui

OpenAI.ItemResourceFunctionShellCallOutput

Sortie d’un appel d’outil shell émis.

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle.	Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
id	string	ID unique de la sortie de l’appel d’interpréteur de commandes. Renseigné lorsque cet élément est retourné via l’API.	Oui
max_output_length	OpenAI.integer (annulable)		Oui
sortie	tableau d’OpenAI.FunctionShellCallOutputContent	Tableau de contenu de sortie d’appel d’interpréteur de commandes	Oui
type	enum	Type de sortie de l’appel d’interpréteur de commandes. A toujours la valeur `shell_call_output`. Valeurs possibles : `shell_call_output`	Oui

OpenAI.ItemResourceFunctionToolCallOutputResource

Nom	Type	Description	Obligatoire
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de sortie de l'outil fonctionnel. Renseigné lorsque cet élément est renseigné est retourné via l’API.	Non
sortie	chaîne ou tableau d’OpenAI.FunctionAndCustomToolCallOutput	Sortie de l’appel de fonction généré par votre code. Il peut s’agir d’une chaîne ou d’une liste de contenu de sortie.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de sortie de l'outil de fonctionnel. A toujours la valeur `function_call_output`. Valeurs possibles : `function_call_output`	Oui

OpenAI.ItemResourceFunctionToolCallResource

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON des arguments à passer à la fonction.	Oui
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de l'outil fonctionnel.	Non
nom	string	Nom de la fonction à exécuter.	Oui
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de l'outil fonctionnel. A toujours la valeur `function_call`. Valeurs possibles : `function_call`	Oui

OpenAI.ItemResourceImageGenToolCall

Demande de génération d’image effectuée par le modèle.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de génération d’image.	Oui
result	chaîne (nullable)		Oui
status	enum	État de l’appel de génération d’image. Valeurs possibles : `in_progress`, , `completedgenerating`,`failed`	Oui
type	enum	Type de l’appel de génération d’image. A toujours la valeur `image_generation_call`. Valeurs possibles : `image_generation_call`	Oui

OpenAI.ItemResourceLocalShellToolCall

Un appel d’outil pour exécuter une commande sur l’interpréteur de commandes local.

Nom	Type	Description	Obligatoire
action	OpenAI.LocalShellExecAction	Exécutez une commande shell sur le serveur.	Oui
call_id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
id	string	ID unique de l’appel d’interpréteur de commandes local.	Oui
status	enum	État de l’appel d’interpréteur de commandes local. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’interpréteur de commandes local. A toujours la valeur `local_shell_call`. Valeurs possibles : `local_shell_call`	Oui

OpenAI.ItemResourceLocalShellToolCallOutput

Sortie d’un appel d’outil shell local.

Nom	Type	Description	Obligatoire
id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
sortie	string	Chaîne JSON de la sortie de l’appel de l’outil shell local.	Oui
status	enum	Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type de sortie de l’appel de l’outil shell local. A toujours la valeur `local_shell_call_output`. Valeurs possibles : `local_shell_call_output`	Oui

OpenAI.ItemResourceMcpApprovalRequest

Demande d'approbation humaine pour l'invocation d'un outil.

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON d’arguments pour l’outil.	Oui
id	string	ID unique de la demande d’approbation.	Oui
nom	string	Nom de l’outil à exécuter.	Oui
server_label	string	Étiquette du serveur MCP effectuant la requête.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_request`. Valeurs possibles : `mcp_approval_request`	Oui

OpenAI.ItemResourceMcpApprovalResponseResource

Une réponse à une requête d’approbation de MCP.

Nom	Type	Description	Obligatoire
approval_request_id	string	L’ID de la requête d’approbation à laquelle on répond.	Oui
Approuver	booléen	Indique si la demande a été approuvée.	Oui
id	string	ID unique de la réponse d’approbation	Oui
raison	chaîne (nullable)		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.ItemResourceMcpListTools

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	chaîne (nullable)		Non
id	string	ID unique de la liste.	Oui
server_label	string	Étiquette du serveur MCP.	Oui
Outils	tableau d’OpenAI.MCPListToolsTools	Outils disponibles sur le serveur.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_list_tools`. Valeurs possibles : `mcp_list_tools`	Oui

OpenAI.ItemResourceMcpToolCall

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne (nullable)		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	chaîne (nullable)		Non
id	string	ID unique de l’appel d’outil.	Oui
nom	string	Le nom de l’outil qui a été exécuté.	Oui
sortie	chaîne (nullable)		Non
server_label	string	Étiquette du serveur MCP exécutant l’outil.	Oui
status	OpenAI.MCPToolCallStatus		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_call`. Valeurs possibles : `mcp_call`	Oui

OpenAI.ItemResourceOutputMessage

Message de sortie du modèle.

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.OutputMessageContent	Contenu du message de sortie.	Oui
id	string	ID unique du message de sortie.	Oui
role	enum	Rôle du message de sortie. A toujours la valeur `assistant`. Valeurs possibles : `assistant`	Oui
status	enum	État de l’entrée de message. Un des `in_progress`, ou `completed` `incomplete`. Rempli lorsque les éléments d’entrée sont retournés via l’API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type du message de sortie. A toujours la valeur `message`. Valeurs possibles : `output_message`	Oui

OpenAI.ItemResourceType

Propriété Valeur

Type string

Valeurs message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Résultats d’un appel d’outil de recherche web. Pour plus d’informations, consultez le guide de recherche web .

Nom	Type	Description	Obligatoire
action	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Objet décrivant l’action spécifique effectuée dans cet appel de recherche web. Inclut des détails sur la façon dont le modèle a utilisé le web (recherche, open_page, recherche).	Oui
id	string	ID unique de l’appel de l’outil de recherche web.	Oui
status	enum	L’état de l’appel d’outil de recherche web. Valeurs possibles : `in_progress`, , `searchingcompleted`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche web. A toujours la valeur `web_search_call`. Valeurs possibles : `web_search_call`	Oui

OpenAI.ItemType

Propriété Valeur

Type string

OpenAI.ItemWebSearchToolCall

Résultats d’un appel d’outil de recherche web. Pour plus d’informations, consultez le guide de recherche web .

Nom	Type	Description	Obligatoire
action	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Objet décrivant l’action spécifique effectuée dans cet appel de recherche web. Inclut des détails sur la façon dont le modèle a utilisé le web (recherche, open_page, recherche).	Oui
id	string	ID unique de l’appel de l’outil de recherche web.	Oui
status	enum	L’état de l’appel d’outil de recherche web. Valeurs possibles : `in_progress`, , `searchingcompleted`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche web. A toujours la valeur `web_search_call`. Valeurs possibles : `web_search_call`	Oui

OpenAI.KeyPressAction

Une collection de séquences de touches que le modèle souhaite effectuer.

Nom	Type	Description	Obligatoire	Par défaut
keys	tableau de chaînes	La combinaison de touches que le modèle demande d’être enfoncée. Il s’agit d’un tableau de chaînes, chacun représentant une clé.	Oui
type	enum	Spécifie le type d’événement. Pour une action de pression de touche, cette propriété est toujours définie à `keypress`. Valeurs possibles : `keypress`	Oui

OpenAI.ListFineTuningJobCheckpointsResponse

Nom	Type	Description	Obligatoire
data	tableau d’OpenAI.FineTuningJobCheckpoint		Oui
premier_identifiant	chaîne (nullable)		Non
has_more	booléen		Oui
last_id	chaîne (nullable)		Non
Objet	enum	Valeurs possibles : `list`	Oui

OpenAI.ListFineTuningJobEventsResponse

Nom	Type	Description	Obligatoire
data	tableau d’OpenAI.FineTuningJobEvent		Oui
has_more	booléen		Oui
Objet	enum	Valeurs possibles : `list`	Oui

OpenAI.ListPaginatedFineTuningJobsResponse

Nom	Type	Description	Obligatoire
data	tableau d’OpenAI.FineTuningJob		Oui
has_more	booléen		Oui
Objet	enum	Valeurs possibles : `list`	Oui

OpenAI.LocalShellCallStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Exécutez une commande shell sur le serveur.

Nom	Type	Description	Obligatoire
commande	tableau de chaînes	Commande à exécuter.	Oui
environnement	Objet	Variables d’environnement à définir pour la commande.	Oui
timeout (délai en ms)	OpenAI.integer (annulable)		Non
type	enum	Type de l’action de l’interpréteur de commandes local. A toujours la valeur `exec`. Valeurs possibles : `exec`	Oui
user	chaîne (nullable)		Non
working_directory	chaîne (nullable)		Non

OpenAI.LocalShellToolParam

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

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

OpenAI.LogProb

Probabilité du journal d’un jeton.

Nom	Type	Obligatoire
octets	tableau d’OpenAI.integer	Oui
logprob	OpenAI.numeric	Oui
token	string	Oui
top_logprobs	tableau d’OpenAI.TopLogProb	Oui

OpenAI.MCPListToolsTool

Outil disponible sur un serveur MCP.

Nom	Type	Description	Obligatoire
Annotations	OpenAI.MCPListToolsToolAnnotations (annulable)		Non
description	chaîne (nullable)		Non
input_schema	OpenAI.MCPListToolsToolInputSchema		Oui
nom	string	Nom de l’outil.	Oui

OpenAI.MCPListToolsToolAnnotations

Type : objet

OpenAI.MCPListToolsToolInputSchema

Type : objet

OpenAI.MCPTool

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

Nom	Type	Description	Obligatoire
outils_autorisés	tableau de chaîne ou OpenAI.MCPToolFilter		Non
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.	Non
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`	Non
headers	objet (nullable)		Non
project_connection_id	string	ID de connexion dans le project du serveur MCP. La connexion stocke l’authentification et d’autres détails de connexion nécessaires pour se connecter au serveur MCP.	Non
require_approval	objet (voir les modèles valides ci-dessous)		Non
server_description	string	Description facultative du serveur MCP, utilisée pour fournir davantage de contexte.	Non
server_label	string	Étiquette de ce serveur MCP, utilisée pour l’identifier dans les appels d’outils.	Oui
URL du serveur	string	URL du serveur MCP. L’une ou l’autre `server_urlconnector_id` doit être Fourni.	Non
type	enum	Type de l’outil MCP. A toujours la valeur `mcp`. Valeurs possibles : `mcp`	Oui

OpenAI.MCPToolCallStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

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

Nom	Type	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.	Non
tool_names	tableau de chaînes	Liste des noms d’outils autorisés.	Non

OpenAI.MCPToolRequireApproval

Nom	Type	Description	Obligatoire	Par défaut
toujours	OpenAI.MCPToolFilter	Objet de filtre permettant de spécifier les outils autorisés.	Non
jamais	OpenAI.MCPToolFilter	Objet de filtre permettant de spécifier les outils autorisés.	Non

OpenAI.MessageContent

Composant de contenu qui compose un élément d’entrée ou de sortie.

Discriminateur pour OpenAI.MessageContent

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

Type de valeur	Schema
`text`	OpenAI.TextContent
`summary_text`	OpenAI.SummaryTextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.MessageContentType		Oui

OpenAI.MessageContentInputFileContent

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne (nullable)		Non
file_url	string	URL du fichier à envoyer au modèle.	Non
filename	string	Nom du fichier à envoyer au modèle.	Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_file`. Valeurs possibles : `input_file`	Oui

OpenAI.MessageContentInputImageContent

Entrée d’image dans le modèle. Découvrez les entrées d’image.

Nom	Type	Description	Obligatoire
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne (nullable)		Non
image_url	string		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui

OpenAI.MessageContentInputTextContent

Entrée de texte dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Entrée de texte dans le modèle.	Oui
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_text`. Valeurs possibles : `input_text`	Oui

OpenAI.MessageContentOutputTextContent

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire
Annotations	tableau d’OpenAI.Annotation	Annotations de la sortie de texte.	Oui
logprobs	tableau d’OpenAI.LogProb		Non
text	string	Le texte généré par le modèle.	Oui
type	enum	Type du texte de sortie. A toujours la valeur `output_text`. Valeurs possibles : `output_text`	Oui

OpenAI.MessageContentReasoningTextContent

Texte de raisonnement du modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Texte de raisonnement du modèle.	Oui
type	enum	Type du texte de raisonnement. A toujours la valeur `reasoning_text`. Valeurs possibles : `reasoning_text`	Oui

OpenAI.MessageContentRefusalContent

Refus du modèle.

Nom	Type	Description	Obligatoire	Par défaut
refusal	string	Explication du refus du modèle.	Oui
type	enum	Type de refus. A toujours la valeur `refusal`. Valeurs possibles : `refusal`	Oui

OpenAI.MessageContentType

Propriété	Valeur
Type	string
Valeurs	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessageRole

Propriété	Valeur
Type	string
Valeurs	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.Metadata

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 un format structuré 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 dont la longueur maximale est de 512 caractères.

Type : objet

OpenAI.ModelIdsCompaction

ID de modèle utilisé pour générer la réponse, comme gpt-5 ou o3. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, caractéristiques de performances et points de prix. Reportez-vous au guide de modèle pour parcourir et comparer les modèles disponibles.

Type : OpenAI.ModelIdsResponses ou chaîne

OpenAI.ModelIdsResponses

Propriété	Valeur
Type	string
Valeurs	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

Type : chaîne ou OpenAI.ChatModel

OpenAI.Move

Action de déplacement de la souris.

Nom	Type	Description	Obligatoire
type	enum	Spécifie le type d’événement. Pour une action de déplacement, cette propriété est toujours défini sur `move`. Valeurs possibles : `move`	Oui
x	OpenAI.integer		Oui
y	OpenAI.integer		Oui

OpenAI.OutputContent

Discriminateur pour OpenAI.OutputContent

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

Type de valeur	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.OutputContentType		Oui

OpenAI.OutputContentOutputTextContent

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire
Annotations	tableau d’OpenAI.Annotation	Annotations de la sortie de texte.	Oui
logprobs	tableau d’OpenAI.LogProb		Non
text	string	Le texte généré par le modèle.	Oui
type	enum	Type du texte de sortie. A toujours la valeur `output_text`. Valeurs possibles : `output_text`	Oui

OpenAI.OutputContentReasoningTextContent

Texte de raisonnement du modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Texte de raisonnement du modèle.	Oui
type	enum	Type du texte de raisonnement. A toujours la valeur `reasoning_text`. Valeurs possibles : `reasoning_text`	Oui

OpenAI.OutputContentRefusalContent

Refus du modèle.

Nom	Type	Description	Obligatoire	Par défaut
refusal	string	Explication du refus du modèle.	Oui
type	enum	Type de refus. A toujours la valeur `refusal`. Valeurs possibles : `refusal`	Oui

OpenAI.OutputContentType

Propriété	Valeur
Type	string
Valeurs	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Discriminateur pour OpenAI.OutputItem

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

Type de valeur	Schema
`structured_outputs`	StructuredOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
response_id	string	Réponse sur laquelle l’élément est créé.	Non
type	OpenAI.OutputItemType		Oui

OpenAI.OutputItemApplyPatchToolCall

Appel d’outil qui applique des différences de fichier en créant, supprimant ou mettant à jour des fichiers.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cet appel d’outil.	Non
id	string	ID unique de l’appel de l’outil apply patch. Renseigné lorsque cet élément est retourné via l’API.	Oui
fonctionnement	OpenAI.ApplyPatchFileOperation	Une des opérations create_file, delete_file ou update_file appliquées via apply_patch.	Oui
└─ Type	OpenAI.ApplyPatchFileOperationType		Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	OpenAI.ApplyPatchCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call`. Valeurs possibles : `apply_patch_call`	Oui

OpenAI.OutputItemApplyPatchToolCallOutput

Sortie émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	ID unique de l’appel de l’outil apply patch généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cette sortie d’appel d’outil.	Non
id	string	ID unique de la sortie d’appel de l’outil appliquer le correctif. Renseigné lorsque cet élément est retourné via l’API.	Oui
sortie	chaîne (nullable)		Non
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	OpenAI.ApplyPatchCallOutputStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `apply_patch_call_output`. Valeurs possibles : `apply_patch_call_output`	Oui

OpenAI.OutputItemCodeInterpreterToolCall

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
code	chaîne (nullable)		Oui
container_id	string	ID du conteneur utilisé pour exécuter le code.	Oui
id	string	ID unique de l’appel de l’outil interpréteur de code.	Oui
outputs	tableau d’OpenAI.CodeInterpreterOutputLogs ou OpenAI.CodeInterpreterOutputImage		Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	Le statut de l’appel de l’outil Interpréteur de code. Les valeurs acceptables sont : `in_progress`, `completed`, `incomplete`, `interpreting` et `failed`. Valeurs possibles : `in_progress`, , `completedincomplete`, `interpreting`,`failed`	Oui
type	enum	Type de l’appel de l’outil interpréteur de code. A toujours la valeur `code_interpreter_call`. Valeurs possibles : `code_interpreter_call`	Oui

OpenAI.OutputItemCompactionBody

Élément de compactage généré par l’APIv1/responses/compact.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
encrypted_content	string	Contenu chiffré généré par compactage.	Oui
id	string	ID unique de l’élément de compactage.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
type	enum	Type de l’élément. A toujours la valeur `compaction`. Valeurs possibles : `compaction`	Oui

OpenAI.OutputItemComputerToolCall

Un appel d’outil à un outil d’utilisation d’ordinateur. Pour plus d’informations, consultez le guide d’utilisation de l’ordinateur .

Nom	Type	Description	Obligatoire
action	OpenAI.ComputerAction		Oui
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	Identificateur utilisé lors de la réponse à l’appel de l’outil avec sortie.	Oui
id	string	ID unique de l’appel informatique.	Oui
pending_safety_checks	tableau d’OpenAI.ComputerCallSafetyCheckParam	Les vérifications de sécurité en attente pour l'appel informatique.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’ordinateur. A toujours la valeur `computer_call`. Valeurs possibles : `computer_call`	Oui

OpenAI.OutputItemCustomToolCall

Appel à un outil personnalisé créé par le modèle.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	Identificateur utilisé pour mapper cet appel d’outil personnalisé à une sortie d’appel d’outil.	Oui
id	string	ID unique de l’appel d’outil personnalisé dans la plateforme OpenAI.	Non
input	string	Entrée de l’appel d’outil personnalisé généré par le modèle.	Oui
nom	string	Nom de l’outil personnalisé appelé.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
type	enum	Type de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call`. Valeurs possibles : `custom_tool_call`	Oui

OpenAI.OutputItemFileSearchToolCall

Résultats d’un appel d’outil de recherche de fichiers. Pour plus d’informations, consultez le guide de recherche de fichiers .

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
id	string	ID unique de l’appel de l’outil de recherche de fichiers.	Oui
queries	tableau de chaînes	Requêtes utilisées pour rechercher des fichiers.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
results	tableau d’OpenAI.FileSearchToolCallResults		Non
status	enum	État de l'accès à l’outil de recherche de fichiers. Valeurs possibles : `in_progress`, `searching`, `incomplete`, ou `failed` Valeurs possibles : `in_progress`, , `searchingcompleted`, `incomplete`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche de fichiers. A toujours la valeur `file_search_call`. Valeurs possibles : `file_search_call`	Oui

OpenAI.OutputItemFunctionShellCall

Appel d’outil qui exécute une ou plusieurs commandes shell dans un environnement managé.

Nom	Type	Description	Obligatoire
action	OpenAI.FunctionShellAction	Exécutez une commande shell.	Oui
Commandes └ ;	tableau de chaînes		Oui
└max_output_length	OpenAI.integer (annulable)		Oui
└timeout_ms	OpenAI.integer (annulable)		Oui
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle.	Oui
created_by	string	ID de l’entité qui a créé cet appel d’outil.	Non
id	string	ID unique de l’appel de l’outil shell. Renseigné lorsque cet élément est retourné via l’API.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	OpenAI.LocalShellCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui

OpenAI.OutputItemFunctionShellCallOutput

Sortie d’un appel d’outil shell émis.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	ID unique de l’appel de l’outil shell généré par le modèle.	Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
id	string	ID unique de la sortie de l’appel d’interpréteur de commandes. Renseigné lorsque cet élément est retourné via l’API.	Oui
max_output_length	OpenAI.integer (annulable)		Oui
sortie	tableau d’OpenAI.FunctionShellCallOutputContent	Tableau de contenu de sortie d’appel d’interpréteur de commandes	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
type	enum	Type de sortie de l’appel d’interpréteur de commandes. A toujours la valeur `shell_call_output`. Valeurs possibles : `shell_call_output`	Oui

OpenAI.OutputItemFunctionToolCall

Un appel d’outil pour exécuter une fonction. Pour plus d’informations, consultez le guide d’appel de fonction .

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
Arguments	string	Chaîne JSON des arguments à passer à la fonction.	Oui
call_id	string	ID unique de l’appel de l’outil fonctionnel généré par le modèle.	Oui
id	string	Identifiant unique de l'appel de l'outil fonctionnel.	Non
nom	string	Nom de la fonction à exécuter.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
type	enum	Type d'appel de l'outil fonctionnel. A toujours la valeur `function_call`. Valeurs possibles : `function_call`	Oui

OpenAI.OutputItemImageGenToolCall

Demande de génération d’image effectuée par le modèle.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
id	string	ID unique de l’appel de génération d’image.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
result	chaîne (nullable)		Oui
status	enum	État de l’appel de génération d’image. Valeurs possibles : `in_progress`, , `completedgenerating`,`failed`	Oui
type	enum	Type de l’appel de génération d’image. A toujours la valeur `image_generation_call`. Valeurs possibles : `image_generation_call`	Oui

OpenAI.OutputItemLocalShellToolCall

Un appel d’outil pour exécuter une commande sur l’interpréteur de commandes local.

Nom	Type	Description	Obligatoire
action	OpenAI.LocalShellExecAction	Exécutez une commande shell sur le serveur.	Oui
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
call_id	string	ID unique de l’appel de l’outil shell local généré par le modèle.	Oui
id	string	ID unique de l’appel d’interpréteur de commandes local.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	État de l’appel d’interpréteur de commandes local. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type de l’appel d’interpréteur de commandes local. A toujours la valeur `local_shell_call`. Valeurs possibles : `local_shell_call`	Oui

OpenAI.OutputItemMcpApprovalRequest

Demande d'approbation humaine pour l'invocation d'un outil.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
Arguments	string	Chaîne JSON d’arguments pour l’outil.	Oui
id	string	ID unique de la demande d’approbation.	Oui
nom	string	Nom de l’outil à exécuter.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
server_label	string	Étiquette du serveur MCP effectuant la requête.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_request`. Valeurs possibles : `mcp_approval_request`	Oui

OpenAI.OutputItemMcpListTools

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
erreur	chaîne (nullable)		Non
id	string	ID unique de la liste.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
server_label	string	Étiquette du serveur MCP.	Oui
Outils	tableau d’OpenAI.MCPListToolsTools	Outils disponibles sur le serveur.	Oui
type	enum	Type de l’élément. A toujours la valeur `mcp_list_tools`. Valeurs possibles : `mcp_list_tools`	Oui

OpenAI.OutputItemMcpToolCall

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
approval_request_id	chaîne (nullable)		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	chaîne (nullable)		Non
id	string	ID unique de l’appel d’outil.	Oui
nom	string	Le nom de l’outil qui a été exécuté.	Oui
sortie	chaîne (nullable)		Non
response_id	string	Réponse sur laquelle l’élément est créé.	Non
server_label	string	Étiquette du serveur MCP exécutant l’outil.	Oui
status	OpenAI.MCPToolCallStatus		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_call`. Valeurs possibles : `mcp_call`	Oui

OpenAI.OutputItemOutputMessage

Message de sortie du modèle.

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
contenu	tableau d’OpenAI.OutputMessageContent	Contenu du message de sortie.	Oui
id	string	ID unique du message de sortie.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
role	enum	Rôle du message de sortie. A toujours la valeur `assistant`. Valeurs possibles : `assistant`	Oui
status	enum	État de l’entrée de message. Un des `in_progress`, ou `completed` `incomplete`. Rempli lorsque les éléments d’entrée sont retournés via l’API. Valeurs possibles : `in_progress`, , `completedincomplete`	Oui
type	enum	Type du message de sortie. A toujours la valeur `message`. Valeurs possibles : `output_message`	Oui

OpenAI.OutputItemReasoningItem

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
contenu	tableau d’OpenAI.ReasoningTextContent	Contenu du texte de raisonnement.	Non
encrypted_content	chaîne (nullable)		Non
id	string	Identificateur unique du contenu du raisonnement.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	État de l’élément. Un des `in_progress`, ou `completed` `incomplete`. La valeur est remplie lorsque les éléments sont retournés via l'API. Valeurs possibles : `in_progress`, , `completedincomplete`	Non
summary	tableau d’OpenAI.Summary	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.OutputItemType

Propriété Valeur

Type string

Valeurs output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Résultats d’un appel d’outil de recherche web. Pour plus d’informations, consultez le guide de recherche web .

Nom	Type	Description	Obligatoire
action	OpenAI.WebSearchActionSearch ou OpenAI.WebSearchActionOpenPage ou OpenAI.WebSearchActionFind	Objet décrivant l’action spécifique effectuée dans cet appel de recherche web. Inclut des détails sur la façon dont le modèle a utilisé le web (recherche, open_page, recherche).	Oui
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
id	string	ID unique de l’appel de l’outil de recherche web.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	L’état de l’appel d’outil de recherche web. Valeurs possibles : `in_progress`, , `searchingcompleted`,`failed`	Oui
type	enum	Type de l’appel de l’outil de recherche web. A toujours la valeur `web_search_call`. Valeurs possibles : `web_search_call`	Oui

OpenAI.OutputMessageContent

Discriminateur pour OpenAI.OutputMessageContent

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

Type de valeur	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.OutputMessageContentType		Oui

OpenAI.OutputMessageContentOutputTextContent

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire
Annotations	tableau d’OpenAI.Annotation	Annotations de la sortie de texte.	Oui
logprobs	tableau d’OpenAI.LogProb		Non
text	string	Le texte généré par le modèle.	Oui
type	enum	Type du texte de sortie. A toujours la valeur `output_text`. Valeurs possibles : `output_text`	Oui

OpenAI.OutputMessageContentRefusalContent

Refus du modèle.

Nom	Type	Description	Obligatoire	Par défaut
refusal	string	Explication du refus du modèle.	Oui
type	enum	Type de refus. A toujours la valeur `refusal`. Valeurs possibles : `refusal`	Oui

OpenAI.OutputMessageContentType

Propriété	Valeur
Type	string
Valeurs	`output_text` `refusal`

OpenAI.Prompt

Référence à un modèle d’invite et à ses variables. En savoir plus.

Nom	Type	Description	Obligatoire
id	string	Identificateur unique du modèle d’invite à utiliser.	Oui
variables	OpenAI.ResponsePromptVariables (nullable)	Mappage facultatif de valeurs à remplacer par des variables dans votre « Invite de connexion » Les valeurs de substitution peuvent être des chaînes ou autres types d’entrée de réponse tels que des images ou des fichiers.	Non
version	chaîne (nullable)		Non

OpenAI.RankerVersionType

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

OpenAI.RankingOptions

Nom	Type	Description	Obligatoire
hybrid_search	OpenAI.HybridSearchOptions		Non
└embedding_weight	OpenAI.numeric	Poids de l’incorporation dans la fusion de classement réciproque.	Oui
└text_weight	OpenAI.numeric	Poids du texte dans la fusion de classement réciproque.	Oui
ranker	OpenAI.RankerVersionType		Non
seuil de score	OpenAI.numeric		Non

OpenAI.Reasoning

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

Nom	Type	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`.	Non
generate_summary	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
summary	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non

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	Oui
Valeurs	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Texte de raisonnement du modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Texte de raisonnement du modèle.	Oui
type	enum	Type du texte de raisonnement. A toujours la valeur `reasoning_text`. Valeurs possibles : `reasoning_text`	Oui

OpenAI.Response

Nom	Type	Description	Obligatoire	Par défaut
agent_reference	AgentReference (annulable)		Oui
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
Arrière-plan	booléen (nullable)		Non
terminé_à	entier		Non
conversation	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└─ identifiant	string	ID unique de la conversation à laquelle cette réponse a été associée.	Oui
date_de_création	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
erreur	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ Code	OpenAI.ResponseErrorCode	Code d’erreur de la réponse.	Oui
└─ Message	string	Description lisible par l’homme de l’erreur.	Oui
id	string	Identificateur unique pour cette réponse.	Oui
incomplete_details	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ raison	enum	Valeurs possibles : `max_output_tokens`, `content_filter`	Non
Instructions	chaîne ou tableau d’OpenAI.InputItem		Oui
max_output_tokens	OpenAI.integer (annulable)		Non
max_tool_calls	OpenAI.integer (annulable)		Non
Métadonnées	OpenAI.Metadata (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.	Non
model	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
output_text	chaîne (nullable)		Non
parallel_tool_calls	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
previous_response_id	chaîne (nullable)		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
reasoning	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
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`.	Non
└─ générer_resume	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
Résumé └>	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
niveau de service	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
status	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
Température	OpenAI.numeric (annulable)		Non	1
text	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
tool_choice	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
top_logprobs	OpenAI.integer (annulable)		Non
top_p	OpenAI.numeric (annulable)		Non	1
truncation	enum	Valeurs possibles : `auto`, `disabled`	Non
utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
user	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non

OpenAI.ResponseAudioDeltaEvent

Émis lorsqu’il existe une réponse audio partielle.

Nom	Type	Description	Obligatoire
delta	string	Segment d’octets audio de réponse encodés en Base64.	Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.audio.delta`. Valeurs possibles : `response.audio.delta`	Oui

OpenAI.ResponseAudioDoneEvent

Émis lorsque la réponse audio est terminée.

Nom	Type	Description	Obligatoire	Par défaut
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.audio.done`. Valeurs possibles : `response.audio.done`	Oui

OpenAI.ResponseAudioTranscriptDeltaEvent

Émis lorsqu’il existe une transcription partielle de l’audio.

Nom	Type	Description	Obligatoire
delta	string	Transcription partielle de la réponse audio.	Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.audio.transcript.delta`. Valeurs possibles : `response.audio.transcript.delta`	Oui

OpenAI.ResponseAudioTranscriptDoneEvent

Émis lorsque la transcription audio complète est terminée.

Nom	Type	Description	Obligatoire	Par défaut
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.audio.transcript.done`. Valeurs possibles : `response.audio.transcript.done`	Oui

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Émis lorsqu’un extrait de code partiel est diffusé en continu par l’interpréteur de code.

Nom	Type	Description	Obligatoire
delta	string	Extrait de code partiel diffusé par l’interpréteur de code.	Oui
item_id	string	Identificateur unique de l’élément d’appel de l’outil interpréteur de code.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.code_interpreter_call_code.delta`. Valeurs possibles : `response.code_interpreter_call_code.delta`	Oui

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Émis lorsque l’extrait de code est finalisé par l’interpréteur de code.

Nom	Type	Description	Obligatoire
code	string	Sortie finale de l’extrait de code par l’interpréteur de code.	Oui
item_id	string	Identificateur unique de l’élément d’appel de l’outil interpréteur de code.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.code_interpreter_call_code.done`. Valeurs possibles : `response.code_interpreter_call_code.done`	Oui

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Émis lorsque l’appel de l’interpréteur de code est terminé.

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément d’appel de l’outil interpréteur de code.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.code_interpreter_call.completed`. Valeurs possibles : `response.code_interpreter_call.completed`	Oui

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Émis lorsqu’un appel d’interpréteur de code est en cours.

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément d’appel de l’outil interpréteur de code.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.code_interpreter_call.in_progress`. Valeurs possibles : `response.code_interpreter_call.in_progress`	Oui

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Émis lorsque l’interpréteur de code interprète activement l’extrait de code.

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément d’appel de l’outil interpréteur de code.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.code_interpreter_call.interpreting`. Valeurs possibles : `response.code_interpreter_call.interpreting`	Oui

OpenAI.ResponseCompletedEvent

Émis lorsque la réponse du modèle est terminée.

Nom	Type	Description	Obligatoire	Par défaut
response	OpenAI.Response		Oui
└agent_reference	AgentReference (annulable)	Agent utilisé pour cette réponse	Oui
└─ arrière-plan	booléen (nullable)		Non
└completed_at	entier (nullable)		Non
Conversation └>	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└created_at	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem (nullable)		Oui
└ max_output_tokens	OpenAI.integer (annulable)		Non
└max_tool_calls	OpenAI.integer (annulable)		Non
└─ Métadonnées	OpenAI.Metadata (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.	Non
└─ Modèle	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
└─ Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
└─ Sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
└─output_text	chaîne (nullable)		Non
└─ appels_outils_parallèles	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
└identifiant_de_réponse_précédent (`previous_response_id`)	chaîne (nullable)		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
└prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
└prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
└─ Raisonnement	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
└safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
└service_tier	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
└─ État	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
└─ Température	OpenAI.numeric (annulable)		Non	1
└─ texte	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
└─ choix_outil	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
└─ Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	OpenAI.integer (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
└─ troncature	enum	Valeurs possibles : `auto`, `disabled`	Non
└─ utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
└─ Utilisateur	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.completed`. Valeurs possibles : `response.completed`	Oui

OpenAI.ResponseContentPartAddedEvent

Émis lorsqu’un nouveau composant de contenu est ajouté.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
item_id	string	ID de l’élément de sortie auquel la partie de contenu a été ajoutée.	Oui
output_index	OpenAI.integer		Oui
part	OpenAI.OutputContent		Oui
└─ Type	OpenAI.OutputContentType		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.content_part.added`. Valeurs possibles : `response.content_part.added`	Oui

OpenAI.ResponseContentPartDoneEvent

Émis lorsqu’un composant de contenu est terminé.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
item_id	string	ID de l’élément de sortie auquel la partie de contenu a été ajoutée.	Oui
output_index	OpenAI.integer		Oui
part	OpenAI.OutputContent		Oui
└─ Type	OpenAI.OutputContentType		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.content_part.done`. Valeurs possibles : `response.content_part.done`	Oui

OpenAI.ResponseCreatedEvent

Événement émis lors de la création d’une réponse.

Nom	Type	Description	Obligatoire	Par défaut
response	OpenAI.Response		Oui
└agent_reference	AgentReference (annulable)	Agent utilisé pour cette réponse	Oui
└─ arrière-plan	booléen (nullable)		Non
└completed_at	entier (nullable)		Non
Conversation └>	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└created_at	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem (nullable)		Oui
└ max_output_tokens	OpenAI.integer (annulable)		Non
└max_tool_calls	OpenAI.integer (annulable)		Non
└─ Métadonnées	OpenAI.Metadata (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.	Non
└─ Modèle	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
└─ Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
└─ Sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
└─output_text	chaîne (nullable)		Non
└─ appels_outils_parallèles	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
└identifiant_de_réponse_précédent (`previous_response_id`)	chaîne (nullable)		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
└prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
└prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
└─ Raisonnement	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
└safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
└service_tier	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
└─ État	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
└─ Température	OpenAI.numeric (annulable)		Non	1
└─ texte	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
└─ choix_outil	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
└─ Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	OpenAI.integer (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
└─ troncature	enum	Valeurs possibles : `auto`, `disabled`	Non
└─ utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
└─ Utilisateur	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.created`. Valeurs possibles : `response.created`	Oui

OpenAI.ResponseCustomToolCallInputDeltaEvent

Événement représentant un delta (mise à jour partielle) à l’entrée d’un appel d’outil personnalisé.

Nom	Type	Description	Obligatoire
delta	string	Données d’entrée incrémentielles (delta) pour l’appel d’outil personnalisé.	Oui
item_id	string	Identificateur unique de l’élément d’API associé à cet événement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	Identificateur de type d’événement. Valeurs possibles : `response.custom_tool_call_input.delta`	Oui

OpenAI.ResponseCustomToolCallInputDoneEvent

Événement indiquant que l’entrée d’un appel d’outil personnalisé est terminée.

Nom	Type	Description	Obligatoire
input	string	Données d’entrée complètes pour l’appel d’outil personnalisé.	Oui
item_id	string	Identificateur unique de l’élément d’API associé à cet événement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	Identificateur de type d’événement. Valeurs possibles : `response.custom_tool_call_input.done`	Oui

OpenAI.ResponseError

Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.

Nom	Type	Description	Obligatoire	Par défaut
code	OpenAI.ResponseErrorCode	Code d’erreur de la réponse.	Oui
message	string	Description lisible par l’homme de l’erreur.	Oui

OpenAI.ResponseErrorCode

Code d’erreur de la réponse.

Propriété	Valeur
Type	string
Valeurs	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Émis lorsqu’une erreur se produit.

Nom	Type	Description	Obligatoire
code	chaîne (nullable)		Oui
message	string	Message d’erreur.	Oui
param	chaîne (nullable)		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `error`. Valeurs possibles : `error`	Oui

OpenAI.ResponseFailedEvent

Événement émis en cas d’échec d’une réponse.

Nom	Type	Description	Obligatoire	Par défaut
response	OpenAI.Response		Oui
└agent_reference	AgentReference (annulable)	Agent utilisé pour cette réponse	Oui
└─ arrière-plan	booléen (nullable)		Non
└completed_at	entier (nullable)		Non
Conversation └>	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└created_at	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem (nullable)		Oui
└ max_output_tokens	OpenAI.integer (annulable)		Non
└max_tool_calls	OpenAI.integer (annulable)		Non
└─ Métadonnées	OpenAI.Metadata (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.	Non
└─ Modèle	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
└─ Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
└─ Sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
└─output_text	chaîne (nullable)		Non
└─ appels_outils_parallèles	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
└identifiant_de_réponse_précédent (`previous_response_id`)	chaîne (nullable)		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
└prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
└prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
└─ Raisonnement	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
└safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
└service_tier	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
└─ État	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
└─ Température	OpenAI.numeric (annulable)		Non	1
└─ texte	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
└─ choix_outil	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
└─ Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	OpenAI.integer (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
└─ troncature	enum	Valeurs possibles : `auto`, `disabled`	Non
└─ utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
└─ Utilisateur	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.failed`. Valeurs possibles : `response.failed`	Oui

OpenAI.ResponseFileSearchCallCompletedEvent

Émis lorsqu’un appel de recherche de fichiers est terminé (résultats trouvés).

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément de sortie initié par l’appel de recherche de fichier.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.file_search_call.completed`. Valeurs possibles : `response.file_search_call.completed`	Oui

OpenAI.ResponseFileSearchCallInProgressEvent

Émis lorsqu’un appel de recherche de fichiers est lancé.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément de sortie initié par l’appel de recherche de fichier.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.file_search_call.in_progress`. Valeurs possibles : `response.file_search_call.in_progress`	Oui

OpenAI.ResponseFileSearchCallSearchingEvent

Émis lorsqu'une recherche de fichier est en cours.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément de sortie initié par l’appel de recherche de fichier.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.file_search_call.searching`. Valeurs possibles : `response.file_search_call.searching`	Oui

OpenAI.ResponseFormatJsonObject

Nom	Type	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`	Oui

OpenAI.ResponseFormatJsonSchema

Format de réponse de schéma JSON. Utilisé pour générer des réponses JSON structurées. En savoir plus sur les sorties structurées.

Nom	Type	Description	Obligatoire
json_schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Oui
└─ Description	string		Non
└─ Nom	string		Oui
└─ Schéma	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.	Non
└─ stricte	booléen (nullable)		Non
type	enum	Type de format de réponse défini. A toujours la valeur `json_schema`. Valeurs possibles : `json_schema`	Oui

OpenAI.ResponseFormatJsonSchemaJsonSchema

Nom	Type	Description	Obligatoire
description	string		Non
nom	string		Oui
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.	Non
strict	booléen (nullable)		Non

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.

Type : objet

OpenAI.ResponseFormatText

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

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Émis lorsqu’il existe un delta d’arguments d’appel de fonction partiel.

Nom	Type	Description	Obligatoire
delta	string	Delta des arguments d’appel de fonction ajoutés.	Oui
item_id	string	ID de l’élément de sortie auquel le delta des arguments d’appel de fonction est ajouté.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.function_call_arguments.delta`. Valeurs possibles : `response.function_call_arguments.delta`	Oui

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Émis lorsque des arguments d’appel de fonction sont finalisés.

Nom	Type	Description	Obligatoire
Arguments	string	Arguments d’appel de fonction.	Oui
item_id	string	ID de l’élément.	Oui
nom	string	Le nom de la fonction qui a été appelée.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	Valeurs possibles : `response.function_call_arguments.done`	Oui

OpenAI.ResponseImageGenCallCompletedEvent

Émis lorsqu’un appel d’outil de génération d’images est terminé et que l’image finale est disponible.

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément de génération d’image en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.image_generation_call.completed ». Valeurs possibles : `response.image_generation_call.completed`	Oui

OpenAI.ResponseImageGenCallGeneratingEvent

Émis lorsqu’un appel d’outil de génération d’images génère activement une image (état intermédiaire).

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément de génération d’image en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.image_generation_call.generating ». Valeurs possibles : `response.image_generation_call.generating`	Oui

OpenAI.ResponseImageGenCallInProgressEvent

Émis lorsqu’un appel d’outil de génération d’images est en cours.

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément de génération d’image en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.image_generation_call.in_progress ». Valeurs possibles : `response.image_generation_call.in_progress`	Oui

OpenAI.ResponseImageGenCallPartialImageEvent

Émis lorsqu’une image partielle est disponible pendant la diffusion en continu de génération d’images.

Nom	Type	Description	Obligatoire
item_id	string	Identificateur unique de l’élément de génération d’image en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
partial_image_b64	string	Données d’image partielle encodées en base64, adaptées au rendu en tant qu’image.	Oui
partial_image_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.image_generation_call.partial_image ». Valeurs possibles : `response.image_generation_call.partial_image`	Oui

OpenAI.ResponseInProgressEvent

Émis lorsque la réponse est en cours.

Nom	Type	Description	Obligatoire	Par défaut
response	OpenAI.Response		Oui
└agent_reference	AgentReference (annulable)	Agent utilisé pour cette réponse	Oui
└─ arrière-plan	booléen (nullable)		Non
└completed_at	entier (nullable)		Non
Conversation └>	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└created_at	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem (nullable)		Oui
└ max_output_tokens	OpenAI.integer (annulable)		Non
└max_tool_calls	OpenAI.integer (annulable)		Non
└─ Métadonnées	OpenAI.Metadata (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.	Non
└─ Modèle	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
└─ Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
└─ Sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
└─output_text	chaîne (nullable)		Non
└─ appels_outils_parallèles	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
└identifiant_de_réponse_précédent (`previous_response_id`)	chaîne (nullable)		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
└prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
└prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
└─ Raisonnement	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
└safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
└service_tier	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
└─ État	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
└─ Température	OpenAI.numeric (annulable)		Non	1
└─ texte	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
└─ choix_outil	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
└─ Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	OpenAI.integer (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
└─ troncature	enum	Valeurs possibles : `auto`, `disabled`	Non
└─ utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
└─ Utilisateur	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.in_progress`. Valeurs possibles : `response.in_progress`	Oui

OpenAI.ResponseIncompleteDetails

Nom	Type	Description	Obligatoire	Par défaut
raison	enum	Valeurs possibles : `max_output_tokens`, `content_filter`	Non

OpenAI.ResponseIncompleteEvent

Événement émis lorsqu’une réponse se termine comme incomplète.

Nom	Type	Description	Obligatoire	Par défaut
response	OpenAI.Response		Oui
└agent_reference	AgentReference (annulable)	Agent utilisé pour cette réponse	Oui
└─ arrière-plan	booléen (nullable)		Non
└completed_at	entier (nullable)		Non
Conversation └>	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└created_at	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem (nullable)		Oui
└ max_output_tokens	OpenAI.integer (annulable)		Non
└max_tool_calls	OpenAI.integer (annulable)		Non
└─ Métadonnées	OpenAI.Metadata (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.	Non
└─ Modèle	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
└─ Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
└─ Sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
└─output_text	chaîne (nullable)		Non
└─ appels_outils_parallèles	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
└identifiant_de_réponse_précédent (`previous_response_id`)	chaîne (nullable)		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
└prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
└prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
└─ Raisonnement	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
└safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
└service_tier	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
└─ État	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
└─ Température	OpenAI.numeric (annulable)		Non	1
└─ texte	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
└─ choix_outil	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
└─ Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	OpenAI.integer (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
└─ troncature	enum	Valeurs possibles : `auto`, `disabled`	Non
└─ utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
└─ Utilisateur	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.incomplete`. Valeurs possibles : `response.incomplete`	Oui

OpenAI.ResponseLogProb

Un logprob est la probabilité logarithmique que le modèle affecte à la production d’un jeton particulier à une position donnée dans la séquence. Les valeurs logprob moins négatives (plus élevées) indiquent une plus grande confiance du modèle dans ce choix de jeton.

Nom	Type	Description	Obligatoire
logprob	OpenAI.numeric		Oui
token	string	Jeton de texte possible.	Oui
top_logprobs	tableau d’OpenAI.ResponseLogProbTopLogprobs	Probabilité du journal des 20 premiers jetons les plus probables.	Non

OpenAI.ResponseLogProbTopLogprobs

Nom	Type	Description	Obligatoire	Par défaut
logprob	OpenAI.numeric		Non
token	string		Non

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Émis lorsqu’il y a un delta (mise à jour partielle) des arguments d’un appel d’outil de MCP.

Nom	Type	Description	Obligatoire
delta	string	Chaîne JSON contenant la mise à jour partielle vers les arguments de l’appel de l’outil MCP.	Oui
item_id	string	L’identifiant unique de l’élément d’appel de l’outil de MCP en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call_arguments.delta ». Valeurs possibles : `response.mcp_call_arguments.delta`	Oui

OpenAI.ResponseMCPCallArgumentsDoneEvent

Émis lorsque les arguments d’un appel d’outil MCP sont finalisés.

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON contenant les arguments finalisés pour l’appel de l’outil MCP.	Oui
item_id	string	L’identifiant unique de l’élément d’appel de l’outil de MCP en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call_arguments.done ». Valeurs possibles : `response.mcp_call_arguments.done`	Oui

OpenAI.ResponseMCPCallCompletedEvent

Émis lorsqu’un appel d’outil MCP s’est terminé avec succès.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément d’appel de l’outil MCP qui s’est terminé.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call.completed ». Valeurs possibles : `response.mcp_call.completed`	Oui

OpenAI.ResponseMCPCallFailedEvent

Émis lorsqu’un appel d’outil MCP a échoué.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément d’appel de l’outil MCP qui a échoué.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call.failed ». Valeurs possibles : `response.mcp_call.failed`	Oui

OpenAI.ResponseMCPCallInProgressEvent

Émis lorsqu’un appel d’outil MCP est en cours.

Nom	Type	Description	Obligatoire
item_id	string	L’identifiant unique de l’élément d’appel de l’outil de MCP en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call.in_progress ». Valeurs possibles : `response.mcp_call.in_progress`	Oui

OpenAI.ResponseMCPListToolsCompletedEvent

Émis lorsque la liste des outils MCP disponibles a été récupérée avec succès.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément d’appel de l’outil MCP qui a produit cette sortie.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_list_tools.completed ». Valeurs possibles : `response.mcp_list_tools.completed`	Oui

OpenAI.ResponseMCPListToolsFailedEvent

Émis lorsque la tentative de liste des outils MCP disponibles a échoué.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément d’appel de l’outil MCP qui a échoué.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_list_tools.failed ». Valeurs possibles : `response.mcp_list_tools.failed`	Oui

OpenAI.ResponseMCPListToolsInProgressEvent

Émis lorsque le système est en train de récupérer la liste des outils MCP disponibles.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément d’appel de l’outil MCP en cours de traitement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.mcp_list_tools.in_progress ». Valeurs possibles : `response.mcp_list_tools.in_progress`	Oui

OpenAI.ResponseOutputItemAddedEvent

Émis lorsqu’un nouvel élément de sortie est ajouté.

Nom	Type	Description	Obligatoire
item	OpenAI.OutputItem		Oui
└agent_reference	AgentReference	Agent qui a créé l’élément.	Non
└response_id	string	Réponse sur laquelle l’élément est créé.	Non
└─ Type	OpenAI.OutputItemType		Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.output_item.added`. Valeurs possibles : `response.output_item.added`	Oui

OpenAI.ResponseOutputItemDoneEvent

Émis lorsqu’un élément de sortie est marqué comme terminé.

Nom	Type	Description	Obligatoire
item	OpenAI.OutputItem		Oui
└agent_reference	AgentReference	Agent qui a créé l’élément.	Non
└response_id	string	Réponse sur laquelle l’élément est créé.	Non
└─ Type	OpenAI.OutputItemType		Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.output_item.done`. Valeurs possibles : `response.output_item.done`	Oui

OpenAI.ResponseOutputTextAnnotationAddedEvent

Émis lorsqu’une annotation est ajoutée au contenu du texte de sortie.

Nom	Type	Description	Obligatoire
annotation	OpenAI.Annotation	Annotation qui s’applique à une étendue de texte de sortie.	Oui
└─ Type	OpenAI.AnnotationType		Oui
annotation_index	OpenAI.integer		Oui
content_index	OpenAI.integer		Oui
item_id	string	Identificateur unique de l’élément auquel l’annotation est ajoutée.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.output_text.annotation.added ». Valeurs possibles : `response.output_text.annotation.added`	Oui

OpenAI.ResponsePromptVariables

Mappage facultatif de valeurs à remplacer par des variables dans votre invite. Les valeurs de substitution peuvent être des chaînes ou d’autres types d’entrée Response tels que des images ou des fichiers.

Type : objet

OpenAI.ResponseQueuedEvent

Émis lorsqu’une réponse est mise en file d’attente et en attente d’être traitée.

Nom	Type	Description	Obligatoire	Par défaut
response	OpenAI.Response		Oui
└agent_reference	AgentReference (annulable)	Agent utilisé pour cette réponse	Oui
└─ arrière-plan	booléen (nullable)		Non
└completed_at	entier (nullable)		Non
Conversation └>	OpenAI.ConversationReference (annulable)	Conversation à laquelle cette réponse appartient. Les éléments d’entrée et les éléments de sortie de cette réponse ont été automatiquement ajoutés à cette conversation.	Non
└created_at	entier	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError (annulable)	Objet d’erreur retourné lorsque le modèle ne parvient pas à générer une réponse.	Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails (annulable)		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem (nullable)		Oui
└ max_output_tokens	OpenAI.integer (annulable)		Non
└max_tool_calls	OpenAI.integer (annulable)		Non
└─ Métadonnées	OpenAI.Metadata (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.	Non
└─ Modèle	string	Déploiement de modèle à utiliser pour la création de cette réponse.	Non
└─ Objet	enum	Type d’objet de cette ressource - toujours défini sur `response`. Valeurs possibles : `response`	Oui
└─ Sortie	tableau d’OpenAI.OutputItem	Tableau d’éléments de contenu générés par le modèle. - La longueur et l’ordre des éléments dans le `output` tableau dépendent sur la réponse du modèle. - Plutôt que d’accéder au premier élément du `output` tableau et en supposant qu’il s’agit d’un `assistant` message avec le contenu généré par du modèle, vous pouvez envisager d’utiliser la propriété `output_text` où pris en charge dans les kits SDK.	Oui
└─output_text	chaîne (nullable)		Non
└─ appels_outils_parallèles	booléen	Indique s’il faut autoriser le modèle à exécuter des appels d’outil en parallèle.	Oui	True
└identifiant_de_réponse_précédent (`previous_response_id`)	chaîne (nullable)		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables. En savoir plus.	Non
└prompt_cache_key	string	Utilisé par OpenAI pour mettre en cache des réponses pour des requêtes similaires afin d’optimiser les taux d’accès de votre cache. Remplace le `user` champ. En savoir plus.	Non
└prompt_cache_retention	enum	Valeurs possibles : `in-memory`, `24h`	Non
└─ Raisonnement	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
└safety_identifier	string	Identificateur stable utilisé pour détecter les utilisateurs de votre application susceptibles de violer les stratégies d’utilisation d’OpenAI. Les ID doivent être une chaîne qui identifie de manière unique chaque utilisateur. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. En savoir plus.	Non
└service_tier	OpenAI.ServiceTier	Spécifie le type de traitement utilisé pour traiter la requête. - Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ». - Si la valeur est « par défaut », la requête sera traitée avec la tarification et les performances standard du modèle sélectionné. - Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant. - Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le `service_tier` paramètre est défini, le corps de la réponse inclut la `service_tier` valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.	Non
└─ État	enum	État de la génération de réponse. Un des `completed`, , `failed` `in_progress`, `cancelled`, , `queued`ou `incomplete`. Valeurs possibles : `completed`, , `failedin_progress`, `cancelled`, `queuedincomplete`	Non
└─ Température	OpenAI.numeric (annulable)		Non	1
└─ texte	OpenAI.ResponseTextParam	Options de configuration d’une réponse texte à partir du modèle. Peut être simple données JSON textuelles ou structurées. Pour en savoir plus: - Entrées et sorties de texte - Sorties structurées	Non
└─ choix_outil	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceParam		Non
└─ Outils	OpenAI.ToolsArray	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. Nous prenons en charge les catégories d’outils suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche web ou recherche de fichiers. En savoir plus sur outils intégrés. - Outils MCP : Intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur Outils MCP. - Appels de fonction (outils personnalisés) : fonctions définies par vous, activation du modèle pour appeler votre propre code avec des arguments fortement typés et sorties. En savoir plus sur appel de fonction. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	OpenAI.integer (annulable)		Non
└─ top_p	OpenAI.numeric (annulable)		Non	1
└─ troncature	enum	Valeurs possibles : `auto`, `disabled`	Non
└─ utilisation	OpenAI.ResponseUsage	Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, répartition des jetons de sortie et du nombre total de jetons utilisés.	Non
└─ Utilisateur	chaîne (déconseillée)	Ce champ est remplacé par `safety_identifier` et `prompt_cache_key`. Utilisez `prompt_cache_key` plutôt pour gérer les optimisations de mise en cache. Identificateur stable pour vos utilisateurs finaux. Utilisé pour améliorer les taux d’accès au cache en compartimentant mieux les demandes similaires et pour aider OpenAI à détecter et à prévenir les abus. En savoir plus.	Non
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; Toujours « response.queued ». Valeurs possibles : `response.queued`	Oui

OpenAI.ResponseReasoningSummaryPartAddedEvent

Émis lorsqu’une nouvelle partie récapitulative de raisonnement est ajoutée.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément avec lequel cette partie récapitulative est associée.	Oui
output_index	OpenAI.integer		Oui
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Oui
└─ texte	string		Oui
└─ Type	enum	Valeurs possibles : `summary_text`	Oui
sequence_number	OpenAI.integer		Oui
summary_index	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.reasoning_summary_part.added`. Valeurs possibles : `response.reasoning_summary_part.added`	Oui

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Nom	Type	Description	Obligatoire	Par défaut
text	string		Oui
type	enum	Valeurs possibles : `summary_text`	Oui

OpenAI.ResponseReasoningSummaryPartDoneEvent

Émis lorsqu’une partie récapitulative de raisonnement est terminée.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément avec lequel cette partie récapitulative est associée.	Oui
output_index	OpenAI.integer		Oui
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Oui
└─ texte	string		Oui
└─ Type	enum	Valeurs possibles : `summary_text`	Oui
sequence_number	OpenAI.integer		Oui
summary_index	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.reasoning_summary_part.done`. Valeurs possibles : `response.reasoning_summary_part.done`	Oui

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Nom	Type	Description	Obligatoire	Par défaut
text	string		Oui
type	enum	Valeurs possibles : `summary_text`	Oui

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Émis lorsqu’un delta est ajouté à un texte récapitulatif de raisonnement.

Nom	Type	Description	Obligatoire
delta	string	Le delta du texte qui a été ajouté au résumé.	Oui
item_id	string	L’ID de l’élément associé à ce texte de delta de résumé.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
summary_index	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.reasoning_summary_text.delta`. Valeurs possibles : `response.reasoning_summary_text.delta`	Oui

OpenAI.ResponseReasoningSummaryTextDoneEvent

Émis lorsqu’un texte récapitulatif de raisonnement est terminé.

Nom	Type	Description	Obligatoire
item_id	string	ID de l’élément avec lequel ce texte de synthèse est associé.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
summary_index	OpenAI.integer		Oui
text	string	Texte intégral du résumé du raisonnement terminé.	Oui
type	enum	le type de l'événement ; A toujours la valeur `response.reasoning_summary_text.done`. Valeurs possibles : `response.reasoning_summary_text.done`	Oui

OpenAI.ResponseReasoningTextDeltaEvent

Émis lorsqu’un delta est ajouté à un texte de raisonnement.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
delta	string	Delta de texte ajouté au contenu du raisonnement.	Oui
item_id	string	ID de l’élément associé à ce delta de texte de raisonnement.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.reasoning_text.delta`. Valeurs possibles : `response.reasoning_text.delta`	Oui

OpenAI.ResponseReasoningTextDoneEvent

Émis lorsqu’un texte de raisonnement est terminé.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
item_id	string	ID de l’élément avec lequel ce texte de raisonnement est associé.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
text	string	Texte intégral du contenu du raisonnement terminé.	Oui
type	enum	le type de l'événement ; A toujours la valeur `response.reasoning_text.done`. Valeurs possibles : `response.reasoning_text.done`	Oui

OpenAI.ResponseRefusalDeltaEvent

Émis lorsqu’il existe un texte de refus partiel.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
delta	string	Texte de refus ajouté.	Oui
item_id	string	ID de l’élément de sortie auquel le texte de refus est ajouté.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.refusal.delta`. Valeurs possibles : `response.refusal.delta`	Oui

OpenAI.ResponseRefusalDoneEvent

Émis lorsque le texte de refus est finalisé.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
item_id	string	ID de l'élément de sortie pour lequel le texte de refus est finalisé.	Oui
output_index	OpenAI.integer		Oui
refusal	string	Texte de refus finalisé.	Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.refusal.done`. Valeurs possibles : `response.refusal.done`	Oui

OpenAI.ResponseStreamOptions

Options de diffusion en continu des réponses. Définissez cette valeur uniquement lorsque vous définissez stream: true.

Nom	Type	Description	Obligatoire	Par défaut
include_obfuscation	booléen	Lorsque la valeur est true, l’obfuscation de flux est activée. Ajouts d’obfuscation de flux caractères aléatoires sur un `obfuscation` champ sur les événements delta de diffusion en continu vers normalisez les tailles de charge utile en tant qu’atténuation de certaines attaques par canal latéral. Ces champs d’obfuscation sont inclus par défaut, mais ajoutent une petite quantité d’une surcharge sur le flux de données. Vous pouvez définir `include_obfuscation` sur false pour optimiser la bande passante si vous approuvez les liens réseau entre votre application et l’API OpenAI.	Non

OpenAI.ResponseTextDeltaEvent

Émis lorsqu’il existe un delta de texte supplémentaire.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
delta	string	Le delta de texte qui a été ajouté.	Oui
item_id	string	ID de l’élément de sortie auquel le delta de texte a été ajouté.	Oui
logprobs	tableau d’OpenAI.ResponseLogProb	Probabilités de journal des jetons dans le delta.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.output_text.delta`. Valeurs possibles : `response.output_text.delta`	Oui

OpenAI.ResponseTextDoneEvent

Émis lorsque le contenu du texte est finalisé.

Nom	Type	Description	Obligatoire
content_index	OpenAI.integer		Oui
item_id	string	ID de l’élément de sortie pour lequel le contenu du texte est finalisé.	Oui
logprobs	tableau d’OpenAI.ResponseLogProb	Probabilités de journal des jetons dans le delta.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
text	string	Contenu texte finalisé.	Oui
type	enum	le type de l'événement ; A toujours la valeur `response.output_text.done`. Valeurs possibles : `response.output_text.done`	Oui

OpenAI.ResponseTextParam

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

Nom	Type	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 gpt-4o et les modèles plus récents :* 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.	Non
Verbosité	OpenAI.Verbosity	Limite la détail de la réponse du modèle. Les valeurs inférieures entraînent des réponses plus concises, tandis que des valeurs plus élevées entraînent des réponses plus détaillées. Actuellement, les valeurs prises en charge sont `low`, `medium`et `high`.	Non

OpenAI.ResponseUsage

Représente les détails de l’utilisation des jetons, notamment les jetons d’entrée, les jetons de sortie, la répartition des jetons de sortie et le nombre total de jetons utilisés.

Nom	Type	Obligatoire
input_tokens	OpenAI.integer	Oui
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Oui
└cached_tokens	OpenAI.integer	Oui
output_tokens	OpenAI.integer	Oui
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Oui
└─ jetons_de_raisonnement	OpenAI.integer	Oui
total_tokens	OpenAI.integer	Oui

OpenAI.ResponseUsageInputTokensDetails

Nom	Type	Description	Obligatoire	Par défaut
cached_tokens	OpenAI.integer		Oui

OpenAI.ResponseUsageOutputTokensDetails

Nom	Type	Description	Obligatoire	Par défaut
jetons_de_raisonnement	OpenAI.integer		Oui

OpenAI.ResponseWebSearchCallCompletedEvent

Émis lorsqu’un appel de recherche web est terminé.

Nom	Type	Description	Obligatoire
item_id	string	ID unique de l’élément de sortie associé à l’appel de recherche web.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.web_search_call.completed`. Valeurs possibles : `response.web_search_call.completed`	Oui

OpenAI.ResponseWebSearchCallInProgressEvent

Émis lorsqu’un appel de recherche web est lancé.

Nom	Type	Description	Obligatoire
item_id	string	ID unique de l’élément de sortie associé à l’appel de recherche web.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.web_search_call.in_progress`. Valeurs possibles : `response.web_search_call.in_progress`	Oui

OpenAI.ResponseWebSearchCallSearchingEvent

Émis lorsqu’un appel de recherche web est en cours d’exécution.

Nom	Type	Description	Obligatoire
item_id	string	ID unique de l’élément de sortie associé à l’appel de recherche web.	Oui
output_index	OpenAI.integer		Oui
sequence_number	OpenAI.integer		Oui
type	enum	le type de l'événement ; A toujours la valeur `response.web_search_call.searching`. Valeurs possibles : `response.web_search_call.searching`	Oui

OpenAI.Capture d’écran

Action de capture d’écran.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Spécifie le type d’événement. Pour une action de capture d’écran, cette propriété est toujours défini sur `screenshot`. Valeurs possibles : `screenshot`	Oui

OpenAI.Scroll

Action de défilement.

Nom	Type	Description	Obligatoire
scroll_x	OpenAI.integer		Oui
scroll_y	OpenAI.integer		Oui
type	enum	Spécifie le type d’événement. Pour une action de défilement, cette propriété est toujours défini sur `scroll`. Valeurs possibles : `scroll`	Oui
x	OpenAI.integer		Oui
y	OpenAI.integer		Oui

OpenAI.SearchContextSize

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

OpenAI.ServiceTier

Spécifie le type de traitement utilisé pour traiter la requête.

Si la valeur est « automatique », la requête est traitée avec le niveau de service configuré dans les paramètres de Project. Sauf configuration contraire, l'Project utilise « default ».
Si la valeur est « par défaut », la requête est traitée avec la tarification et les performances standard du modèle sélectionné.
Si la valeur est « flex » ou « priority », la requête est traitée avec le niveau de service correspondant.
Lorsqu’il n’est pas défini, le comportement par défaut est « auto ». Lorsque le service_tier paramètre est défini, le corps de la réponse inclut la service_tier valeur en fonction du mode de traitement réellement utilisé pour traiter la requête. Cette valeur de réponse peut être différente de la valeur définie dans le paramètre.

Propriété	Valeur
Type	string
Nullable	Oui
Valeurs	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

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

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Outil à appeler. A toujours la valeur `apply_patch`. Valeurs possibles : `apply_patch`	Oui

OpenAI.SpecificFunctionShellParam

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

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Outil à appeler. A toujours la valeur `shell`. Valeurs possibles : `shell`	Oui

OpenAI.Summary

Texte récapitulative du modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Résumé de la sortie du raisonnement du modèle jusqu’à présent.	Oui
type	enum	Type de l’objet. A toujours la valeur `summary_text`. Valeurs possibles : `summary_text`	Oui

OpenAI.SummaryTextContent

Texte récapitulative du modèle.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Résumé de la sortie du raisonnement du modèle jusqu’à présent.	Oui
type	enum	Type de l’objet. A toujours la valeur `summary_text`. Valeurs possibles : `summary_text`	Oui

OpenAI.TextContent

Contenu texte.

Nom	Type	Description	Obligatoire	Par défaut
text	string		Oui
type	enum	Valeurs possibles : `text`	Oui

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 gpt-4o et les modèles plus récents :* paramètre 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 :

Type de valeur	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.TextResponseFormatConfigurationType		Oui

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Nom	Type	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`	Oui

OpenAI.TextResponseFormatConfigurationResponseFormatText

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

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

OpenAI.TextResponseFormatConfigurationType

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

OpenAI.TextResponseFormatJsonSchema

Format de réponse de schéma JSON. Utilisé pour générer des réponses JSON structurées. En savoir plus sur les sorties structurées.

Nom	Type	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.	Non
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.	Oui
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.	Oui
strict	booléen (nullable)		Non
type	enum	Type de format de réponse défini. A toujours la valeur `json_schema`. Valeurs possibles : `json_schema`	Oui

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 :

Type de valeur	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

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ToolType		Oui

OpenAI.ToolChoiceAllowed

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

Nom	Type	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`	Oui
Outils	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>`	Oui
type	enum	Type de configuration d’outil autorisé. A toujours la valeur `allowed_tools`. Valeurs possibles : `allowed_tools`	Oui

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.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `code_interpreter`	Oui

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.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `computer_use_preview`	Oui

OpenAI.ToolChoiceCustom

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

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

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.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `file_search`	Oui

OpenAI.ToolChoiceFunction

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

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

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.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `image_generation`	Oui

OpenAI.ToolChoiceMCP

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

Nom	Type	Description	Obligatoire
nom	chaîne (nullable)		Non
server_label	string	Étiquette du serveur MCP à utiliser.	Oui
type	enum	Pour les outils MCP, le type est toujours `mcp`. Valeurs possibles : `mcp`	Oui

OpenAI.ToolChoiceOptions

Contrôle (le cas échéant) l’outil appelé par le modèle. none signifie que le modèle n’appelle pas d’outil et génère plutôt un message. auto signifie que le modèle peut choisir entre générer un message ou appeler un ou plusieurs outils. required signifie que le modèle doit appeler un ou plusieurs outils.

Propriété	Valeur
Type	string
Valeurs	`none` `auto` `required`

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 :

Type de valeur	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

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ToolChoiceParamType		Oui

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.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `web_search_preview`	Oui

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.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `web_search_preview_2025_03_11`	Oui

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

Un tableau d’outils que le modèle peut appeler lors de la génération d’une réponse. Vous pouvez spécifier l’outil à utiliser en définissant le tool_choice paramètre. Nous prenons en charge les catégories d’outils suivantes :

Outils intégrés : outils fournis par OpenAI qui étendent les fonctionnalités du modèle, telles que la recherche web ou la recherche de fichiers. En savoir plus sur les outils intégrés.
MCP Tools : intégrations avec des systèmes tiers via des serveurs MCP personnalisés ou des connecteurs prédéfinis tels que Google Drive et SharePoint. En savoir plus sur les outils MCP.
Appels de fonction (outils personnalisés) : fonctions définies par vous, permettant au modèle d’appeler votre propre code avec des arguments et des sorties fortement typés. En savoir plus sur l’appel de fonction. Vous pouvez également utiliser des outils personnalisés pour appeler votre propre code.

Tableau de : OpenAI.Tool

OpenAI.TopLogProb

Probabilité de journal supérieure d’un jeton.

Nom	Type	Obligatoire
octets	tableau d’OpenAI.integer	Oui
logprob	OpenAI.numeric	Oui
token	string	Oui

OpenAI.Type

Une action pour saisir du texte.

Nom	Type	Description	Obligatoire	Par défaut
text	string	Texte à taper.	Oui
type	enum	Spécifie le type d’événement. Pour une action de type, cette propriété est toujours défini sur `type`. Valeurs possibles : `type`	Oui

OpenAI.UpdateConversationBody

Nom	Type	Description	Obligatoire	Par défaut
Métadonnées	OpenAI.Metadata (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.	Oui

OpenAI.UrlCitationBody

Citation d’une ressource web utilisée pour générer une réponse de modèle.

Nom	Type	Description	Obligatoire
end_index	OpenAI.integer		Oui
start_index	OpenAI.integer		Oui
title	string	Titre de la ressource web.	Oui
type	enum	Type de la citation d’URL. A toujours la valeur `url_citation`. Valeurs possibles : `url_citation`	Oui
url	string	URL de la ressource web.	Oui

OpenAI.VectorStoreFileAttributes

Type : objet

OpenAI.Verbosity

Limite la détail de la réponse du modèle. Les valeurs inférieures entraînent des réponses plus concises, tandis que les valeurs plus élevées entraînent des réponses plus détaillées. Actuellement, les valeurs prises en charge sont low, mediumet high.

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

OpenAI.Wait

Une action d'attente.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Spécifie le type d’événement. Pour une action d’attente, cette propriété est toujours défini sur `wait`. Valeurs possibles : `wait`	Oui

OpenAI.WebSearchActionFind

Type d’action « find » : recherche un modèle dans une page chargée.

Nom	Type	Description	Obligatoire
pattern	string	Modèle ou texte à rechercher dans la page.	Oui
type	enum	Type d’action. Valeurs possibles : `find_in_page`	Oui
url	string	URL de la page recherchée pour le modèle.	Oui

OpenAI.WebSearchActionOpenPage

Type d’action « open_page » : ouvre une URL spécifique à partir des résultats de la recherche.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Type d’action. Valeurs possibles : `open_page`	Oui
url	string	URL ouverte par le modèle.	Oui

OpenAI.WebSearchActionSearchSearch

Type d’action « search » : effectue une requête de recherche web.

Nom	Type	Description	Obligatoire
queries	tableau de chaînes	Requêtes de recherche.	Non
query	chaîne (déconseillée)	[DÉCONSEILLÉ] Requête de recherche.	Oui
Sources	tableau d’OpenAI.WebSearchActionSearchSources	Sources utilisées dans la recherche.	Non
type	enum	Type d’action. Valeurs possibles : `search`	Oui

OpenAI.WebSearchActionSearchSources

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Valeurs possibles : `url`	Oui
url	string		Oui

OpenAI.WebSearchApproximateLocation

Emplacement approximatif de l’utilisateur.

Nom	Type	Description	Obligatoire
Ville	chaîne (nullable)		Non
country	chaîne (nullable)		Non
region	chaîne (nullable)		Non
timezone	chaîne (nullable)		Non
type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Non

OpenAI.WebSearchPreviewTool

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

Nom	Type	Description	Obligatoire
taille_contexte_recherche	OpenAI.SearchContextSize		Non
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`	Oui
emplacement_utilisateur	OpenAI.ApproximateLocation (nullable)		Non
Ville └	chaîne (nullable)		Non
Pays └>	chaîne (nullable)		Non
Région └ ;	chaîne (nullable)		Non
└' fuseau horaire	chaîne (nullable)		Non
└─ Type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Oui

OpenAI.WebSearchTool

Cherchez sur Internet des sources liées à la consigne. En savoir plus sur l’outil de recherche web.

Nom	Type	Description	Obligatoire
custom_search_configuration	WebSearchConfiguration	Configuration de recherche web pour bing recherche personnalisée	Non
└instance_name	string	Nom de l’instance de configuration personnalisée donnée à la configuration.	Oui
└project_connection_id	string	Project ID de connexion pour la mise à l’aide de la recherche personnalisée Bing	Oui
Filtres	OpenAI.WebSearchToolFilters (annulable)		Non
└allowed_domains	tableau de chaîne (nullable)		Non
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`	Non
type	enum	Type de l’outil de recherche web. L’un de `web_search` ou `web_search_2025_08_26`. Valeurs possibles : `web_search`	Oui
emplacement_utilisateur	OpenAI.WebSearchApproximateLocation (annulable)	Emplacement approximatif de l’utilisateur.	Non
Ville └	chaîne (nullable)		Non
Pays └>	chaîne (nullable)		Non
Région └ ;	chaîne (nullable)		Non
└' fuseau horaire	chaîne (nullable)		Non
└─ Type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Non

OpenAI.WebSearchToolFilters

Nom	Type	Description	Obligatoire	Par défaut
allowed_domains	tableau de chaînes		Non

OpenAI.integer

Type : entier

Format : int64

OpenAI.numeric

Type : nombre

Format : double

OpenApiAnonymousAuthDetails

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

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

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 :

Type de valeur	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Nom	Type	Description	Obligatoire	Par défaut
type	OpenApiAuthType	Type d’authentification pour le point de terminaison OpenApi. Les types autorisés sont : - 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é)	Oui

OpenApiAuthType

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

Anonyme (aucune authentification requise)
Project Connexion (nécessite project_connection_id pour terminer, tel que configuré 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 : - 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.

Nom	Type	Description	Obligatoire
auth	OpenApiAuthDetails	détails d’authentification pour OpenApiFunctionDefinition	Oui
└─ Type	OpenApiAuthType	Le type d’authentification doit être anonyme/project_connection/managed_identity	Oui
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	Non
description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
functions	tableau d’objet	Liste des définitions de fonction utilisées par l’outil OpenApi	Non
nom	string	Nom de la fonction à appeler.	Oui
spec	Objet	Forme de fonction openapi, décrite en tant qu’objet json Schema.	Oui

OpenApiManagedAuthDetails

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

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

OpenApiManagedSecurityScheme

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

Nom	Type	Description	Obligatoire	Par défaut
audience	string	Étendue d’authentification pour managed_identity type d’authentification	Oui

OpenApiProjectConnectionAuthDetails

Détails de sécurité pour l’authentification de connexion openApi project

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

OpenApiProjectConnectionSecurityScheme

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

Nom	Type	Description	Obligatoire	Par défaut
project_connection_id	string	id de connexion Project pour Project type d’authentification de connexion	Oui

OpenApiTool

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

Nom	Type	Description	Obligatoire
openapi	OpenApiFunctionDefinition	Informations de définition d’entrée pour une fonction openapi.	Oui
└> authentification	OpenApiAuthDetails	Ouvrir les détails de l’authentification de l’API	Oui
└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	Non
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
Fonctions └ ;	tableau d’objet (en lecture seule)	Liste des définitions de fonction utilisées par l’outil OpenApi	Non
└─ Description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
└─ Nom	string	Nom de la fonction à appeler.	Oui
└─ Paramètres	Objet	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON.	Oui
└─ Nom	string	Nom de la fonction à appeler.	Oui
Spec └ ;	Objet	Forme de fonction openapi, décrite en tant qu’objet json Schema.	Oui
type	enum	Le type d’objet, qui est toujours 'openapi'. Valeurs possibles : `openapi`	Oui

PageOrder

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

PagedConnection

Collection paginée d’éléments Connection

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau de connexion	Éléments de connexion sur cette page	Oui

PagedDatasetVersion

Collection paginée d’éléments DatasetVersion

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau de DatasetVersion	Éléments DatasetVersion sur cette page	Oui

PagedDeployment

Collection paginée d’éléments de déploiement

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau de déploiement	Éléments de déploiement sur cette page	Oui

PagedEvaluationRule

Collection paginée d’éléments EvaluationRule

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau d’EvaluationRule	Éléments EvaluationRule sur cette page	Oui

PagedEvaluationTaxonomy

Collection paginée d’éléments EvaluationTaxonomy

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau d’EvaluationTaxonomy	Éléments EvaluationTaxonomy sur cette page	Oui

PagedEvaluatorVersion

Collection paginée d’éléments EvaluateVersion

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau d’AssessVersion	Éléments EvaluateVersion sur cette page	Oui

PagedIndex

Collection paginée d’éléments Index

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau d’index	Éléments d’index de cette page	Oui

PagedInsight

Collection paginée d’éléments Insight

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau d’insight	Éléments Insight de cette page	Oui

PagedRedTeam

Collection paginée d’éléments RedTeam

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau de RedTeam	Éléments RedTeam sur cette page	Oui

PagedSchedule

Collection paginée d’éléments Schedule

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau de planification	Éléments de planification de cette page	Oui

PagedScheduleRun

Collection paginée d’éléments ScheduleRun

Nom	Type	Description	Obligatoire	Par défaut
nextLink	string	Lien vers la page suivante des éléments	Non
value	tableau de ScheduleRun	Éléments ScheduleRun sur cette page	Oui

PendingUploadRequest

Représente une demande de téléchargement en attente.

Nom	Type	Description	Obligatoire
connectionName	string	Nom de connexion du compte de stockage Azure à utiliser pour générer un jeton SAS temporaire	Non
pendingUploadId	string	Si PendingUploadId n’est pas fourni, un GUID aléatoire sera utilisé.	Non
pendingUploadType	enum	BlobReference est le seul type pris en charge. Valeurs possibles : `BlobReference`	Oui

PendingUploadResponse

Représente la réponse à une demande de téléchargement en attente

Nom	Type	Description	Obligatoire
blobReference	BlobReference	Détails de référence du blob.	Oui
└> blobUri	string	Chemin d’URI d’objet blob pour que le client charge les données. Exemple : `https://blob.windows.core.net/Container/Path`	Oui
Informations d’identification └>	SasCredential	Informations d’identification pour accéder au compte de stockage.	Oui
└> storageAccountArmId	string	ID ARM du compte de stockage à utiliser.	Oui
pendingUploadId	string	ID de cette demande de téléchargement.	Oui
pendingUploadType	enum	BlobReference est le seul type pris en charge Valeurs possibles : `BlobReference`	Oui
version	string	Version de la ressource à créer si l’utilisateur n’a pas spécifié la version lors de la création initiale du téléchargement	Non

PromptAgentDefinition

Définition de l’agent d’invite

Nom	Type	Description	Obligatoire	Par défaut
Instructions	chaîne (nullable)	Message système (ou développeur) inséré dans le contexte du modèle.	Non
kind	enum	Valeurs possibles : `prompt`	Oui
model	string	Déploiement du modèle à utiliser pour cet agent.	Oui
rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Oui
reasoning	OpenAI.Raisonnement (annulable)	modèles gpt-5 et série o uniquement Options de configuration pour modèles de raisonnement.	Non
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`.	Non
└─ générer_resume	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
Résumé └>	enum	Valeurs possibles : `auto`, , `concisedetailed`	Non
structured_inputs	Objet	Ensemble d’entrées structurées qui peuvent participer à la substitution de modèles d’invite ou aux liaisons d’arguments d’outils.	Non
Température	Numéro	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 vous recommandons généralement de modifier cela ou `top_p` pas les deux.	Non	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.	Non
└─ 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 gpt-4o et les modèles plus récents :* 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.	Non
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.	Non
Outils	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.	Non
top_p	Numéro	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 vous recommandons généralement de modifier cela ou `temperature` pas les deux.	Non	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.

Nom	Type	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 gpt-4o et les modèles plus récents :* 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.	Non

PromptBasedEvaluatorDefinition

Évaluateur basé sur des invites

Nom	Type	Description	Obligatoire
data_schema	Objet	Le schéma JSON (Draft 2020-12) pour les données d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
init_parameters	Objet	Le schéma JSON (Draft 2020-12) pour les paramètres d’entrée de l’évaluateur. Cela inclut des paramètres tels que type, properties, required.	Non
metrics	Objet	Liste des paramètres de production produits par cet évaluateur	Non
prompt_text	string	Texte d’invite utilisé pour l’évaluation	Oui
type	enum	Valeurs possibles : `prompt`	Oui

ProtocolVersionRecord

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

Nom	Type	Description	Obligatoire	Par défaut
protocol	AgentProtocol		Oui
version	string	Chaîne de version pour le protocole, par exemple « v0.1.1 ».	Oui

RaiConfig

Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).

Nom	Type	Description	Obligatoire	Par défaut
rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Oui

RecurrenceSchedule

Modèle de calendrier de récurrence.

Discriminateur pour RecurrenceSchedule

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

Type de valeur	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

Nom	Type	Description	Obligatoire	Par défaut
type	RecurrenceType	Type de récurrence.	Oui

RecurrenceTrigger

Déclencheur basé sur la récurrence.

Nom	Type	Description	Obligatoire	Par défaut
endTime	string	Heure de fin du programme de récurrence au format ISO 8601.	Non
interval	entier	Intervalle pour la planification de la récurrence.	Oui
schedule	RecurrenceSchedule	Modèle de calendrier de récurrence.	Oui
└─ Type	RecurrenceType	Type de périodicité pour la planification de périodicité.	Oui
startTime	string	Heure de début du programme de récurrence au format ISO 8601.	Non
timeZone	string	Fuseau horaire de la planification de la récurrence.	Non	UTC
type	enum	Type de déclencheur. Valeurs possibles : `Recurrence`	Oui

RecurrenceType

Type de récurrence.

Propriété	Valeur
Description	Type de récurrence.
Type	string
Valeurs	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Détails de l’équipe rouge.

Nom	Type	Description	Obligatoire	Par défaut
applicationScenario	string	Scénario d’application pour l’opération d’équipe rouge, afin de générer des attaques spécifiques au scénario.	Non
attackStrategies	array d’AttackStrategy	Liste des stratégies d’attaque ou listes imbriquées de stratégies d’attaque.	Non
displayName	string	Nom de l’exécution de l’équipe rouge.	Non
id	chaîne (en lecture seule)	Identificateur de l’exécution de l’équipe rouge.	Oui
numTurns	entier	Nombre d’arrondis de simulation.	Non
properties	Objet	Propriétés de l’équipe rouge. Contrairement aux balises, les propriétés sont des compléments uniquement. Une fois ajoutée, une propriété ne peut pas être supprimée.	Non
riskCategories	tableau de RiskCategory	Liste des catégories de risques pour générant des objectifs d’attaque.	Non
simulationOnly	booléen	Simulation uniquement ou Simulation + Évaluation. False par défaut, si la valeur true, l’analyse génère la conversation et non le résultat de l’évaluation.	Non	Faux
status	chaîne (en lecture seule)	État de l’équipe rouge. Il est défini par service et est en lecture seule.	Non
tags	Objet	Étiquettes de l’équipe rouge. Contrairement aux propriétés, les balises sont totalement mutables.	Non
target	TargetConfig	Classe abstraite pour la configuration cible.	Oui
└─ Type	string	Type de configuration du modèle.	Oui

RedTeamEvalRunDataSource

Nom	Type	Description	Obligatoire
item_generation_params	ItemGenerationParams	Représente l’ensemble des paramètres utilisés pour contrôler les opérations de génération d’éléments.	Oui
└─ Type	ItemGenerationParamsType	Type de paramètres de génération d’élément à utiliser.	Oui
target	Cible	Classe de base pour les cibles avec support discriminateur.	Oui
└─ Type	string	Type de cible.	Oui
type	enum	Le type de source de données. A toujours la valeur `azure_ai_red_team`. Valeurs possibles : `azure_ai_red_team`	Oui

RedTeamItemGenerationParams

Nom	Type	Description	Obligatoire	Par défaut
attack_strategies	array d’AttackStrategy	Collection de stratégies d’attaque à utiliser.	Oui
num_turns	entier	Nombre de tours autorisés dans le jeu.	Oui	20
type	enum	Type de paramètres de génération d’élément. Valeurs possibles : `red_team`	Oui

RedTeamSeedPromptsItemGenerationParams

Représente les paramètres de la valeur initiale de l’équipe rouge invite la génération d’éléments.

Nom	Type	Description	Obligatoire	Par défaut
attack_strategies	array d’AttackStrategy	Collection de stratégies d’attaque à utiliser.	Oui
num_turns	entier	Nombre de tours autorisés dans le jeu.	Oui	20
Source	OpenAI.EvalJsonlFileContentSource		Oui
└─ Contenu	tableau d’OpenAI.EvalJsonlFileContentSourceContentContent	Contenu du fichier jsonl.	Oui
└─ Type	enum	Type de source jsonl. A toujours la valeur `file_content`. Valeurs possibles : `file_content`	Oui
type	enum	Type de paramètres de génération d’élément, toujours `red_team_seed_prompts`. Valeurs possibles : `red_team_seed_prompts`	Oui

RedTeamTaxonomyItemGenerationParams

Représente les paramètres de génération d’élément de taxonomie d’équipe rouge.

Nom	Type	Description	Obligatoire	Par défaut
attack_strategies	array d’AttackStrategy	Collection de stratégies d’attaque à utiliser.	Oui
num_turns	entier	Nombre de tours autorisés dans le jeu.	Oui	20
Source	OpenAI.EvalJsonlFileContentSource		Oui
└─ Contenu	tableau d’OpenAI.EvalJsonlFileContentSourceContentContent	Contenu du fichier jsonl.	Oui
└─ Type	enum	Type de source jsonl. A toujours la valeur `file_content`. Valeurs possibles : `file_content`	Oui
type	enum	Type de paramètres de génération d’élément, toujours `red_team_taxonomy`. Valeurs possibles : `red_team_taxonomy`	Oui

ResponseRetrievalItemGenerationParams

Représente les paramètres de génération d’élément de récupération de réponse.

Nom	Type	Description	Obligatoire
cartographie des données	Objet	Mappage des champs sources à response_id champ, requis pour récupérer l’historique des conversations.	Oui
max_num_turns	entier	Nombre maximal de tours d’historique de conversation à évaluer.	Oui
Source	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	Source à partir de laquelle le contenu JSONL est lu.	Oui
type	enum	Type de paramètres de génération d’élément, toujours `response_retrieval`. Valeurs possibles : `response_retrieval`	Oui

RiskCategory

Catégorie de risque pour l’objectif d’attaque.

Propriété	Valeur
Description	Catégorie de risque pour l’objectif d’attaque.
Type	string
Valeurs	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentials

Définition des informations d’identification SAS (Shared Access Signature)

Nom	Type	Description	Obligatoire	Par défaut
SAS	chaîne (en lecture seule)	Jeton SAS	Non
type	enum	Type d’informations d’identification Valeurs possibles : `SAS`	Oui

SampleType

Le type d’échantillon utilisé dans l’analyse.

Propriété	Valeur
Description	Le type d’échantillon utilisé dans l’analyse.
Type	string
Valeurs	`EvaluationResultSample`

SasCredential

Définition des informations d’identification SAS

Nom	Type	Description	Obligatoire	Par défaut
sasUri	chaîne (en lecture seule)	URI SAP	Oui
type	enum	Type d’informations d’identification Valeurs possibles : `SAS`	Oui

Schedule

Modèle de planification.

Nom	Type	Description	Obligatoire
description	string	Description de la planification.	Non
displayName	string	Nom de la planification.	Non
enabled	booléen	État activé de la planification.	Oui
id	chaîne (en lecture seule)	Identificateur de la planification.	Oui
properties	Objet	Propriétés de schedule. Contrairement aux balises, les propriétés sont des compléments uniquement. Une fois ajoutée, une propriété ne peut pas être supprimée.	Non
provisionnementÉtat	ScheduleProvisioningStatus (lecture seule)	Planifier l’état du provisionnement.	Non
données système	objet (en lecture seule)	Métadonnées système pour la ressource.	Oui
tags	Objet	Balises de planification. Contrairement aux propriétés, les balises sont totalement mutables.	Non
tâche	ScheduleTask	Planifier le modèle de tâche.	Oui
Configuration de └ ;	Objet	Configuration de la tâche.	Non
└─ Type	ScheduleTaskType	Type de la tâche.	Oui
trigger	Trigger	Modèle de base pour le déclenchement de la planification.	Oui
└─ Type	TriggerType	Type de déclencheur.	Oui

ScheduleProvisioningStatus

Planifier l’état du provisionnement.

Propriété	Valeur
Description	Planifier l’état du provisionnement.
Type	string
Valeurs	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Planifier le modèle d’exécution.

Nom	Type	Description	Obligatoire
erreur	chaîne (en lecture seule)	Informations d’erreur pour l’exécution de la planification.	Non
id	chaîne (en lecture seule)	Identificateur de l’exécution de planification.	Oui
properties	objet (en lecture seule)	Propriétés de l’exécution de planification.	Oui
scheduleId	string	Identificateur de la planification.	Oui
succès	booléen (en lecture seule)	Déclenchez l’état de réussite de l’exécution de la planification.	Oui
triggerTime	string	Heure de déclenchement de l’exécution de la planification.	Non

PlanifierTâche

Planifier le modèle de tâche.

Discriminateur pour ScheduleTask

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

Type de valeur	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

Nom	Type	Description	Obligatoire	Par défaut
configuration	Objet	Configuration de la tâche.	Non
type	ScheduleTaskType	Type de la tâche.	Oui

ScheduleTaskType

Type de la tâche.

Propriété	Valeur
Description	Type de la tâche.
Type	string
Valeurs	`Evaluation` `Insight`

SharepointGroundingToolParameters

Paramètres de l’outil de mise à la terre SharePoint.

Nom	Type	Description	Obligatoire	Par défaut
project_connections	tableau d’ToolProjectConnection	Connexions project attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil.	Non

SharepointPreviewTool

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

Nom	Type	Description	Obligatoire
sharepoint_grounding_preview	SharepointGroundingToolParameters	Paramètres de l’outil de mise à la terre SharePoint.	Oui
└project_connections	tableau d’ToolProjectConnection	Connexions project attachées à cet outil. Il peut y avoir un maximum de 1 connexion ressource attachée à l’outil. Contraintes : maxItems : 1	Non
type	enum	Le type d’objet, qui est toujours « sharepoint_grounding_preview ». Valeurs possibles : `sharepoint_grounding_preview`	Oui

Sku

Informations sur la référence SKU

Nom	Type	Description	Obligatoire
capacity	entier	Capacité de référence SKU	Oui
family	string	Famille de références SKU	Oui
nom	string	Nom de la référence SKU	Oui
size	string	Taille de la référence SKU	Oui
tier	string	Niveau de référence SKU	Oui

StructuredInputDefinition

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

Nom	Type	Description	Obligatoire	Par défaut
default_value		Valeur par défaut de l’entrée si aucune valeur d’exécution n’est fournie.	Non
description	string	Une description lisible par l’homme de l’entrée.	Non
required	booléen	Indique si la propriété input est requise lorsque l’agent est appelé.	Non	Faux
schema	Objet	Le schéma JSON de l’entrée structurée (facultatif).	Non

StructuredOutputDefinition

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

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

StructuredOutputsOutputItem

Nom	Type	Description	Obligatoire
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
sortie		Sortie structurée capturée pendant la réponse.	Oui
response_id	string	Réponse sur laquelle l’élément est créé.	Non
type	enum	Valeurs possibles : `structured_outputs`	Oui

SyntheticDataGenerationPreviewEvalRunDataSource

Représente une source de données pour les exécutions d’évaluation qui évaluent en fonction des données synthétiques générées à des fins de test.

Nom	Type	Description	Obligatoire
messages_d'entrée	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Non
└─ Modèle	tableau d’objet ou OpenAI.EvalItem		Oui
└─ Type	enum	Valeurs possibles : `template`	Oui
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Oui
└model_deployment_name	string	Nom du déploiement de modèle à utiliser pour générer des données synthétiques.	Oui
└output_dataset_id	chaîne (en lecture seule)	Identificateur du jeu de données de sortie où les données synthétiques générées sont stockées. Les données générées sont un fichier jsonl avec l’ID de colonnes, la requête et test_description.	Non
└output_dataset_name	string	Nom du jeu de données de sortie dans lequel les données synthétiques générées seront stockées. S’il n’est pas fourni, le service génère automatiquement le nom du jeu de données.	Non
└─ invite	string	Invite utilisée pour générer des données synthétiques. Il s’agit d’une option si la cible est de type « azure_ai_agent » avec des instructions configurées dans l’agent.	Non
└samples_count	entier	Nombre maximal d’échantillons de données à générer.	Oui
Sources └>	tableau d’OpenAI.EvalJsonlFileIdSource	Fichiers sources de contenu de données initiales facultatifs pour la génération de données.	Oui
└─ Type	enum	Type de paramètres de génération d’élément. Valeurs possibles : `synthetic_data_gen_preview`	Oui
target	Cible	Classe de base pour les cibles avec support discriminateur.	Oui
└─ Type	string	Type de cible.	Oui
type	enum	Type de source de données, toujours `azure_ai_synthetic_data_gen_preview`. Valeurs possibles : `azure_ai_synthetic_data_gen_preview`	Oui

SyntheticDataGenerationPreviewItemGenerationParams

Nom	Type	Description	Obligatoire
model_deployment_name	string	Nom du déploiement de modèle à utiliser pour générer des données synthétiques.	Oui
output_dataset_id	chaîne (en lecture seule)	Identificateur du jeu de données de sortie où les données synthétiques générées sont stockées. Les données générées sont un fichier jsonl avec l’ID de colonnes, la requête et test_description.	Non
output_dataset_name	string	Nom du jeu de données de sortie dans lequel les données synthétiques générées seront stockées. S’il n’est pas fourni, le service génère automatiquement le nom du jeu de données.	Non
prompt	string	Invite utilisée pour générer des données synthétiques. Il s’agit d’une option si la cible est de type « azure_ai_agent » avec des instructions configurées dans l’agent.	Non
samples_count	entier	Nombre maximal d’échantillons de données à générer.	Oui
Sources	tableau d’OpenAI.EvalJsonlFileIdSource	Fichiers sources de contenu de données initiales facultatifs pour la génération de données.	Oui
type	enum	Type de paramètres de génération d’élément. Valeurs possibles : `synthetic_data_gen_preview`	Oui

Target

Classe de base pour les cibles avec support discriminateur.

Discriminateur pour cible

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

Type de valeur	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget

Nom	Type	Description	Obligatoire	Par défaut
type	string	Type de cible.	Oui

TargetCompletionEvalRunDataSource

Représente une source de données pour la configuration d’évaluation d’achèvement basée sur la cible.

Nom	Type	Description	Obligatoire
messages_d'entrée	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Non
└─ élément_de_référence élément_de_référence	string		Oui
└─ Type	enum	Valeurs possibles : `item_reference`	Oui
Source	OpenAI.EvalJsonlFileContentSource ou OpenAI.EvalJsonlFileIdSource	Configuration source pour les données inline ou de fichier.	Oui
target	Cible	Classe de base pour les cibles avec support discriminateur.	Oui
└─ Type	string	Type de cible.	Oui
type	enum	Type de source de données, toujours `azure_ai_target_completions`. Valeurs possibles : `azure_ai_target_completions`	Oui

TargetConfig

Classe abstraite pour la configuration cible.

Discriminateur pour TargetConfig

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

Type de valeur	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Nom	Type	Description	Obligatoire	Par défaut
type	string	Type de configuration du modèle.	Oui

TargetUpdate

Classe de base pour les cibles avec support discriminateur.

Discriminateur pour TargetUpdate

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

Type de valeur	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_agent`	AzureAIAgentTargetUpdate

Nom	Type	Description	Obligatoire	Par défaut
type	string	Type de cible.	Oui

TaxonomyCategory

Définition de la catégorie de taxonomie.

Nom	Type	Description	Obligatoire
description	string	Description de la catégorie de taxonomie.	Non
id	string	Identificateur unique de la catégorie de taxonomie.	Oui
nom	string	Nom de la catégorie de taxonomie.	Oui
properties	Objet	Propriétés supplémentaires pour la catégorie de taxonomie.	Non
riskCategory	RiskCategory	Catégorie de risque pour l’objectif d’attaque.	Oui
Sous-catégories	tableau de TaxonomySubCategory	Liste des sous-catégories de taxonomie.	Oui

TaxonomySubCategory

Définition de la sous-catégorie de taxonomie.

Nom	Type	Description	Obligatoire
description	string	Description de la sous-catégorie de taxonomie.	Non
enabled	booléen	Liste des éléments de taxonomie sous cette sous-catégorie.	Oui
id	string	Identificateur unique de la sous-catégorie de taxonomie.	Oui
nom	string	Nom de la sous-catégorie de taxonomie.	Oui
properties	Objet	Propriétés supplémentaires pour la sous-catégorie de taxonomie.	Non

ToolDescription

Description d’un outil pouvant être utilisé par un agent.

Nom	Type	Description	Obligatoire	Par défaut
description	string	Brève description de l’objectif de l’outil.	Non
nom	string	Nom de l’outil.	Non

ToolProjectConnection

Ressource de connexion project.

Nom	Type	Description	Obligatoire	Par défaut
project_connection_id	string	Connexion de projet dans un ToolProjectConnectionList attaché à cet outil.	Oui

TracesPreviewEvalRunDataSource

Représente une source de données pour les exécutions d’évaluation qui opèrent sur les traces de l’agent stockées dans Application Insights.

Nom	Type	Description	Obligatoire	Par défaut
agent_id	string	ID d’agent utilisé pour filtrer les traces pour l’évaluation.	Non
agent_name	string	Nom de l’agent utilisé pour filtrer les traces pour l’évaluation.	Non
heure de fin	entier	Horodatage Unix (en secondes) marquant la fin de la fenêtre de requête de trace. La valeur par défaut est l’heure actuelle.	Non
ingestion_delay_seconds	entier	Délai à appliquer pour l’ingestion lors de l’interrogation des traces.	Non	300
lookback_hours	entier	Fenêtre lookback (en heures) appliquée lors de la récupération de traces à partir d’Application Insights. Pour les évaluations planifiées, cela est déduit de l’intervalle de périodicité.	Non	168
max_traces	entier	Limite d’échantillonnage appliquée aux traces récupérées pour l’évaluation.	Non	1 000
trace_ids	tableau de chaînes	Collection d’identificateurs de trace de l’agent qui doivent être évalués.	Non
type	enum	Type de source de données, toujours `azure_ai_traces_preview`. Valeurs possibles : `azure_ai_traces_preview`	Oui

TreatmentEffectType

Type d’effet de traitement.

Propriété	Valeur
Description	Type d’effet de traitement.
Type	string
Valeurs	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

Modèle de base pour le déclenchement de la planification.

Discriminateur pour le déclencheur

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

Type de valeur	Schema
`Cron`	CronTrigger
`Recurrence`	RecurrenceTrigger
`OneTime`	OneTimeTrigger

Nom	Type	Description	Obligatoire	Par défaut
type	TriggerType	Type de déclencheur.	Oui

Type de déclencheur

Type de déclencheur.

Propriété	Valeur
Description	Type de déclencheur.
Type	string
Valeurs	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Nom	Type	Description	Obligatoire
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
manifest_id	string	ID de manifeste à partir duquel importer la version de l’agent.	Oui
Métadonnées	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.	Non
parameter_values	Objet	Entrées du manifeste qui entraînent un agent entièrement matérialisé.	Oui

UpdateAgentRequest

Nom	Type	Description	Obligatoire
Définition	AgentDefinition		Oui
Type └	AgentKind		Oui
└rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
description	string	Description lisible de l’agent. Contraintes : maxLength : 512	Non
Métadonnées	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.	Non

UpdateEvalParametersBody

Nom	Type	Description	Obligatoire
Métadonnées	OpenAI.Metadata (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.	Non
nom	string		Non
properties	Objet	Ensemble de paires clé-valeur immuables de 16 qui peuvent être attachées à un objet pour stocker des informations supplémentaires. Les clés sont des chaînes dont la longueur maximale est de 64 caractères. Les valeurs sont des chaînes dont la longueur maximale est de 512 caractères.	Non

UserProfileMemoryItem

Élément de mémoire contenant spécifiquement des informations de profil utilisateur extraites des conversations, telles que les préférences, les intérêts et les détails personnels.

Nom	Type	Description	Obligatoire
contenu	string	Le contenu de la mémoire.	Oui
kind	enum	Type de l’élément de mémoire. Valeurs possibles : `user_profile`	Oui
memory_id	string	ID unique de l’élément de mémoire.	Oui
scope	string	Espace de noms qui regroupe et isole logiquement les mémoires, tel qu’un ID utilisateur.	Oui
updated_at	entier	Heure de la dernière mise à jour de l’élément de mémoire.	Oui

WebSearchConfiguration

Configuration de recherche web pour bing recherche personnalisée

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

WeeklyRecurrenceSchedule

Calendrier de récurrence hebdomadaire.

Nom	Type	Description	Obligatoire	Par défaut
joursDeSemaine	tableau de DayOfWeek	Jours de la semaine pour la planification de périodicité.	Oui
type	enum	Type de périodicité hebdomadaire. Valeurs possibles : `Weekly`	Oui

WorkflowActionOutputItem

Nom	Type	Description	Obligatoire
action_id	string	Identificateur unique de l’action.	Oui
agent_reference	AgentReference		Non
└─ Nom	string	Nom de l’agent. Contraintes : maxLength : 256	Oui
└─ Type	enum	Valeurs possibles : `agent_reference`	Oui
└─ Version	string	Identificateur de version de l’agent.	Non
kind	string	Type d’action CSDL (par exemple, « SetVariable », « InvokeAzureAgent »).	Oui
parent_action_id	string	ID de l’action parente s’il s’agit d’une action imbriquée.	Non
previous_action_id	string	ID de l’action précédente si cette action suit une autre.	Non
response_id	string	Réponse sur laquelle l’élément est créé.	Non
status	enum	État de l’action (par exemple, « in_progress », « terminé », « échec », « annulé »). Valeurs possibles : `completed`, , `failedin_progress`,`cancelled`	Oui
type	enum	Valeurs possibles : `workflow_action`	Oui

WorkflowAgentDefinition

Définition de l’agent de workflow.

Nom	Type	Description	Obligatoire
kind	enum	Valeurs possibles : `workflow`	Oui
rai_config	RaiConfig	Configuration pour les fonctions de filtrage de contenu et de sécurité RAI (Responsible AI).	Non
└rai_policy_name	string	Nom de la stratégie RAI à appliquer.	Oui
flux de travail	string	Définition YAML CSDL du flux de travail.	Non

entier

Type : entier

Format : int64

Dernière mise à jour : 2026-06-12