Azure OpenAI réponses

Version de l’API : v1

Server :{endpoint}/openai/v1 — API Azure AI Foundry Models

Variables serveur :

Variable	Par défaut	Description
endpoint		Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).

Authentication

ApiKeyAuth (clé API)

Passez votre clé API dans l’en-tête api-key .

ApiKeyAuth_ (clé API)

Passez votre clé API dans l’en-tête authorization .

OAuth2Auth (OAuth 2.0)

Flux : implicite

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

Étendues:

https://cognitiveservices.azure.com/.default

Spécifications de sécurité

Les points d’accès acceptent l’une des méthodes d’authentification suivantes :

ApiKeyAuth
ApiKeyAuth_
OAuth2Auth (lunettes : https://cognitiveservices.azure.com/.default)

Créer une réponse

POST {endpoint}/openai/v1/responses

Crée un modèle de réponse.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
version de l'API	query	Non	string Valeurs possibles : `v1`, `preview`	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. `v1` sauf indication contraire.

Corps de la requête

Content-Type : application/json

Nom	Type	Description	Obligatoire
Arrière-plan	booléen ou null		Non
context_management	array d’OpenAI.ContextManagementParam ou null	Configuration de gestion de contexte pour cette requête.	Non
conversation	OpenAI.ConversationParam ou null		Non
Inclure	tableau d’OpenAI.IncludeEnum ou null		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 fichiers - État de conversation - Appel de fonction	Non
Instructions	chaîne ou null		Non
max_output_tokens	entier ou null		Non
max_tool_calls	entier ou null		Non
Métadonnées	OpenAI.Metadata ou null		Non
model	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	Non
parallel_tool_calls	booléen ou null		Non
previous_response_id	chaîne ou null		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
prompt_cache_retention	chaîne ou null		Non
reasoning	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	Non
boutique	booléen ou null		Non
stream	booléen ou null		Non
stream_options	OpenAI.ResponseStreamOptions ou null		Non
Température	nombre ou null		Non
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. Les deux catégories d’outils que vous pouvez fournir sont les suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche de fichiers. - Appels de fonction (outils personnalisés) : fonctions définies par vous, qui active le modèle pour qu’il appelle votre propre code.	Non
top_logprobs	entier ou null		Non
top_p	nombre ou null		Non
truncation	chaîne ou null		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.	Non

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Objet
text/event-stream	Objet

Nom	Type	Description	Obligatoire	Par défaut
Arrière-plan	booléen ou null		Non
terminé_à	chaîne ou null		Non
content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
conversation	OpenAI.ConversationReference ou null		Non
date_de_création	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
erreur	OpenAI.ResponseError ou null		Oui
id	string	Identificateur unique pour cette réponse.	Oui
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Oui
Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
max_output_tokens	entier ou null		Non
max_tool_calls	entier ou null		Non
Métadonnées	OpenAI.Metadata ou null		Non
model	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
prompt_cache_retention	chaîne ou null		Non
reasoning	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		Non
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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
top_logprobs	entier ou null		Non
top_p	nombre ou null		Non
truncation	chaîne ou null		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.	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Obligatoire
code	chaîne ou null	Oui
inner_error		Non
message	string	Oui
param	chaîne ou null	Non
type	string	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Examples

Example

Créer une réponse de modèle

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

Obtenir la réponse

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

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

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
version de l'API	query	Non	string Valeurs possibles : `v1`, `preview`	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. `v1` sauf indication contraire.
response_id	path	Oui	string
include[]	query	Non	tableau	Champs supplémentaires à inclure dans la réponse. Pour plus d’informations, consultez le paramètre Include pour la création de réponse ci-dessus.
stream	query	Non	booléen	Si la valeur est true, les données de réponse du modèle sont transmises au client au fur et à mesure qu’elles sont générées à l’aide d’événements envoyés par le serveur. Sérialisation : exploser : faux
starting_after	query	Non	entier (int32)	Numéro de séquence de l’événement après lequel démarrer la diffusion en continu. Sérialisation : exploser : faux
include_obfuscation	query	Non	booléen	Lorsque la valeur est true, l’obfuscation de flux est activée. L’obfuscation de flux ajoute des caractères aléatoires à un `obfuscation` champ sur les événements delta de diffusion en continu pour normaliser 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 surcharge au flux de données. Vous pouvez définir `include_obfuscation` la valeur false pour optimiser la bande passante si vous approuvez les liens réseau entre votre application et l’API OpenAI. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Description	Obligatoire	Par défaut
Arrière-plan	booléen ou null		Non
terminé_à	chaîne ou null		Non
content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
conversation	OpenAI.ConversationReference ou null		Non
date_de_création	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
erreur	OpenAI.ResponseError ou null		Oui
id	string	Identificateur unique pour cette réponse.	Oui
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Oui
Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
max_output_tokens	entier ou null		Non
max_tool_calls	entier ou null		Non
Métadonnées	OpenAI.Metadata ou null		Non
model	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
prompt_cache_retention	chaîne ou null		Non
reasoning	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		Non
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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
top_logprobs	entier ou null		Non
top_p	nombre ou null		Non
truncation	chaîne ou null		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.	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Obligatoire
code	chaîne ou null	Oui
inner_error		Non
message	string	Oui
param	chaîne ou null	Non
type	string	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Supprimer la réponse

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

Supprime une réponse par ID.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
version de l'API	query	Non	string Valeurs possibles : `v1`, `preview`	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. `v1` sauf indication contraire.
response_id	path	Oui	string

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Description	Obligatoire
supprimé	enum	Valeurs possibles : `True`	Oui
id	string		Oui
Objet	enum	Valeurs possibles : `response.deleted`	Oui

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Obligatoire
code	chaîne ou null	Oui
inner_error		Non
message	string	Oui
param	chaîne ou null	Non
type	string	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Annuler la réponse

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

Annule une réponse de modèle avec l’ID donné. Seules les réponses créées avec le paramètre d’arrière-plan défini sur true peuvent être annulées.

Paramètres d’URI

Nom	In	Obligatoire	Type	Description
endpoint	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
version de l'API	query	Non	string Valeurs possibles : `v1`, `preview`	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. `v1` sauf indication contraire.
response_id	path	Oui	string

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Description	Obligatoire	Par défaut
Arrière-plan	booléen ou null		Non
terminé_à	chaîne ou null		Non
content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
conversation	OpenAI.ConversationReference ou null		Non
date_de_création	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
erreur	OpenAI.ResponseError ou null		Oui
id	string	Identificateur unique pour cette réponse.	Oui
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Oui
Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
max_output_tokens	entier ou null		Non
max_tool_calls	entier ou null		Non
Métadonnées	OpenAI.Metadata ou null		Non
model	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
prompt_cache_retention	chaîne ou null		Non
reasoning	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		Non
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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
top_logprobs	entier ou null		Non
top_p	nombre ou null		Non
truncation	chaîne ou null		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.	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Obligatoire
code	chaîne ou null	Oui
inner_error		Non
message	string	Oui
param	chaîne ou null	Non
type	string	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

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	server	Oui	string	Un point de terminaison pris en charge par les API Azure AI Foundry Models, incluant le protocole et le nom d’hôte. Par exemple: `https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/`).
version de l'API	query	Non	string Valeurs possibles : `v1`, `preview`	Version explicite de l’API Azure AI Foundry Models à utiliser pour cette requête. `v1` sauf indication contraire.
response_id	path	Oui	string
limit	query	Non	entier (int32)	Limite du nombre d’objets à renvoyer. La limite peut être comprise entre 1 et 100, et la valeur par défaut est 20. Sérialisation : exploser : faux
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. Sérialisation : exploser : faux
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. Sérialisation : exploser : faux
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. Sérialisation : exploser : faux

Responses

Code de statut : 200

Description : la requête a bien abouti.

Type de contenu	Type	Description
application/json	OpenAI.ResponseItemList

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Code de statut : par défaut

Description : réponse d’erreur inattendue.

Type de contenu	Type	Description
application/json	Objet

Nom	Type	Obligatoire
code	chaîne ou null	Oui
inner_error		Non
message	string	Oui
param	chaîne ou null	Non
type	string	Non

En-têtes de réponse :

En-tête	Type	Description
apim-request-id	string	ID de demande utilisé à des fins de résolution des problèmes.

Components

AzureAIFoundryModelsApiVersion

Propriété	Valeur
Type	string
Valeurs	`v1` `preview`

AzureContentFilterBlocklistResult

Collection de résultats de filtrage true/false pour les listes de blocs personnalisées configurées.

Nom	Type	Description	Obligatoire	Par défaut
details	tableau d’objet	Les paires d’ID individuels de liste de blocage et si elles ont entraîné une action de filtrage.	Non
filtered	booléen	Valeur indiquant si l’une des listes de blocs détaillées a entraîné une action de filtrage.	Oui

AzureContentFilterCompletionTextSpan

Représentation d’un segment de texte de complétion tel qu'utilisé dans les résultats du filtre de contenu d'Azure OpenAI.

Nom	Type	Description	Obligatoire	Par défaut
completion_end_offset	entier (int32)	Décalage du premier point de code UTF32 exclu de l’étendue. Ce champ est toujours égal à completion_start_offset pour les portées vides. Ce champ est toujours supérieur à completion_start_offset pour les étendues non vides.	Oui
completion_start_offset	entier (int32)	Décalage du point de code UTF32 qui commence la portée.	Oui

AzureContentFilterCompletionTextSpanDetectionResult

Nom	Type	Description	Obligatoire
details	tableau d’AzureContentFilterCompletionTextSpan	Des informations détaillées sur les segments de texte détectés lors de l’achèvement.	Oui
détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
filtered	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui

AzureContentFilterCustomTopicResult

Collection de résultats de filtrage true/false pour les rubriques personnalisées configurées.

Nom	Type	Description	Obligatoire	Par défaut
details	tableau d’objet	Paires d’ID de rubriques individuelles et détections.	Non
filtered	booléen	Valeur indiquant si l’une des rubriques détaillées a entraîné une action de filtrage.	Oui

AzureContentFilterDetectionResult

Élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été détecté et si le contenu a été filtré.

Nom	Type	Description	Obligatoire	Par défaut
détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
filtered	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui

AzureContentFilterForResponsesAPI

Nom	Type	Description	Obligatoire
Bloqué	booléen	Indiquez si la réponse est bloquée.	Oui
content_filter_offsets	AzureContentFilterResultOffsets		Oui
content_filter_results	AzureContentFilterResultsForResponsesAPI		Oui
└─ listes_de_bloc_personnalisées	AzureContentFilterBlocklistResult	Collection de résultats de filtrage binaire pour les listes de blocs personnalisées configurées.	Non
└custom_topics	AzureContentFilterCustomTopicResult	Collection de résultats de filtrage binaire pour les rubriques personnalisées configurées.	Non
Erreur └ ;	Objet	S’ils sont présents, des détails sur une erreur qui empêche le filtrage du contenu de finaliser son évaluation.	Non
└─ Code	entier (int32)	Code distinct lisible par l’ordinateur associé à l’erreur.	Oui
└─ Message	string	Message lisible par l’homme associé à l’erreur.	Oui
└─ haine	AzureContentFilterSeverityResult	Catégorie de filtre de contenu qui peut faire référence à n’importe quel contenu qui attaque ou utilise des données dimensionnelles ou discriminatoires langue faisant référence à une personne ou à un groupe d’identités en fonction de certains attributs de différenciation de ces groupes y compris, mais pas limité à la race, l’ethnicité, la nationalité, l’identité de genre et l’expression, l’orientation sexuelle, religion, statut d’immigration, statut de capacité, apparence personnelle et taille du corps.	Non
└─ attaque_indirecte	AzureContentFilterDetectionResult	Résultat de détection qui décrit les attaques sur les systèmes alimentés par des modèles IA génératifs qui peuvent se produire à chaque fois une application traite les informations qui n’ont pas été créées directement par le développeur de l’application ou utilisateur.	Non
└' jailbreak	AzureContentFilterDetectionResult	Résultat de détection qui décrit les attaques d’injection d’invite utilisateur, où les utilisateurs malveillants exploitent délibérément vulnérabilités système pour provoquer un comportement non autorisé à partir du LLM. Cela peut entraîner un contenu inapproprié génération ou violations des restrictions imposées par le système.	Oui
└personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Résultat de détection qui décrit les correspondances avec les informations d’identification personnelle avec des sous-catégories configurables.	Non
└> profanéité	AzureContentFilterDetectionResult	Résultat de détection qui identifie si le langage brut, vulgaire ou autre est présent dans la langue Contenu.	Non
└protected_material_code	Objet	Résultat de détection qui décrit une correspondance avec le code sous licence ou d’autres documents sources protégés.	Non
└─ citation	Objet	Si disponibles, les détails de la citation qui décrivent la licence associée et son emplacement.	Non
└─ URL	chaîne (uri)	URL associée à la licence.	Non
└─ licence	string	Nom ou identificateur de la licence associée à la détection.	Non
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
└protected_material_text	AzureContentFilterDetectionResult	Résultat de détection qui décrit une correspondance avec le texte protégé sous le droit d’auteur ou un autre état.	Non
└─ automutilation	AzureContentFilterSeverityResult	Catégorie de filtre de contenu qui décrit la langue liée aux actions physiques destinées à blesser, blesser, endommager son corps ou se tuer.	Non
└─ sexuelle	AzureContentFilterSeverityResult	Catégorie de filtre de contenu pour la langue liée aux organes anatomiques et aux organes génitaux, relations romantiques, actes représentées en termes érotiques ou affectueux, grossesse, actes sexuels physiques, y compris ceux présentés comme un agression ou acte violent sexuel forcé contre la volonté, la prostitution, la pornographie et l’abus.	Non
└task_adherence	AzureContentFilterDetectionResult	Résultat de détection qui indique si le flux d’exécution reste fidèle au plan.	Oui
└ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Non
└─ Violence	AzureContentFilterSeverityResult	Catégorie de filtre de contenu pour la langue liée aux actions physiques destinées à blesser, blesser, endommager ou tuer quelqu’un ou quelque chose ; décrit les armes, les armes à feu et les entités connexes, telles que les fabrications, les associations, législation, et ainsi de suite.	Non
source_type	string	Nom du type source du message.	Oui
tool_call_id	string	L’ID de l’appel d’outil associé à ce filtre de contenu, le résultat est applicable.	Non

AzureContentFilterPersonallyIdentifiableInformationResult

Résultat de la détection de filtre de contenu pour les informations d’identification personnelle qui incluent des extensions de préjudice.

Nom	Type	Description	Obligatoire
détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
filtered	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
redacted_text	string	Texte rédigé avec des informations d’identification personnelle supprimées ou masquées.	Non
sub_categories	tableau d’AzurePiiSubCategoryResult	Résultats détaillés pour l’individu PIIHarmSubCategory(s).	Non

AzureContentFilterResultOffsets

Nom	Type	Obligatoire
check_offset	entier (int32)	Oui
end_offset	entier (int32)	Oui
start_offset	entier (int32)	Oui

AzureContentFilterResultsForResponsesAPI

Nom	Type	Description	Obligatoire
custom_blocklists	AzureContentFilterBlocklistResult	Collection de résultats de filtrage true/false pour les listes de blocs personnalisées configurées.	Non
└─ détails	tableau d’objet	Les paires d’ID individuels de liste de blocage et si elles ont entraîné une action de filtrage.	Non
└> filtré	booléen	Valeur indiquant si la liste de blocs a produit une action de filtrage.	Oui
└─ identifiant	string	ID de la liste de blocs personnalisée évaluée.	Oui
└> filtré	booléen	Valeur indiquant si l’une des listes de blocs détaillées a entraîné une action de filtrage.	Oui
custom_topics	AzureContentFilterCustomTopicResult	Collection de résultats de filtrage true/false pour les rubriques personnalisées configurées.	Non
└─ détails	tableau d’objet	Paires d’ID de rubriques individuelles et détections.	Non
└─ détecté	booléen	Valeur indiquant si la rubrique est détectée.	Oui
└─ identifiant	string	ID de la rubrique personnalisée évaluée.	Oui
└> filtré	booléen	Valeur indiquant si l’une des rubriques détaillées a entraîné une action de filtrage.	Oui
erreur	Objet	S’ils sont présents, des détails sur une erreur qui empêche le filtrage du contenu de finaliser son évaluation.	Non
└─ Code	entier (int32)	Code distinct lisible par l’ordinateur associé à l’erreur.	Oui
└─ Message	string	Message lisible par l’homme associé à l’erreur.	Oui
Déteste	AzureContentFilterSeverityResult	Élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été filtré et quelle est la qualité niveau de gravité du contenu, tel qu’évalué par rapport à la configuration du filtre de contenu pour la catégorie.	Non
└> filtré	booléen	Indique si la gravité du contenu a entraîné une action de filtrage de contenu.	Oui
└─ Sévérité	enum	La gravité étiquetée du contenu. Valeurs possibles : `safe`, , `lowmedium`,`high`	Oui
indirect_attack	AzureContentFilterDetectionResult	Un élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été détecté et si le contenu a été filtré.	Non
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
jailbreak	AzureContentFilterDetectionResult	Un élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été détecté et si le contenu a été filtré.	Oui
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
personally_identifiable_information	AzureContentFilterPersonallyIdentifiableInformationResult	Résultat de la détection de filtre de contenu pour les informations d’identification personnelle qui incluent des extensions de préjudice.	Non
└redacted_text	string	Texte rédigé avec des informations d’identification personnelle supprimées ou masquées.	Non
└─ sub-catégories	tableau d’AzurePiiSubCategoryResult	Résultats détaillés pour l’individu PIIHarmSubCategory(s).	Non
Blasphème	AzureContentFilterDetectionResult	Un élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été détecté et si le contenu a été filtré.	Non
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
protected_material_code	Objet	Résultat de détection qui décrit une correspondance avec le code sous licence ou d’autres documents sources protégés.	Non
└─ citation	Objet	Si disponibles, les détails de la citation qui décrivent la licence associée et son emplacement.	Non
└─ URL	chaîne (uri)	URL associée à la licence.	Non
└─ licence	string	Nom ou identificateur de la licence associée à la détection.	Non
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
protected_material_text	AzureContentFilterDetectionResult	Un élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été détecté et si le contenu a été filtré.	Non
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
self_harm	AzureContentFilterSeverityResult	Élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été filtré et quelle est la qualité niveau de gravité du contenu, tel qu’évalué par rapport à la configuration du filtre de contenu pour la catégorie.	Non
└> filtré	booléen	Indique si la gravité du contenu a entraîné une action de filtrage de contenu.	Oui
└─ Sévérité	enum	La gravité étiquetée du contenu. Valeurs possibles : `safe`, , `lowmedium`,`high`	Oui
Sexuelle	AzureContentFilterSeverityResult	Élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été filtré et quelle est la qualité niveau de gravité du contenu, tel qu’évalué par rapport à la configuration du filtre de contenu pour la catégorie.	Non
└> filtré	booléen	Indique si la gravité du contenu a entraîné une action de filtrage de contenu.	Oui
└─ Sévérité	enum	La gravité étiquetée du contenu. Valeurs possibles : `safe`, , `lowmedium`,`high`	Oui
task_adherence	AzureContentFilterDetectionResult	Un élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été détecté et si le contenu a été filtré.	Oui
└─ détecté	booléen	Indique si la catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
└> filtré	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu.	Oui
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Non
violence	AzureContentFilterSeverityResult	Élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été filtré et quelle est la qualité niveau de gravité du contenu, tel qu’évalué par rapport à la configuration du filtre de contenu pour la catégorie.	Non
└> filtré	booléen	Indique si la gravité du contenu a entraîné une action de filtrage de contenu.	Oui
└─ Sévérité	enum	La gravité étiquetée du contenu. Valeurs possibles : `safe`, , `lowmedium`,`high`	Oui

AzureContentFilterSeverityResult

Élément de résultat du filtre de contenu étiqueté qui indique si le contenu a été filtré et quel niveau de gravité qualitative du contenu a été évalué par rapport à la configuration du filtre de contenu pour la catégorie.

Nom	Type	Description	Obligatoire	Par défaut
filtered	booléen	Indique si la gravité du contenu a entraîné une action de filtrage de contenu.	Oui
severity	enum	La gravité étiquetée du contenu. Valeurs possibles : `safe`, , `lowmedium`,`high`	Oui

AzurePiiSubCategoryResult

Détails des résultats pour l’individu PIIHarmSubCategory(s).

Nom	Type	Description	Obligatoire
détecté	booléen	Indique si la sous-catégorie de contenu étiquetée a été détectée dans le contenu.	Oui
filtered	booléen	Indique si la détection de contenu a entraîné une action de filtrage de contenu pour cette sous-catégorie.	Oui
Expurgée	booléen	Indique si le contenu a été adopté pour cette sous-catégorie.	Oui
sub_category	string	PIIHarmSubCategory qui a été évalué.	Oui

AzureToolApprovalRequest

Demande d’approbation de l’outil Azure

Une demande d’approbation d’outil Azure dans la sortie de la réponse.

Nom	Type	Description	Obligatoire
Arguments	string	Chaîne JSON d’arguments pour l’outil.	Oui
call_id	string	L’identifiant de l’appel à l’outil nécessite une approbation.	Oui
id	string	ID unique de la demande d’approbation.	Oui
label	string	L’étiquette de l’outil (par exemple, « remote_functions »).	Oui
nom	string	Le nom de la fonction de l’outil (par exemple, « output_binding »).	Oui
type	enum	Type de l’élément. A toujours la valeur `tool_approval_request`. Valeurs possibles : `tool_approval_request`	Oui

AzureToolApprovalResponse

Réponse d’approbation de l’outil Azure

Une réponse d’approbation de l’outil Azure dans l’entrée de la requête.

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
type	enum	Type de l’élément. A toujours la valeur `tool_approval_response`. Valeurs possibles : `tool_approval_response`	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

Appliquer l’état de sortie de l’appel de patch

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

Appliquer le statut d’appel de patch

Valeurs d’état signalées pour les appels d’outils apply_patch.

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Appliquer l’opération de création de fichier correctif

Instructions décrivant comment créer un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire	Par défaut
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	create_file

OpenAI.ApplyPatchCreateFileOperationParam

Appliquer l’opération de création de fichier correctif

Instructions pour la création d’un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire	Par défaut
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	create_file

OpenAI.ApplyPatchDeleteFileOperation

Appliquer l’opération de suppression de fichier correctif

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	delete_file

OpenAI.ApplyPatchDeleteFileOperationParam

Appliquer l’opération de suppression de fichier correctif

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	delete_file

OpenAI.ApplyPatchFileOperation

Appliquer l’opération de patch

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

Appliquer l’opération de patch

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

Appliquer l’outil de patch

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	apply_patch

OpenAI.ApplyPatchUpdateFileOperation

Appliquer l’opération de mise à jour du fichier de patch

Instructions décrivant comment mettre à jour un fichier via l’outil apply_patch.

Nom	Type	Description	Obligatoire	Par défaut
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	update_file

OpenAI.ApplyPatchUpdateFileOperationParam

Appliquer l’opération de mise à jour du fichier de patch

Instructions pour mettre à jour un fichier existant via l’outil apply_patch.

Nom	Type	Description	Obligatoire	Par défaut
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	update_file

OpenAI.ApproximateLocation

Nom	Type	Description	Obligatoire	Par défaut
Ville	chaîne ou null		Non
country	chaîne ou null		Non
region	chaîne ou null		Non
timezone	chaîne ou null		Non
type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Oui	Approximative

OpenAI.AutoCodeInterpreterToolParam

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

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

Nom	Type	Description	Obligatoire	Par défaut
identifiants_de_fichiers	tableau de chaînes	Une liste facultative de fichiers chargés à mettre au service de votre code. Contraintes : maxObjets : 50	Non
limite_de_mémoire	OpenAI.ContainerMemoryLimit ou null		Non
network_policy	OpenAI.ContainerNetworkPolicyParam	Politique d’accès réseau pour le conteneur.	Non
type	enum	A toujours la valeur `auto`. Valeurs possibles : `auto`	Oui	auto

OpenAI.ClickButtonType

Propriété	Valeur
Type	string
Valeurs	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

Click

Action de clic.

Nom	Type	Description	Obligatoire	Par défaut
Bouton	OpenAI.ClickButtonType		Oui
keys	tableau de chaînes ou null		Non
type	enum	Spécifie le type d’événement. Pour une action de clic, cette propriété est toujours `click`. Valeurs possibles : `click`	Oui	cliquez
x	entier	Coordonnée x où le clic s’est produit.	Oui
y	entier	Coordonnée y où le clic s’est produit.	Oui

OpenAI.CodeInterpreterOutputImage

Image de sortie de l’interpréteur de code

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	image
url	chaîne (uri)	URL de la sortie de l’image à partir de l’interpréteur de code.	Oui

OpenAI.CodeInterpreterOutputLogs

Journaux de sortie de l’interpréteur de code

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	logs

OpenAI.CodeInterpreterTool

Interpréteur de code

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	ou OpenAI.AutoCodeInterpreterToolParam	Conteneur d’interpréteur de code. Il peut s’agir d’un ID de conteneur ou d’un objet qui spécifie les ID de fichier chargés à mettre à la disposition de votre code, ainsi qu’un paramètre facultatif `memory_limit` .	Oui
type	enum	Type de l’outil d’interpréteur de code. A toujours la valeur `code_interpreter`. Valeurs possibles : `code_interpreter`	Oui

OpenAI.ComparisonFilter

Filtre de comparaison

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

Nom	Type	Description	Obligatoire	Par défaut
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`, , `ne`, `gtgteltlte`, , `innin`	Oui	eq
value	chaîne ou nombre ou booléen ou tableau de chaîne ou nombre	Valeur à comparer à la clé d’attribut ; prend en charge les types chaîne, nombre ou booléen.	Oui

OpenAI.CompoundFilter

Filtre composé

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.DragParam
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.MoveParam
`screenshot`	OpenAI.ScreenshotParam
`scroll`	OpenAI.ScrollParam
`type`	OpenAI.TypeParam
`wait`	OpenAI.WaitParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ComputerActionType		Oui

OpenAI.ComputerActionList

Liste d’actions informatiques

Actions en lots aplaties pour computer_use. Chaque action comprend un type discriminateur et des champs spécifiques à chaque action.

Éventail de : OpenAI.ComputerAction

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 ou null		Non
id	string	ID de la vérification de sécurité en attente.	Oui
message	chaîne ou null		Non

OpenAI.ComputerEnvironment

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

OpenAI.ComputerScreenshotContent

Capture d’écran informatique

Capture d’écran d’un ordinateur.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne ou null		Oui
image_url	chaîne ou null		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	computer_screenshot

OpenAI.ComputerScreenshotImage

Image de capture d’écran d’ordinateur utilisée avec l’outil d’utilisation de l’ordinateur.

Nom	Type	Description	Obligatoire	Par défaut
identifiant_de_fichier	string	Identificateur d’un fichier chargé qui contient la capture d’écran.	Non
image_url	chaîne (uri)	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	computer_screenshot

OpenAI.ComputerTool

Ordinateur

Outil qui contrôle un ordinateur virtuel.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Le type d’outil informatique. A toujours la valeur `computer`. Valeurs possibles : `computer`	Oui	Ordinateur

OpenAI.ComputerUsePreviewTool

Aperçu de l’utilisation de l’ordinateur

Outil qui contrôle un ordinateur virtuel.

Nom	Type	Description	Obligatoire	Par défaut
hauteur_affichage	entier	Hauteur de l’affichage de l’ordinateur.	Oui
largeur d'affichage	entier	Largeur de l’affichage de l’ordinateur.	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	computer_use_preview

OpenAI.ContainerAutoParam

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

OpenAI.ContainerFileCitationBody

Citation du fichier conteneur

Citation d’un fichier conteneur utilisé pour générer une réponse de modèle.

Nom	Type	Description	Obligatoire	Par défaut
container_id	string	ID du fichier conteneur.	Oui
end_index	entier	Index du dernier caractère de la citation de fichier conteneur dans le message.	Oui
identifiant_de_fichier	string	L’ID du dossier.	Oui
filename	string	Nom de fichier du fichier conteneur cité.	Oui
start_index	entier	Index du premier caractère de la citation de fichier conteneur dans le message.	Oui
type	enum	Type de la citation de fichier conteneur. A toujours la valeur `container_file_citation`. Valeurs possibles : `container_file_citation`	Oui	container_file_citation

OpenAI.ContainerMemoryLimit

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

OpenAI.ContainerNetworkPolicyAllowlistParam

Nom	Type	Description	Obligatoire	Par défaut
allowed_domains	tableau de chaînes	Une liste des domaines autorisés lorsque le type est `allowlist`. Contraintes : minObjets : 1	Oui
type	enum	Autoriser l’accès au réseau sortant uniquement à des domaines spécifiés. A toujours la valeur `allowlist`. Valeurs possibles : `allowlist`	Oui	allowlist

OpenAI.ContainerNetworkPolicyDisabledParam

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

OpenAI.ContainerNetworkPolicyParam

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

Discriminateur pour OpenAI.ContainerNetworkPolicyParam

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

Type de valeur	Schema
`disabled`	OpenAI.ContainerNetworkPolicyDisabledParam
`allowlist`	OpenAI.ContainerNetworkPolicyAllowlistParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ContainerNetworkPolicyParamType		Oui

OpenAI.ContainerNetworkPolicyParamType

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

OpenAI.ContainerReferenceResource

Référence du conteneur

Représente un conteneur créé avec des conteneurs /v1/.

Nom	Type	Description	Obligatoire	Par défaut
container_id	string		Oui
type	enum	Le type d’environnement. A toujours la valeur `container_reference`. Valeurs possibles : `container_reference`	Oui	container_reference

OpenAI.ContainerSkill

Discriminateur pour OpenAI.ContainerSkill

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

Type de valeur	Schema
`skill_reference`	OpenAI.SkillReferenceParam
`inline`	OpenAI.InlineSkillParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ContainerSkillType		Oui

OpenAI.ContainerSkillType

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

OpenAI.ContextManagementParam

Nom	Type	Description	Obligatoire	Par défaut
compact_threshold	entier ou null		Non
type	string	Le type d’entrée de gestion du contexte. Actuellement, seule la « compactation » est prise en charge.	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.

Ce composant peut être l’un des éléments suivants :

chaîne de caractères
OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Objet de conversation

Conversation à laquelle cette réponse appartient.

Nom	Type	Description	Obligatoire	Par défaut
id	string	ID unique de la conversation.	Oui

OpenAI.ConversationReference

Conversation

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.CoordParam

Coordinate

Paire de coordonnées x/y, par exemple { x: 100, y: 200 }.

Nom	Type	Description	Obligatoire	Par défaut
x	entier	Coordonnée x.	Oui
y	entier	La coordonnée y.	Oui

OpenAI.CreateResponse

Nom	Type	Description	Obligatoire
Arrière-plan	booléen ou null		Non
context_management	array d’OpenAI.ContextManagementParam ou null	Configuration de gestion de contexte pour cette requête.	Non
conversation	OpenAI.ConversationParam ou null		Non
Inclure	tableau d’OpenAI.IncludeEnum ou null		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 fichiers - État de conversation - Appel de fonction	Non
Instructions	chaîne ou null		Non
max_output_tokens	entier ou null		Non
max_tool_calls	entier ou null		Non
Métadonnées	OpenAI.Metadata ou null		Non
model	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	Non
parallel_tool_calls	booléen ou null		Non
previous_response_id	chaîne ou null		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
prompt_cache_retention	chaîne ou null		Non
reasoning	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	Non
boutique	booléen ou null		Non
stream	booléen ou null		Non
stream_options	OpenAI.ResponseStreamOptions ou null		Non
Température	nombre ou null		Non
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. Les deux catégories d’outils que vous pouvez fournir sont les suivantes : - Outils intégrés : outils fournis par OpenAI qui étendent le fonctionnalités du modèle, telles que la recherche de fichiers. - Appels de fonction (outils personnalisés) : fonctions définies par vous, qui active le modèle pour qu’il appelle votre propre code.	Non
top_logprobs	entier ou null		Non
top_p	nombre ou null		Non
truncation	chaîne ou null		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.	Non

OpenAI.CustomGrammarFormatParam

Format grammatical

Grammaire définie par l’utilisateur.

Nom	Type	Description	Obligatoire	Par défaut
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	Grammaire

OpenAI.CustomTextFormatParam

Format de texte

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	text

OpenAI.CustomToolParam

Outil personnalisé

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

Nom	Type	Description	Obligatoire	Par défaut
defer_loading	booléen	Est-ce que cet outil doit être reporté et découvert via une recherche d’outil ?	Non
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	Personnalisé

OpenAI.CustomToolParamFormat

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

Discriminateur pour OpenAI.CustomToolParamFormat

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

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.DetailEnum

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

OpenAI.DoubleClickAction

DoubleClick

L'action de double clic

Nom	Type	Description	Obligatoire	Par défaut
keys	tableau de chaînes ou null		Oui
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	double_click
x	entier	Coordonnée x où le double-clic s’est produit.	Oui
y	entier	Coordonnée y où le double-clic s’est produit.	Oui

OpenAI.DragParam

Drag

Action glisser.

Nom	Type	Description	Obligatoire	Par défaut
keys	tableau de chaînes ou null		Non
path	array d’OpenAI.CoordParam	Tableau de coordonnées représentant le parcours de l'action de glisser. Les coordonnées apparaissent sous la forme d’un tableau d’objets, par exemple `<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br>`	Oui
type	enum	Spécifie le type d’événement. Pour une action de glisser, cette propriété est toujours définie sur `drag`. Valeurs possibles : `drag`	Oui	Traînée

OpenAI.EasyInputMessage

Message d’entrée

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
Phase	OpenAI.MessagePhase ou null		Non
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.EmptyModelParam

Type : objet

OpenAI.FileCitationBody

Citation du fichier

Citation d'un fichier.

Nom	Type	Description	Obligatoire	Par défaut
identifiant_de_fichier	string	L’ID du dossier.	Oui
filename	string	Nom de fichier cité.	Oui
index	entier	Index du fichier dans la liste des fichiers.	Oui
type	enum	Type de la citation de fichier. A toujours la valeur `file_citation`. Valeurs possibles : `file_citation`	Oui	file_citation

OpenAI.FileInputDetail

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

OpenAI.FilePath

Chemin d’accès au fichier

Chemin d’accès à un fichier.

Nom	Type	Description	Obligatoire
identifiant_de_fichier	string	L’ID du dossier.	Oui
index	entier	Index du fichier dans la liste des fichiers.	Oui
type	enum	Type du chemin d’accès au fichier. A toujours la valeur `file_path`. Valeurs possibles : `file_path`	Oui

OpenAI.FileSearchTool

Recherche de fichiers

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

Nom	Type	Description	Obligatoire	Par défaut
Filtres	OpenAI.Filters ou null		Non
nombre_maximal_de_résultats	entier	Le nombre maximal de résultats à revendre. Ce nombre doit être compris entre 1 et 50 inclus.	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	Numéro	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	file_search
vector_store_ids	tableau de chaînes	ID des magasins vectoriels à rechercher.	Oui

OpenAI.FileSearchToolCallResults

Nom	Type	Obligatoire
attributes	OpenAI.VectorStoreFileAttributes ou null	Non
identifiant_de_fichier	string	Non
filename	string	Non
Résultat	Numéro (flotteur)	Non
text	string	Non

OpenAI.Filters

Type : OpenAI.ComparisonFilter ou OpenAI.CompoundFilter

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

Fichier d’entrée

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.FileInputDetail		Non
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne ou null		Non
file_url	chaîne (uri)	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	input_file

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Image d’entrée

Entrée d’image dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne ou null		Non
image_url	chaîne ou null		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui	input_image

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Texte d’entrée

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	input_text

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.FunctionCallOutputStatusEnum

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionCallStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellAction

Action des exécutifs Shell

Exécutez une commande shell.

Nom	Type	Obligatoire
commands	tableau de chaînes	Oui
max_output_length	entier ou null	Oui
timeout (délai en ms)	entier ou null	Oui

OpenAI.FunctionShellActionParam

Mécanisme de l’obus

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	entier ou null		Non
timeout (délai en ms)	entier ou null		Non

OpenAI.FunctionShellCallEnvironment

Discriminateur pour OpenAI.FunctionShellCallEnvironment

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

Type de valeur	Schema
`local`	OpenAI.LocalEnvironmentResource
`container_reference`	OpenAI.ContainerReferenceResource

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.FonctionShellAppelEnvironnementType		Oui

OpenAI.FonctionShellAppelEnvironnementType

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

OpenAI.FunctionShellCallItemParamEnvironment

L’environnement pour exécuter les commandes shell.

Discriminateur pour OpenAI.FunctionShellCallItemParamEnvironment

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

Type de valeur	Schema
`local`	OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
`container_reference`	OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.FunctionShellCallItemParamEnvironmentType		Oui

OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam

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

OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam

Nom	Type	Description	Obligatoire	Par défaut
compétences	tableau d’OpenAI.LocalSkillParam	Une liste optionnelle de compétences. Contraintes : maxObjets : 200	Non
type	enum	Utilisez un environnement informatique local. Valeurs possibles : `local`	Oui	locale

OpenAI.FunctionShellCallItemParamEnvironmentType

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

OpenAI.FunctionShellCallItemStatus

Statut de l’appel shell

Valeurs d’état signalées pour les appels d’outil shell.

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Contenu de sortie des appels de shell

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

Contenu de sortie en shell

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

Résultat de sortie des appels shell

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	entier	Quittez le code du processus d’interpréteur de commandes.	Oui
type	enum	Type de résultat. A toujours la valeur `exit`. Valeurs possibles : `exit`	Oui	exit

OpenAI.FunctionShellCallOutputExitOutcomeParam

Résultat de sortie des appels shell

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	entier	Le code de sortie est retourné par le processus shell.	Oui
type	enum	Type de résultat. A toujours la valeur `exit`. Valeurs possibles : `exit`	Oui	exit

OpenAI.FunctionShellCallOutputOutcome

Résultat de l’appel shell

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 l’appel shell

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.FunctionShellCallOutputStatusEnum

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Résultat du temps d’arrêt de l’appel shell

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	timeout

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Résultat du temps d’arrêt de l’appel shell

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	timeout

OpenAI.FunctionShellCallStatus

Propriété	Valeur
Type	string
Valeurs	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellToolParam

Outil coque

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

Nom	Type	Description	Obligatoire	Par défaut
environment	OpenAI.FunctionShellToolParamEnvironment ou null		Non
type	enum	Type de l’outil shell. A toujours la valeur `shell`. Valeurs possibles : `shell`	Oui	shell

OpenAI.FunctionShellToolParamEnvironment

Discriminateur pour OpenAI.FunctionShellToolParamEnvironment

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

Type de valeur	Schema
`local`	OpenAI.FunctionShellToolParamEnvironnementLocalEnvironnementParam
`container_reference`	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
`container_auto`	OpenAI.ContainerAutoParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.FunctionShellToolParamEnvironmentType		Oui

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

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

OpenAI.FunctionShellToolParamEnvironnementLocalEnvironnementParam

Nom	Type	Description	Obligatoire	Par défaut
compétences	tableau d’OpenAI.LocalSkillParam	Une liste optionnelle de compétences. Contraintes : maxObjets : 200	Non
type	enum	Utilisez un environnement informatique local. Valeurs possibles : `local`	Oui	locale

OpenAI.FunctionShellToolParamEnvironmentType

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

OpenAI.FunctionTool

Fonction

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

Nom	Type	Description	Obligatoire	Par défaut
defer_loading	booléen	Si cette fonction est différée et chargée via la recherche d’outils.	Non
description	chaîne ou null		Non
nom	string	Nom de la fonction à appeler.	Oui
parameters	objet ou null		Oui
strict	booléen ou null		Oui
type	enum	Type de l’outil de fonction. A toujours la valeur `function`. Valeurs possibles : `function`	Oui	function

OpenAI.FunctionToolParam

Nom	Type	Description	Obligatoire	Par défaut
defer_loading	booléen	Si cette fonction doit être différée et découverte via une recherche d’outils.	Non
description	chaîne ou null		Non
nom	string	Contraintes : minLongueur : 1, maxLongueur : 128, motif : `^[a-zA-Z0-9_-]+$`	Oui
parameters	OpenAI.EmptyModelParam ou null		Non
strict	booléen ou null		Non
type	enum	Valeurs possibles : `function`	Oui	function

OpenAI.GrammarSyntax1

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

OpenAI.HybridSearchOptions

Nom	Type	Description	Obligatoire	Par défaut
embedding_weight	Numéro	Poids de l’incorporation dans la fusion de classement réciproque.	Oui
text_weight	Numéro	Poids du texte dans la fusion de classement réciproque.	Oui

OpenAI.ImageDetail

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

OpenAI.ImageGenActionEnum

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

OpenAI.ImageGenTool

Outil de génération d’images

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

Modèles valides :

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

Nom	Type	Description	Obligatoire	Par défaut
action	OpenAI.ImageGenActionEnum		Non
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	auto
input_fidelity	OpenAI.InputFidelity ou null		Non
masque_d'image_d'entrée	OpenAI.ImageGenToolInputImageMask		Non
└ file_id	string		Non
└ image_url	chaîne (uri)		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	auto
compression_de_sortie	entier	Niveau de compression de l’image de sortie. Valeur par défaut : 100. Contraintes : min : 0, max : 100	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	png
images partielles	entier	Nombre d’images partielles à générer en mode streaming, de 0 (valeur par défaut) à 3. Contraintes : min : 0, max : 3	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	auto
size	chaîne (voir les modèles valides ci-dessous)	Taille des images générées. Pour `gpt-image-2` et `gpt-image-2-2026-04-21`, des résolutions arbitraires sont supportées sous forme `WIDTHxHEIGHT` de chaînes, par exemple `1536x864`. La largeur et la hauteur doivent toutes deux être divisibles par 16 et le rapport d’aspect demandé doit être compris entre 1:3 et 3:1. Les résolutions ci-dessus `2560x1440` sont expérimentales, et la résolution maximale supportée est `3840x2160`. La taille demandée doit également satisfaire aux limites actuelles de pixels et d’arêtes du modèle. Les tailles `1024x1024`standard , `1536x1024`, et `1024x1536` sont prises en charge par les modèles d’image GPT ; `auto` est pris en charge pour les modèles permettant le dimensionnement automatique. Pour `dall-e-2`, utilisez l’un des `256x256`, `512x512`, ou `1024x1024`. Pour `dall-e-3`, utilisez l’un des `1024x1024`, `1792x1024`, ou `1024x1792`.	Non
type	enum	Type de l’outil de génération d’images. A toujours la valeur `image_generation`. Valeurs possibles : `image_generation`	Oui	image_generation

OpenAI.ImageGenToolInputImageMask

Nom	Type	Description	Obligatoire	Par défaut
identifiant_de_fichier	string		Non
image_url	chaîne (uri)		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.results: Inclure les résultats de recherche de l’outil de recherche web.
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.results`: Inclure les résultats de recherche de l’outil de recherche web. - `web_search_call.action.sources`: Inclure les sources de l’outil de recherche web appelé. - `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, dans les sorties des éléments de raisonnement, une version chiffrée des jetons 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	string
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`

OpenAI.InlineSkillParam

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

OpenAI.InlineSkillSourceParam

Charge utile de compétences en ligne

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

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

Fichier d’entrée

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.FileInputDetail		Non
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne ou null		Non
file_url	chaîne (uri)	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	input_file

OpenAI.InputContentInputImageContent

Image d’entrée

Entrée d’image dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne ou null		Non
image_url	chaîne ou null		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui	input_image

OpenAI.InputContentInputTextContent

Texte d’entrée

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	input_text

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 et gpt-image-1.5 et les modèles ultérieurs, 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

Fichier d’entrée

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.FileInputDetail		Non
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne ou null		Non
file_url	chaîne (uri)	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	input_file

OpenAI.InputFileContentParam

Fichier d’entrée

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.FileInputDetail		Non
file_data	chaîne ou null		Non
identifiant_de_fichier	chaîne ou null		Non
file_url	chaîne ou null		Non
filename	chaîne ou null		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_file`. Valeurs possibles : `input_file`	Oui	input_file

OpenAI.InputImageContent

Image d’entrée

Entrée d’image dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne ou null		Non
image_url	chaîne ou null		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui	input_image

OpenAI.InputImageContentParamAutoParam

Image d’entrée

Entrée d’image dans le modèle. Découvrez les entrées d’image

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.DetailEnum ou null		Non
identifiant_de_fichier	chaîne ou null		Non
image_url	chaîne ou null		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui	input_image

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
`tool_search_call`	OpenAI.InputItemToolSearchCallItemParam
`tool_search_output`	OpenAI.InputItemToolSearchOutputItemParam
`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
`tool_approval_response`	AzureToolApprovalResponse

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.InputItemType		Oui

OpenAI.InputItemApplyPatchToolCallItemParam

Appliquer l’appel de l’outil de patch

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	Par défaut
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 ou null		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	apply_patch_call

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Appliquer la sortie de l’appel de l’outil de patch

Sortie diffusée émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire	Par défaut
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 ou null		Non
sortie	chaîne ou null		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	apply_patch_call_output

OpenAI.InputItemCodeInterpreterToolCall

Appel à l’outil d’interprétation de code

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire	Par défaut
code	chaîne ou null		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 ou null		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	code_interpreter_call

OpenAI.InputItemCompactionSummaryItemParam

Élément de compactage

Un élément de compactage généré par l’API v1/responses/compact .

Nom	Type	Description	Obligatoire	Par défaut
encrypted_content	string	Contenu chiffré du résumé du compactage. Contraintes : maxLength : 10485760	Oui
id	chaîne ou null		Non
type	enum	Type de l’élément. A toujours la valeur `compaction`. Valeurs possibles : `compaction`	Oui	Compactage

OpenAI.InputItemComputerCallOutputItemParam

Sortie des appels d’outils informatiques

Sortie d’un appel d’outil informatique.

Nom	Type	Description	Obligatoire	Par défaut
acknowledged_safety_checks	array of OpenAI.ComputerCallSafetyCheckParam ou null		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 ou null		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 ou null		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	computer_call_output

OpenAI.InputItemComputerToolCall

Appel d’outil informatique

Un appel d’outil à un outil d’utilisation d’ordinateur.

Nom	Type	Description	Obligatoire	Par défaut
action	OpenAI.ComputerAction		Non
actions	OpenAI.ComputerActionList	Actions en lots aplaties pour `computer_use`. Chaque action comprend un `type` discriminateur et champs spécifiques à l’action.	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
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	computer_call

OpenAI.InputItemCustomToolCall

Appel d’outil personnalisé

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
namespace	string	L’espace de noms de l’outil personnalisé appelé.	Non
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’appel d’outil personnalisé

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

Appel à l’outil de recherche de fichiers

Résultats d’un appel d’outil 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 ou null		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 appel d’outil de fonction

Sortie d’un appel d’outil de fonction.

Nom	Type	Description	Obligatoire	Par défaut
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 ou null		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 ou null		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	function_call_output

OpenAI.InputItemFunctionShellCallItemParam

Appel à l’outil shell

Outil représentant une demande d’exécution d’une ou plusieurs commandes shell.

Nom	Type	Description	Obligatoire	Par défaut
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	entier ou null		Non
└timeout_ms	entier ou null		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
environment	OpenAI.FunctionShellCallItemParamEnvironment ou null		Non
id	chaîne ou null		Non
status	OpenAI.FunctionShellCallItemStatus ou null		Non
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui	shell_call

OpenAI.InputItemFunctionShellCallOutputItemParam

Sortie de l’appel de l’outil shell

Éléments de sortie diffusés émis par un appel d’outil shell.

Nom	Type	Description	Obligatoire	Par défaut
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 ou null		Non
max_output_length	entier ou null		Non
sortie	tableau d’OpenAI.FunctionShellCallOutputContentParam	Segments capturés de sortie stdout et stderr, ainsi que leurs résultats associés.	Oui
status	OpenAI.FunctionShellCallItemStatus ou null		Non
type	enum	Type de l’élément. A toujours la valeur `shell_call_output`. Valeurs possibles : `shell_call_output`	Oui	shell_call_output

OpenAI.InputItemFunctionToolCall

Appel de l’outil de fonction

Un appel d’outil pour exécuter une 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	chaîne (en lecture seule)	Identifiant unique de l'appel de l'outil fonctionnel.	Oui
nom	string	Nom de la fonction à exécuter.	Oui
namespace	string	L’espace de noms de la fonction à exécuter.	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.InputItemImageGenToolCall

Appel de génération d’images

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 ou null		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

Appel local de coquillage

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 locale de l’appel shell

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	chaîne ou null		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 du MCP

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

Réponse d’approbation du MCP

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 ou null		Non
raison	chaîne ou null		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.InputItemMcpListTools

Outils de liste MCP

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	OpenAI.RealtimeMCPError		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 à l’outil MCP

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne ou null		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	OpenAI.RealtimeMCPError		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 ou null		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

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
Phase	OpenAI.MessagePhase ou null		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.InputItemReasoningItem

Reasoning

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 à l’API de 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 ou null		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	array d’OpenAI.SummaryTextContent	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.InputItemToolSearchCallItemParam

Nom	Type	Description	Obligatoire	Par défaut
Arguments	OpenAI.EmptyModelParam		Oui
call_id	chaîne ou null		Non
Exécution	OpenAI.ToolSearchExecutionType		Non
id	chaîne ou null		Non
status	OpenAI.FunctionCallItemStatus ou null		Non
type	enum	Type d’élément. A toujours la valeur `tool_search_call`. Valeurs possibles : `tool_search_call`	Oui	tool_search_call

OpenAI.InputItemToolSearchOutputItemParam

Nom	Type	Description	Obligatoire	Par défaut
call_id	chaîne ou null		Non
Exécution	OpenAI.ToolSearchExecutionType		Non
id	chaîne ou null		Non
status	OpenAI.FunctionCallItemStatus ou null		Non
Outils	tableau d’OpenAI.Tool	Les définitions chargées de l’outil sont retournées par la sortie de recherche d’outils.	Oui
type	enum	Type d’élément. A toujours la valeur `tool_search_output`. Valeurs possibles : `tool_search_output`	Oui	tool_search_output

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
tool_search_call
tool_search_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
tool_approval_response

OpenAI.InputItemWebSearchToolCall

Appel à l’outil de recherche web

Résultats d’un appel d’outil 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 utilisait le web (recherche, open_page, find_in_page).	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.InputMessageContentList

Liste du contenu des éléments d’entrée

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.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 fichiers
État de la conversation
Appel de fonction

Ce composant peut être l’un des éléments suivants :

chaîne de caractères
array

OpenAI.InputTextContent

Texte d’entrée

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	input_text

OpenAI.InputTextContentParam

Texte d’entrée

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	input_text

OpenAI.ItemReferenceParam

Informations de référence sur les éléments

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	item_reference

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.MessageInputResourceItemResourceInput
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutput
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCall
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutput
`tool_search_call`	OpenAI.ItemResourceToolSearchCall
`tool_search_output`	OpenAI.ItemResourceToolSearchOutput
`reasoning`	OpenAI.ObjectResourceReasoningItem
`compaction`	OpenAI.ItemResourceCompactionBody
`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
`custom_tool_call`	OpenAI.ItemResourceCustomToolCallResource
`custom_tool_call_output`	OpenAI.ItemResourceCustomToolCallOutputResource

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ItemResourceType		Oui

OpenAI.ItemResourceApplyPatchToolCall

Appliquer l’appel de l’outil de patch

Appel d’outil qui applique des différences de fichier en créant, supprimant ou mettant à jour des fichiers.

Nom	Type	Description	Obligatoire	Par défaut
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	apply_patch_call

OpenAI.ItemResourceApplyPatchToolCallOutput

Appliquer la sortie de l’appel de l’outil de patch

Sortie émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire	Par défaut
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 ou null		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	apply_patch_call_output

OpenAI.ItemResourceCodeInterpreterToolCall

Appel à l’outil d’interprétation de code

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire	Par défaut
code	chaîne ou null		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 ou null		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	code_interpreter_call

OpenAI.ItemResourceCompactionBody

Élément de compactage

Un élément de compactage généré par l’API v1/responses/compact .

Nom	Type	Description	Obligatoire	Par défaut
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
type	enum	Type de l’élément. A toujours la valeur `compaction`. Valeurs possibles : `compaction`	Oui	Compactage

OpenAI.ItemResourceComputerToolCall

Appel d’outil informatique

Un appel d’outil à un outil d’utilisation d’ordinateur.

Nom	Type	Description	Obligatoire	Par défaut
action	OpenAI.ComputerAction		Non
actions	OpenAI.ComputerActionList	Actions en lots aplaties pour `computer_use`. Chaque action comprend un `type` discriminateur et champs spécifiques à l’action.	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
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	computer_call

OpenAI.ItemResourceComputerToolCallOutput

Sortie des appels d’outils informatiques

Sortie d’un appel d’outil informatique.

Nom	Type	Description	Obligatoire	Par défaut
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	chaîne (en lecture seule)	Identifiant de la sortie de l'outil informatique utilisé.	Oui
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	computer_call_output

OpenAI.ItemResourceCustomToolCallOutputResource

ArticleRépondToolPersonnaliséAppelSortie

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
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
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
status	OpenAI.FunctionCallOutputStatusEnum		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.ItemResourceCustomToolCallResource

RépondreToolCustomToolCallItem

Nom	Type	Description	Obligatoire
call_id	string	Identificateur utilisé pour mapper cet appel d’outil personnalisé à une sortie d’appel d’outil.	Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
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
namespace	string	L’espace de noms de l’outil personnalisé appelé.	Non
status	OpenAI.FunctionCallStatus		Oui
type	enum	Type de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call`. Valeurs possibles : `custom_tool_call`	Oui

OpenAI.ItemResourceFileSearchToolCall

Appel à l’outil de recherche de fichiers

Résultats d’un appel d’outil 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 ou null		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 à l’outil shell

Appel d’outil qui exécute une ou plusieurs commandes shell dans un environnement managé.

Nom	Type	Description	Obligatoire	Par défaut
action	OpenAI.FunctionShellAction	Exécutez une commande shell.	Oui
Commandes └ ;	tableau de chaînes		Oui
└max_output_length	entier ou null		Oui
└timeout_ms	entier ou null		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
environment	OpenAI.FunctionShellCallEnvironment ou null		Oui
id	string	ID unique de l’appel de l’outil shell. Renseigné lorsque cet élément est retourné via l’API.	Oui
status	OpenAI.FunctionShellCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui	shell_call

OpenAI.ItemResourceFunctionShellCallOutput

Sortie appel de shell

Sortie d’un appel d’outil shell émis.

Nom	Type	Description	Obligatoire	Par défaut
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	entier ou null		Oui
sortie	tableau d’OpenAI.FunctionShellCallOutputContent	Tableau de contenu de sortie d’appel d’interpréteur de commandes	Oui
status	OpenAI.FunctionShellCallOutputStatusEnum		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	shell_call_output

OpenAI.ItemResourceFunctionToolCall

Appel de l’outil de fonction

Un appel d’outil pour exécuter une 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	chaîne (en lecture seule)	Identifiant unique de l'appel de l'outil fonctionnel.	Oui
nom	string	Nom de la fonction à exécuter.	Oui
namespace	string	L’espace de noms de la fonction à exécuter.	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.ItemResourceFunctionToolCallOutput

Sortie appel d’outil de fonction

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.	Oui
id	chaîne (en lecture seule)	Identifiant unique de l'appel de sortie de l'outil fonctionnel. Renseigné lorsque cet élément est renseigné est retourné via l’API.	Oui
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.ItemResourceImageGenToolCall

Appel de génération d’images

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 ou null		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.MessageInputResourceItemResourceInput

Message d’entrée

Nom	Type	Description	Obligatoire	Par défaut
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	chaîne (en lecture seule)	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	message

OpenAI.ItemResourceLocalShellToolCall

Appel local de coquillage

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 locale de l’appel shell

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	chaîne ou null		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 du MCP

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

Réponse d’approbation du MCP

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 ou null		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.ItemResourceMcpListTools

Outils de liste MCP

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	OpenAI.RealtimeMCPError		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 à l’outil MCP

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne ou null		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	OpenAI.RealtimeMCPError		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 ou null		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

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
Phase	OpenAI.MessagePhase ou null		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.ObjectResourceReasoningItem

Reasoning

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.ReasoningTextContent	Contenu du texte de raisonnement.	Non
encrypted_content	chaîne ou null		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	array d’OpenAI.SummaryTextContent	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.ItemResourceToolSearchCall

Nom	Type	Description	Obligatoire	Par défaut
Arguments		Arguments utilisés pour l’appel de recherche d’outils.	Oui
call_id	chaîne ou null		Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
Exécution	OpenAI.ToolSearchExecutionType		Oui
id	string	L’identifiant unique de l’outil de recherche appelle l’élément.	Oui
status	OpenAI.FunctionCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `tool_search_call`. Valeurs possibles : `tool_search_call`	Oui	tool_search_call

OpenAI.ItemResourceToolSearchOutput

Nom	Type	Description	Obligatoire	Par défaut
call_id	chaîne ou null		Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
Exécution	OpenAI.ToolSearchExecutionType		Oui
id	string	L’identifiant unique de l’élément de recherche de l’outil.	Oui
status	OpenAI.FunctionCallOutputStatusEnum		Oui
Outils	tableau d’OpenAI.Tool	Les définitions chargées de l’outil sont retournées par recherche d’outils.	Oui
type	enum	Type de l’élément. A toujours la valeur `tool_search_output`. Valeurs possibles : `tool_search_output`	Oui	tool_search_output

OpenAI.ItemResourceType

Propriété Valeur

Type string

OpenAI.ItemResourceWebSearchToolCall

Appel à l’outil de recherche web

Résultats d’un appel d’outil 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 utilisait le web (recherche, open_page, find_in_page).	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

KeyPress

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	Appuyez sur la touche

OpenAI.LocalEnvironmentResource

Environnement local

Représente l’utilisation d’un environnement local pour effectuer des actions de shell.

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Le type d’environnement. A toujours la valeur `local`. Valeurs possibles : `local`	Oui	locale

OpenAI.LocalShellExecAction

Action exécutive shell locale

Exécutez une commande shell sur le serveur.

Nom	Type	Description	Obligatoire	Par défaut
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)	entier ou null		Non
type	enum	Type de l’action de l’interpréteur de commandes local. A toujours la valeur `exec`. Valeurs possibles : `exec`	Oui	exec
user	chaîne ou null		Non
working_directory	chaîne ou null		Non

OpenAI.LocalShellToolParam

Outil de coque local

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	local_shell

OpenAI.LocalSkillParam

Nom	Type	Description	Obligatoire
description	string	La description de la compétence.	Oui
nom	string	Le nom de la compétence.	Oui
path	string	Le chemin vers le répertoire contenant la compétence.	Oui

OpenAI.LogProb

Probabilité logarithmique

Probabilité du journal d’un jeton.

Nom	Type	Obligatoire
octets	tableau d’entiers	Oui
logprob	Numéro	Oui
token	string	Oui
top_logprobs	tableau d’OpenAI.TopLogProb	Oui

OpenAI.MCPListToolsTool

Outil d’outils de liste MCP

Outil disponible sur un serveur MCP.

Nom	Type	Description	Obligatoire
Annotations	OpenAI.MCPListToolsToolAnnotations ou null		Non
description	chaîne ou null		Non
input_schema	OpenAI.MCPListToolsToolInputSchema		Oui
nom	string	Nom de l’outil.	Oui

OpenAI.MCPListToolsToolAnnotations

Type : objet

OpenAI.MCPListToolsToolInputSchema

Type : objet

OpenAI.MCPTool

Outil MCP

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

Nom	Type	Description	Obligatoire
outils_autorisés	tableau de chaînes ou OpenAI.MCPToolFilter ou null		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
defer_loading	booléen	Si cet outil MCP est différé et découvert via la recherche d’outils.	Non
headers	objet ou null		Non
require_approval	OpenAI.MCPToolRequireApproval ou chaîne ou null		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	chaîne (uri)	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

Filtre outil MCP

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
`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
`summary_text`	OpenAI.SummaryTextContent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.MessageContentType		Oui

OpenAI.MessageContentInputFileContent

Fichier d’entrée

Entrée de fichier dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.FileInputDetail		Non
file_data	string	Contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	chaîne ou null		Non
file_url	chaîne (uri)	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	input_file

OpenAI.MessageContentInputImageContent

Image d’entrée

Entrée d’image dans le modèle.

Nom	Type	Description	Obligatoire	Par défaut
detail	OpenAI.ImageDetail		Oui
identifiant_de_fichier	chaîne ou null		Non
image_url	chaîne ou null		Non
type	enum	Type de l’élément d’entrée. A toujours la valeur `input_image`. Valeurs possibles : `input_image`	Oui	input_image

OpenAI.MessageContentInputTextContent

Texte d’entrée

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	input_text

OpenAI.MessageContentOutputTextContent

Texte de sortie

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire	Par défaut
Annotations	tableau d’OpenAI.Annotation	Annotations de la sortie de texte.	Oui
logprobs	tableau d’OpenAI.LogProb		Oui
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	output_text

OpenAI.MessageContentReasoningTextContent

Texte de raisonnement

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	reasoning_text

OpenAI.MessageContentRefusalContent

Refusal

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	refusal

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.MessagePhase

Étiquette un assistant message comme commentaire intermédiaire (commentary) ou la réponse finale (final_answer). Pour des modèles comme gpt-5.3-codex et au-delà, lors de l’envoi de demandes de suivi, il faut conserver et renvoyer la phase sur tous les messages de l’assistant — la supprimer peut dégrader les performances. Pas utilisé pour les messages utilisateur.

Propriété	Valeur
Type	string
Valeurs	`commentary` `final_answer`

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.MoveParam

Move

Action de déplacement de la souris.

Nom	Type	Description	Obligatoire	Par défaut
keys	tableau de chaînes ou null		Non
type	enum	Spécifie le type d’événement. Pour une action de déplacement, cette propriété est toujours définie sur `move`. Valeurs possibles : `move`	Oui	move
x	entier	Coordonnée x vers laquelle se déplacer.	Oui
y	entier	La coordonnée y vers laquelle se déplacer.	Oui

OpenAI.NamespaceToolParam

Namespace

Groupe une fonction/outils personnalisés sous un espace de noms partagé.

Nom	Type	Description	Obligatoire	Par défaut
description	string	Une description de l’espace de noms montré au modèle. Contraintes : minLength : 1	Oui
nom	string	Le nom de l’espace de noms utilisé dans les appels d’outils (par exemple, `crm`). Contraintes : minLength : 1	Oui
Outils	array d’OpenAI.FunctionToolParam ou OpenAI.CustomToolParam	Les outils fonctionnels/personnalisés disponibles dans cet espace de noms. Contraintes : minObjets : 1	Oui
type	enum	Type de l’outil. A toujours la valeur `namespace`. Valeurs possibles : `namespace`	Oui	namespace

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

Texte de sortie

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire	Par défaut
Annotations	tableau d’OpenAI.Annotation	Annotations de la sortie de texte.	Oui
logprobs	tableau d’OpenAI.LogProb		Oui
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	output_text

OpenAI.OutputContentReasoningTextContent

Texte de raisonnement

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	reasoning_text

OpenAI.OutputContentRefusalContent

Refusal

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	refusal

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
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`function_call_output`	OpenAI.OutputItemFunctionToolCallOutput
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`computer_call_output`	OpenAI.OutputItemMachineToolCallOutput
`reasoning`	OpenAI.OutputItemReasoningItem
`tool_search_call`	OpenAI.OutputItemToolSearchCall
`tool_search_output`	OpenAI.OutputItemToolSearchOutput
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.OutputItemLocalShellToolCallOutput
`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
`mcp_approval_response`	OpenAI.OutputItemMcpApprovalResponseResource
`custom_tool_call`	OpenAI.OutputItemCustomToolCallResource
`custom_tool_call_output`	OpenAI.OutputItemCustomToolCallOutputResource
`tool_approval_request`	AzureToolApprovalRequest

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.OutputItemType		Oui

OpenAI.OutputItemApplyPatchToolCall

Appliquer l’appel de l’outil de patch

Appel d’outil qui applique des différences de fichier en créant, supprimant ou mettant à jour des fichiers.

Nom	Type	Description	Obligatoire	Par défaut
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	apply_patch_call

OpenAI.OutputItemApplyPatchToolCallOutput

Appliquer la sortie de l’appel de l’outil de patch

Sortie émise par un appel d’outil de correctif d’application.

Nom	Type	Description	Obligatoire	Par défaut
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 ou null		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	apply_patch_call_output

OpenAI.OutputItemCodeInterpreterToolCall

Appel à l’outil d’interprétation de code

Un appel d’outil pour exécuter du code.

Nom	Type	Description	Obligatoire	Par défaut
code	chaîne ou null		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 ou null		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	code_interpreter_call

OpenAI.OutputItemCompactionBody

Élément de compactage

Un élément de compactage généré par l’API v1/responses/compact .

Nom	Type	Description	Obligatoire	Par défaut
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
type	enum	Type de l’élément. A toujours la valeur `compaction`. Valeurs possibles : `compaction`	Oui	Compactage

OpenAI.OutputItemComputerToolCall

Appel d’outil informatique

Un appel d’outil à un outil d’utilisation d’ordinateur.

Nom	Type	Description	Obligatoire	Par défaut
action	OpenAI.ComputerAction		Non
actions	OpenAI.ComputerActionList	Actions en lots aplaties pour `computer_use`. Chaque action comprend un `type` discriminateur et champs spécifiques à l’action.	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
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	computer_call

OpenAI.OutputItemMachineToolCallOutput

Sortie des appels d’outils informatiques

Sortie d’un appel d’outil informatique.

Nom	Type	Description	Obligatoire	Par défaut
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	chaîne (en lecture seule)	Identifiant de la sortie de l'outil informatique utilisé.	Oui
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	computer_call_output

OpenAI.OutputItemCustomToolCallOutputResource

ArticleRépondToolPersonnaliséAppelSortie

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
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
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
status	OpenAI.FunctionCallOutputStatusEnum		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.OutputItemCustomToolCallResource

RépondreToolCustomToolCallItem

Nom	Type	Description	Obligatoire
call_id	string	Identificateur utilisé pour mapper cet appel d’outil personnalisé à une sortie d’appel d’outil.	Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
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
namespace	string	L’espace de noms de l’outil personnalisé appelé.	Non
status	OpenAI.FunctionCallStatus		Oui
type	enum	Type de l’appel d’outil personnalisé. A toujours la valeur `custom_tool_call`. Valeurs possibles : `custom_tool_call`	Oui

OpenAI.OutputItemFileSearchToolCall

Appel à l’outil de recherche de fichiers

Résultats d’un appel d’outil 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 ou null		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 à l’outil shell

Appel d’outil qui exécute une ou plusieurs commandes shell dans un environnement managé.

Nom	Type	Description	Obligatoire	Par défaut
action	OpenAI.FunctionShellAction	Exécutez une commande shell.	Oui
Commandes └ ;	tableau de chaînes		Oui
└max_output_length	entier ou null		Oui
└timeout_ms	entier ou null		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
environment	OpenAI.FunctionShellCallEnvironment ou null		Oui
id	string	ID unique de l’appel de l’outil shell. Renseigné lorsque cet élément est retourné via l’API.	Oui
status	OpenAI.FunctionShellCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `shell_call`. Valeurs possibles : `shell_call`	Oui	shell_call

OpenAI.OutputItemFunctionShellCallOutput

Sortie appel de shell

Sortie d’un appel d’outil shell émis.

Nom	Type	Description	Obligatoire	Par défaut
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	entier ou null		Oui
sortie	tableau d’OpenAI.FunctionShellCallOutputContent	Tableau de contenu de sortie d’appel d’interpréteur de commandes	Oui
status	OpenAI.FunctionShellCallOutputStatusEnum		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	shell_call_output

OpenAI.OutputItemFunctionToolCall

Appel de l’outil de fonction

Un appel d’outil pour exécuter une 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	chaîne (en lecture seule)	Identifiant unique de l'appel de l'outil fonctionnel.	Oui
nom	string	Nom de la fonction à exécuter.	Oui
namespace	string	L’espace de noms de la fonction à exécuter.	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.OutputItemFunctionToolCallOutput

Sortie appel d’outil de fonction

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.	Oui
id	chaîne (en lecture seule)	Identifiant unique de l'appel de sortie de l'outil fonctionnel. Renseigné lorsque cet élément est renseigné est retourné via l’API.	Oui
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.OutputItemImageGenToolCall

Appel de génération d’images

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 ou null		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

Appel local de coquillage

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.OutputItemLocalShellToolCallOutput

Sortie locale de l’appel shell

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	chaîne ou null		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.OutputItemMcpApprovalRequest

Demande d’approbation du MCP

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.OutputItemMcpApprovalResponseResource

Réponse d’approbation du MCP

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 ou null		Non
type	enum	Type de l’élément. A toujours la valeur `mcp_approval_response`. Valeurs possibles : `mcp_approval_response`	Oui

OpenAI.OutputItemMcpListTools

Outils de liste MCP

Liste des outils disponibles sur un serveur MCP.

Nom	Type	Description	Obligatoire
erreur	OpenAI.RealtimeMCPError		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.OutputItemMcpToolCall

Appel à l’outil MCP

Appel d’un outil sur un serveur MCP.

Nom	Type	Description	Obligatoire
approval_request_id	chaîne ou null		Non
Arguments	string	Chaîne JSON des arguments passés à l’outil.	Oui
erreur	OpenAI.RealtimeMCPError		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 ou null		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

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
Phase	OpenAI.MessagePhase ou null		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

Reasoning

Nom	Type	Description	Obligatoire
contenu	tableau d’OpenAI.ReasoningTextContent	Contenu du texte de raisonnement.	Non
encrypted_content	chaîne ou null		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	array d’OpenAI.SummaryTextContent	Contenu récapitulative du raisonnement.	Oui
type	enum	Type de l’objet. A toujours la valeur `reasoning`. Valeurs possibles : `reasoning`	Oui

OpenAI.OutputItemToolSearchCall

Nom	Type	Description	Obligatoire	Par défaut
Arguments		Arguments utilisés pour l’appel de recherche d’outils.	Oui
call_id	chaîne ou null		Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
Exécution	OpenAI.ToolSearchExecutionType		Oui
id	string	L’identifiant unique de l’outil de recherche appelle l’élément.	Oui
status	OpenAI.FunctionCallStatus		Oui
type	enum	Type de l’élément. A toujours la valeur `tool_search_call`. Valeurs possibles : `tool_search_call`	Oui	tool_search_call

OpenAI.OutputItemToolSearchOutput

Nom	Type	Description	Obligatoire	Par défaut
call_id	chaîne ou null		Oui
created_by	string	Identificateur de l’acteur qui a créé l’élément.	Non
Exécution	OpenAI.ToolSearchExecutionType		Oui
id	string	L’identifiant unique de l’élément de recherche de l’outil.	Oui
status	OpenAI.FunctionCallOutputStatusEnum		Oui
Outils	tableau d’OpenAI.Tool	Les définitions chargées de l’outil sont retournées par recherche d’outils.	Oui
type	enum	Type de l’élément. A toujours la valeur `tool_search_output`. Valeurs possibles : `tool_search_output`	Oui	tool_search_output

OpenAI.OutputItemType

Propriété Valeur

Type string

Valeurs output_message
file_search_call
function_call
function_call_output
web_search_call
computer_call
computer_call_output
reasoning
tool_search_call
tool_search_output
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_call
mcp_list_tools
mcp_approval_request
mcp_approval_response
custom_tool_call
custom_tool_call_output
tool_approval_request

OpenAI.OutputItemWebSearchToolCall

Appel à l’outil de recherche web

Résultats d’un appel d’outil 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 utilisait le web (recherche, open_page, find_in_page).	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.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

Texte de sortie

Sortie de texte du modèle.

Nom	Type	Description	Obligatoire	Par défaut
Annotations	tableau d’OpenAI.Annotation	Annotations de la sortie de texte.	Oui
logprobs	tableau d’OpenAI.LogProb		Oui
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	output_text

OpenAI.OutputMessageContentRefusalContent

Refusal

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	refusal

OpenAI.OutputMessageContentType

Propriété	Valeur
Type	string
Valeurs	`output_text` `refusal`

OpenAI.Prompt

Référence à un modèle d’invite et à ses variables.

Nom	Type	Description	Obligatoire
id	string	Identificateur unique du modèle d’invite à utiliser.	Oui
variables	OpenAI.ResponsePromptVariables ou null		Non
version	chaîne ou null		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	Numéro	Poids de l’incorporation dans la fusion de classement réciproque.	Oui
└text_weight	Numéro	Poids du texte dans la fusion de classement réciproque.	Oui
ranker	OpenAI.RankerVersionType		Non
seuil de score	Numéro	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

OpenAI.RealtimeMCPError

Discriminateur pour OpenAI.RealtimeMCPError

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

Type de valeur	Schema
`protocol_error`	OpenAI.RealtimeMCPProtocolError
`tool_execution_error`	OpenAI.RealtimeMCPToolExecutionError
`http_error`	OpenAI.RealtimeMCPHTTPError

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.RealtimeMcpErrorType		Oui

OpenAI.RealtimeMCPHTTPError

Erreur HTTP MCP en temps réel

Nom	Type	Description	Obligatoire
code	entier		Oui
message	string		Oui
type	enum	Valeurs possibles : `http_error`	Oui

OpenAI.RealtimeMCPProtocolError

Erreur du protocole MCP en temps réel

Nom	Type	Description	Obligatoire
code	entier		Oui
message	string		Oui
type	enum	Valeurs possibles : `protocol_error`	Oui

OpenAI.RealtimeMCPToolExecutionError

Erreur d’exécution de l’outil MCP en temps réel

Nom	Type	Description	Obligatoire	Par défaut
message	string		Oui
type	enum	Valeurs possibles : `tool_execution_error`	Oui

OpenAI.RealtimeMcpErrorType

Propriété	Valeur
Type	string
Valeurs	`protocol_error` `tool_execution_error` `http_error`

OpenAI.Reasoning

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	chaîne ou null		Non
summary	chaîne ou null		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
Description	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`.
Type	string
Valeurs	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Texte de raisonnement

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	reasoning_text

OpenAI.Response

L’objet réponse

Nom	Type	Description	Obligatoire	Par défaut
Arrière-plan	booléen ou null		Non
terminé_à	chaîne ou null		Non
content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
conversation	OpenAI.ConversationReference ou null		Non
date_de_création	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
erreur	OpenAI.ResponseError ou null		Oui
id	string	Identificateur unique pour cette réponse.	Oui
incomplete_details	OpenAI.ResponseIncompleteDetails ou null		Oui
Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
max_output_tokens	entier ou null		Non
max_tool_calls	entier ou null		Non
Métadonnées	OpenAI.Metadata ou null		Non
model	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
prompt	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
prompt_cache_retention	chaîne ou null		Non
reasoning	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		Non
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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
top_logprobs	entier ou null		Non
top_p	nombre ou null		Non
truncation	chaîne ou null		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.	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. Contraintes : encodage : base64	Oui
sequence_number	entier	Numéro de séquence pour ce segment de la réponse de flux.	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	entier	Le numéro de séquence du delta.	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	entier	Numéro de séquence de cet événement.	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	entier	Numéro de séquence de cet événement.	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	entier	Index de l’élément de sortie dans la réponse pour laquelle le code est en cours de diffusion en continu.	Oui
sequence_number	entier	Numéro de séquence de cet événement, utilisé pour commander les événements de diffusion en continu.	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	entier	Index de l’élément de sortie dans la réponse pour laquelle le code est finalisé.	Oui
sequence_number	entier	Numéro de séquence de cet événement, utilisé pour commander les événements de diffusion en continu.	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	entier	Index de l’élément de sortie dans la réponse pour laquelle l’appel de l’interpréteur de code est terminé.	Oui
sequence_number	entier	Numéro de séquence de cet événement, utilisé pour commander les événements de diffusion en continu.	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	entier	Index de l’élément de sortie dans la réponse pour laquelle l’appel de l’interpréteur de code est en cours.	Oui
sequence_number	entier	Numéro de séquence de cet événement, utilisé pour commander les événements de diffusion en continu.	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	entier	Index de l’élément de sortie dans la réponse pour laquelle l’interpréteur de code interprète le code.	Oui
sequence_number	entier	Numéro de séquence de cet événement, utilisé pour commander les événements de diffusion en continu.	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
└─ arrière-plan	booléen ou null		Non
└completed_at	chaîne ou null (unixTimestamp)		Non
└content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
Conversation └>	OpenAI.ConversationReference ou null		Non
└created_at	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError ou null		Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails ou null		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
└ max_output_tokens	entier ou null		Non
└max_tool_calls	entier ou null		Non
└─ Métadonnées	OpenAI.Metadata ou null		Non
└─ Modèle	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
└prompt_cache_retention	chaîne ou null		Non
└─ Raisonnement	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	entier ou null		Non
└─ top_p	nombre ou null		Non	1
└─ troncature	chaîne ou null		Non	handicapé
└─ 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.	Non
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	Index de la partie de contenu qui a été ajoutée.	Oui
item_id	string	ID de l’élément de sortie auquel la partie de contenu a été ajoutée.	Oui
output_index	entier	Index de l’élément de sortie auquel la partie de contenu a été ajoutée.	Oui
part	OpenAI.OutputContent		Oui
└─ Type	OpenAI.OutputContentType		Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	Index de la partie de contenu terminée.	Oui
item_id	string	ID de l’élément de sortie auquel la partie de contenu a été ajoutée.	Oui
output_index	entier	Index de l’élément de sortie auquel la partie de contenu a été ajoutée.	Oui
part	OpenAI.OutputContent		Oui
└─ Type	OpenAI.OutputContentType		Oui
sequence_number	entier	Numéro de séquence de cet événement.	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
└─ arrière-plan	booléen ou null		Non
└completed_at	chaîne ou null (unixTimestamp)		Non
└content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
Conversation └>	OpenAI.ConversationReference ou null		Non
└created_at	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError ou null		Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails ou null		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
└ max_output_tokens	entier ou null		Non
└max_tool_calls	entier ou null		Non
└─ Métadonnées	OpenAI.Metadata ou null		Non
└─ Modèle	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
└prompt_cache_retention	chaîne ou null		Non
└─ Raisonnement	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	entier ou null		Non
└─ top_p	nombre ou null		Non	1
└─ troncature	chaîne ou null		Non	handicapé
└─ 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.	Non
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	le type de l'événement ; A toujours la valeur `response.created`. Valeurs possibles : `response.created`	Oui

OpenAI.ResponseCustomToolCallInputDeltaEvent

ResponseCustomToolCallInputDelta

É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	entier	L’index de la sortie auquel s’applique ce delta.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	Identificateur de type d’événement. Valeurs possibles : `response.custom_tool_call_input.delta`	Oui

OpenAI.ResponseCustomToolCallInputDoneEvent

RéponseToolPersonnaliséAppelEntréeTerminée

É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	entier	L’indice de la sortie auquel cet événement s’applique.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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 ou null		Oui
message	string	Message d’erreur.	Oui
param	chaîne ou null		Oui
sequence_number	entier	Numéro de séquence de cet événement.	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
└─ arrière-plan	booléen ou null		Non
└completed_at	chaîne ou null (unixTimestamp)		Non
└content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
Conversation └>	OpenAI.ConversationReference ou null		Non
└created_at	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError ou null		Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails ou null		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
└ max_output_tokens	entier ou null		Non
└max_tool_calls	entier ou null		Non
└─ Métadonnées	OpenAI.Metadata ou null		Non
└─ Modèle	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
└prompt_cache_retention	chaîne ou null		Non
└─ Raisonnement	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	entier ou null		Non
└─ top_p	nombre ou null		Non	1
└─ troncature	chaîne ou null		Non	handicapé
└─ 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.	Non
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	L'index de l'élément de sortie auquel l'appel de recherche de fichier est associé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	L'index de l'élément de sortie auquel l'appel de recherche de fichier est associé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	Index de l’élément de sortie recherché lors de l’appel de recherche de fichier.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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.ResponseFormatJsonSchemaSchema

Schéma JSON

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

Type : objet

OpenAI.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	entier	Index de l’élément de sortie auquel le delta des arguments d’appel de fonction est ajouté.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	Index de l’élément de sortie.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	Valeurs possibles : `response.function_call_arguments.done`	Oui

OpenAI.ResponseImageGenCallCompletedEvent

RéponseImageGenAppelÉventComplétéCompletÉvénement

É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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de l’élément de génération d’image en cours de traitement.	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

RéponseImageGenAppelEnProgressÉvénement

É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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de l’élément de génération d’image en cours de traitement.	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

RéponseImageGenAppelPartialImageÉvénement

É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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	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	entier	Index de base 0 pour l’image partielle (le back-end est basé sur 1, mais il s’agit de 0 pour l’utilisateur).	Oui
sequence_number	entier	Numéro de séquence de l’élément de génération d’image en cours de traitement.	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
└─ arrière-plan	booléen ou null		Non
└completed_at	chaîne ou null (unixTimestamp)		Non
└content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
Conversation └>	OpenAI.ConversationReference ou null		Non
└created_at	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError ou null		Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails ou null		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
└ max_output_tokens	entier ou null		Non
└max_tool_calls	entier ou null		Non
└─ Métadonnées	OpenAI.Metadata ou null		Non
└─ Modèle	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
└prompt_cache_retention	chaîne ou null		Non
└─ Raisonnement	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	entier ou null		Non
└─ top_p	nombre ou null		Non	1
└─ troncature	chaîne ou null		Non	handicapé
└─ 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.	Non
sequence_number	entier	Numéro de séquence de cet événement.	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
└─ arrière-plan	booléen ou null		Non
└completed_at	chaîne ou null (unixTimestamp)		Non
└content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
Conversation └>	OpenAI.ConversationReference ou null		Non
└created_at	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError ou null		Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails ou null		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
└ max_output_tokens	entier ou null		Non
└max_tool_calls	entier ou null		Non
└─ Métadonnées	OpenAI.Metadata ou null		Non
└─ Modèle	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
└prompt_cache_retention	chaîne ou null		Non
└─ Raisonnement	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	entier ou null		Non
└─ top_p	nombre ou null		Non	1
└─ troncature	chaîne ou null		Non	handicapé
└─ 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.	Non
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	le type de l'événement ; A toujours la valeur `response.incomplete`. Valeurs possibles : `response.incomplete`	Oui

OpenAI.ResponseItemList

Liste des éléments de réponse.

Nom	Type	Description	Obligatoire
data	tableau d’OpenAI.ItemResource	Liste des éléments utilisés pour générer cette réponse.	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.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	Numéro	Probabilité de journal de ce jeton.	Oui
token	string	Jeton de texte possible.	Oui
top_logprobs	tableau d’OpenAI.ResponseLogProbTopLogprobs	Les probabilités logarithiques allant jusqu’à 20 des jetons les plus probables.	Non

OpenAI.ResponseLogProbTopLogprobs

Nom	Type	Description	Obligatoire	Par défaut
logprob	Numéro		Non
token	string		Non

OpenAI.ResponseMCPCallArgumentsDeltaEvent

RéponseMCPCtousArgumentsDeltaÉvénement

É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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

RéponseMCPCtousArgumentsFaitÉvénementFaitÉvénement

É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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

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	entier	L’index de l’élément de sortie qui a été complété.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call.completed ». Valeurs possibles : `response.mcp_call.completed`	Oui

OpenAI.ResponseMCPCallFailedEvent

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	entier	Index de l’élément de sortie qui a échoué.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	le type de l'événement ; Toujours « response.mcp_call.failed ». Valeurs possibles : `response.mcp_call.failed`	Oui

OpenAI.ResponseMCPCallInProgressEvent

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	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

ResponseMCPListToolsCompletedEventCompletedT

É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	entier	L’index de l’élément de sortie qui a été traité.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

RéponseMCPListToolsÉchecÉvénement

É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	entier	Index de l’élément de sortie qui a échoué.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

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	entier	Index de l’élément de sortie en cours de traitement.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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
└─ Type	OpenAI.OutputItemType		Oui
output_index	entier	Index de l’élément de sortie qui a été ajouté.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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
└─ Type	OpenAI.OutputItemType		Oui
output_index	entier	Index de l’élément de sortie marqué comme terminé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

RéponseSortieTexteAnnotationÉvénementAjouté

É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	entier	Index de l’annotation dans la partie de contenu.	Oui
content_index	entier	Index de la partie de contenu dans l’élément de sortie.	Oui
item_id	string	Identificateur unique de l’élément auquel l’annotation est ajoutée.	Oui
output_index	entier	L’index de l’élément de sortie dans le groupe de sortie de la réponse.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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

Variables d’invite

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

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
└─ arrière-plan	booléen ou null		Non
└completed_at	chaîne ou null (unixTimestamp)		Non
└content_filters	tableau d’AzureContentFilterForResponsesAPI	Le filtre de contenu résulte de RAI.	Non
Conversation └>	OpenAI.ConversationReference ou null		Non
└created_at	entier (unixtime)	Horodatage Unix (en secondes) de la création de cette réponse.	Oui
Erreur └ ;	OpenAI.ResponseError ou null		Oui
└─ identifiant	string	Identificateur unique pour cette réponse.	Oui
└─ détails_incomplets	OpenAI.ResponseIncompleteDetails ou null		Oui
└─ Instructions	chaîne ou tableau d’OpenAI.InputItem ou null		Oui
└ max_output_tokens	entier ou null		Non
└max_tool_calls	entier ou null		Non
└─ Métadonnées	OpenAI.Metadata ou null		Non
└─ Modèle	string	ID de modèle utilisé pour générer la réponse, comme `gpt-4o` ou `o3`. OpenAI offre un large éventail de modèles avec différentes fonctionnalités, performances caractéristiques et points de prix. Voir le guide du modèle pour parcourir et comparer les modèles disponibles.	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 ou null		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 ou null		Non
└─ invite	OpenAI.Prompt	Référence à un modèle d’invite et à ses variables.	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.	Non
└prompt_cache_retention	chaîne ou null		Non
└─ Raisonnement	OpenAI.Reasoning ou Null		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 identifiants doivent être une chaîne qui identifie chaque utilisateur de manière unique, avec une longueur maximale de 64 caractères. Nous vous recommandons de hacher leur nom d’utilisateur ou leur adresse e-mail pour éviter de nous envoyer des informations d’identification. Contraintes : maxLongueur : 64	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	nombre ou null		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 Les capacités du modèle, comme 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 Fonction qui appelle. Vous pouvez également utiliser outils personnalisés pour appeler votre propre code.	Non
├ top_logprobs	entier ou null		Non
└─ top_p	nombre ou null		Non	1
└─ troncature	chaîne ou null		Non	handicapé
└─ 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.	Non
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	Index de l’élément de sortie auquel cette partie récapitulative est associée.	Oui
part	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Oui
└─ texte	string		Oui
└─ Type	enum	Valeurs possibles : `summary_text`	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
summary_index	entier	Index de la partie récapitulative dans le résumé du raisonnement.	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	entier	Index de l’élément de sortie auquel cette partie récapitulative est associée.	Oui
part	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Oui
└─ texte	string		Oui
└─ Type	enum	Valeurs possibles : `summary_text`	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
summary_index	entier	Index de la partie récapitulative dans le résumé du raisonnement.	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	entier	L’index de l’élément de sortie associé à ce delta de texte de résumé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
summary_index	entier	Index de la partie récapitulative dans le résumé du raisonnement.	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	entier	L'index de l'élément de sortie auquel ce texte récapitulatif est associé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
summary_index	entier	Index de la partie récapitulative dans le résumé du raisonnement.	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	entier	L’index de la partie de contenu du raisonnement auquel ce delta est associé.	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	entier	Index de l’élément de sortie auquel ce delta de texte de raisonnement est associé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	L’index de la partie contenu de raisonnement.	Oui
item_id	string	ID de l’élément avec lequel ce texte de raisonnement est associé.	Oui
output_index	entier	L’index de l’élément de sortie auquel ce texte de raisonnement est associé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	Index de la partie de contenu à laquelle le texte de refus est ajouté.	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	entier	Index de l’élément de sortie auquel le texte de refus est ajouté.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	L'index de la partie de contenu où le texte de refus est finalisé.	Oui
item_id	string	ID de l'élément de sortie pour lequel le texte de refus est finalisé.	Oui
output_index	entier	L'index de l’élément de sortie où le texte de refus est finalisé.	Oui
refusal	string	Texte de refus finalisé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	Oui
type	enum	le type de l'événement ; A toujours la valeur `response.refusal.done`. Valeurs possibles : `response.refusal.done`	Oui

OpenAI.ResponseStreamEvent

Discriminant pour OpenAI.ResponseStreamEvent

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

Type de valeur	Schema
`response.audio.done`	OpenAI.ResponseAudioDoneEvent
`response.audio.transcript.delta`	OpenAI.ResponseAudioTranscriptDeltaEvent
`response.audio.transcript.done`	OpenAI.ResponseAudioTranscriptionFaitÉvénement
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`response.custom_tool_call_input.delta`	OpenAI.ResponseCustomToolCallInputDeltaEvent
`response.custom_tool_call_input.done`	OpenAI.ResponseCustomToolCallInputDoneEvent.
`error`	OpenAI.ResponseErrorEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.mcp_call_arguments.delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call_arguments.done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.output_text.annotation.added`	OpenAI.ResponseOutputTextAnnotationAddedEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.reasoning_text.delta`	OpenAI.RaisonnementTexteDeltaÉvénement
`response.reasoning_text.done`	OpenAI.RéponseRaisonnementTexteFaitÉvénement
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.audio.delta`	OpenAI.ResponseAudioDeltaEvent

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ResponseStreamEventType		Oui

OpenAI.ResponseStreamEventType

Propriété Valeur

Type string

Valeurs response.audio.delta
response.audio.done
response.audio.transcript.delta
response.audio.transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.reasoning_text.delta
response.reasoning_text.done
response.refusal.delta
response.refusal.done
response.output_text.delta
response.output_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call_arguments.delta
response.mcp_call_arguments.done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.output_text.annotation.added
response.queued
response.custom_tool_call_input.delta
response.custom_tool_call_input.done

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	entier	Index de la partie de contenu à laquelle le delta de texte a été ajouté.	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	entier	Index de l’élément de sortie à laquelle le delta de texte a été ajouté.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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	entier	L'index de la partie de contenu où le contenu du texte est finalisé.	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	entier	L'index de l’élément de sortie où le contenu du texte est finalisé.	Oui
sequence_number	entier	Numéro de séquence de cet événement.	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:

Entrées et sorties de texte
Sorties 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 les modèles gpt-4o et versions ultérieures : Activer `{ "type": "json_object" }` permet de passer au mode JSON plus ancien, qui garantit que le message généré par le modèle est json valide. Utilisation de `json_schema` La solution est préférée pour les modèles qui la prennent en charge.	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	Description	Obligatoire
input_tokens	entier	Nombre de jetons d’entrée.	Oui
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Oui
└cached_tokens	entier		Oui
output_tokens	entier	Nombre de jetons de sortie.	Oui
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Oui
└─ jetons_de_raisonnement	entier		Oui
total_tokens	entier	Nombre total de jetons utilisés.	Oui

OpenAI.ResponseUsageInputTokensDetails

Nom	Type	Description	Obligatoire	Par défaut
cached_tokens	entier		Oui

OpenAI.ResponseUsageOutputTokensDetails

Nom	Type	Description	Obligatoire	Par défaut
jetons_de_raisonnement	entier		Oui

OpenAI.ResponseWebSearchCallCompletedEvent

Remarque : web_search n’est pas encore disponible via Azure OpenAI.

Nom	Type	Description	Obligatoire
item_id	string	ID unique de l’élément de sortie associé à l’appel de recherche web.	Oui
output_index	entier	Index de l’élément de sortie auquel l’appel de recherche web est associé.	Oui
sequence_number	entier	Numéro de séquence de l’appel de recherche web en cours de traitement.	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

Remarque : web_search n’est pas encore disponible via Azure OpenAI.

Nom	Type	Description	Obligatoire
item_id	string	ID unique de l’élément de sortie associé à l’appel de recherche web.	Oui
output_index	entier	Index de l’élément de sortie auquel l’appel de recherche web est associé.	Oui
sequence_number	entier	Numéro de séquence de l’appel de recherche web en cours de traitement.	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

Remarque : web_search n’est pas encore disponible via Azure OpenAI.

Nom	Type	Description	Obligatoire
item_id	string	ID unique de l’élément de sortie associé à l’appel de recherche web.	Oui
output_index	entier	Index de l’élément de sortie auquel l’appel de recherche web est associé.	Oui
sequence_number	entier	Numéro de séquence de l’appel de recherche web en cours de traitement.	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.ScreenshotParam

Screenshot

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éfinie sur `screenshot`. Valeurs possibles : `screenshot`	Oui	Screenshot

OpenAI.ScrollParam

Scroll

Action de défilement.

Nom	Type	Description	Obligatoire	Par défaut
keys	tableau de chaînes ou null		Non
scroll_x	entier	Distance de défilement horizontale.	Oui
scroll_y	entier	Distance de défilement verticale.	Oui
type	enum	Spécifie le type d’événement. Pour une action de défilement, cette propriété est toujours définie sur `scroll`. Valeurs possibles : `scroll`	Oui	Faire défiler
x	entier	Coordonnée x où le défilement s’est produit.	Oui
y	entier	Coordonnée y où le défilement s’est produit.	Oui

OpenAI.SearchContentType

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

OpenAI.SearchContextSize

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

OpenAI.SkillReferenceParam

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

OpenAI.SpecificApplyPatchParam

Choix spécifique de l’outil de patch

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

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Outil à appeler. A toujours la valeur `apply_patch`. Valeurs possibles : `apply_patch`	Oui	apply_patch

OpenAI.SpecificFunctionShellParam

Choix spécifique de l’outil shell

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

Nom	Type	Description	Obligatoire	Par défaut
type	enum	Outil à appeler. A toujours la valeur `shell`. Valeurs possibles : `shell`	Oui	shell

OpenAI.SummaryTextContent

Texte résumé

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	summary_text

OpenAI.TextContent

Contenu textuel

Contenu texte.

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

OpenAI.TextResponseFormatConfiguration

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

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

Discriminateur pour OpenAI.TextResponseFormatConfiguration

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

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

Objet JSON

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

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

texte

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

Schéma JSON

Format de réponse de schéma JSON. Utilisé pour générer des réponses JSON 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 ou null		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
`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
`computer`	OpenAI.ComputerTool
`namespace`	OpenAI.NamespaceToolParam
`tool_search`	OpenAI.ToolSearchToolParam

Nom	Type	Description	Obligatoire	Par défaut
type	OpenAI.ToolType		Oui

OpenAI.ToolChoiceAllowed

Outils autorisés

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> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<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.ToolChoiceComputer

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`	Oui

OpenAI.ChoiceToolComputerUse

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`	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

Outil personnalisé

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

Outil de fonction

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

Outil MCP

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 ou null		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

Mode de choix d’outil

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
`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
`computer`	OpenAI.ToolChoiceComputer
`computer_use`	OpenAI.ChoiceToolComputerUse
`function`	OpenAI.ToolChoiceFunction

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` `computer` `computer_use`

OpenAI.ToolChoiceWebSearchPreview

Remarque : web_search n’est pas encore disponible via Azure OpenAI.

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.ToolSearchExecutionType

Propriété	Valeur
Type	string
Valeurs	`server` `client`

OpenAI.ToolSearchToolParam

Outil de recherche d’outils

Hébergé ou recherche d’outil BYOT pour la configuration des outils différés.

Nom	Type	Description	Obligatoire	Par défaut
description	chaîne ou null		Non
Exécution	OpenAI.ToolSearchExecutionType		Non
parameters	OpenAI.EmptyModelParam ou null		Non
type	enum	Type de l’outil. A toujours la valeur `tool_search`. Valeurs possibles : `tool_search`	Oui	tool_search

OpenAI.ToolType

Propriété	Valeur
Type	string
Valeurs	`function` `file_search` `computer` `computer_use_preview` `web_search` `mcp` `code_interpreter` `image_generation` `local_shell` `shell` `custom` `namespace` `tool_search` `web_search_preview` `apply_patch`

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 capacités du modèle, comme 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 MCP Tools.
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é logarithmique supérieure

Probabilité de journal supérieure d’un jeton.

Nom	Type	Obligatoire
octets	tableau d’entiers	Oui
logprob	Numéro	Oui
token	string	Oui

OpenAI.TypeParam

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éfinie sur `type`. Valeurs possibles : `type`	Oui	type

OpenAI.UrlCitationBody

Citation de l’URL

Citation d’une ressource web utilisée pour générer une réponse de modèle.

Nom	Type	Description	Obligatoire	Par défaut
end_index	entier	Index du dernier caractère de la citation d’URL dans le message.	Oui
start_index	entier	Index du premier caractère de la citation d’URL dans le message.	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_citation
url	chaîne (uri)	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
Description	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`.
Type	string
Valeurs	`low` `medium` `high`

OpenAI.WaitParam

Attendre

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éfinie sur `wait`. Valeurs possibles : `wait`	Oui	wait

OpenAI.WebSearchActionFind

Trouver l’action

Type d’action « find_in_page » : recherche un motif 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	chaîne (uri)	URL de la page recherchée pour le modèle.	Oui

OpenAI.WebSearchActionOpenPage

Action page ouverte

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	chaîne ou null	URL ouverte par le modèle.	Non

OpenAI.WebSearchActionSearchSearch

Action de recherche

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	chaîne (uri)		Oui

OpenAI.WebSearchApproximateLocation

Recherche web localisation approximative

Emplacement approximatif de l’utilisateur.

Nom	Type	Description	Obligatoire	Par défaut
Ville	chaîne ou null		Non
country	chaîne ou null		Non
region	chaîne ou null		Non
timezone	chaîne ou null		Non
type	enum	Type d’approximation d’emplacement. A toujours la valeur `approximate`. Valeurs possibles : `approximate`	Oui	Approximative

OpenAI.WebSearchPreviewTool

Aperçu de la recherche web

Remarque : web_search n’est pas encore disponible via Azure OpenAI.

Nom	Type	Description	Obligatoire	Par défaut
search_content_types	tableau d’OpenAI.SearchContentType		Non
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	web_search_preview
emplacement_utilisateur	OpenAI.ApproximateLocation ou null		Non

OpenAI.WebSearchTool

Recherche web

Remarque : web_search n’est pas encore disponible via Azure OpenAI.

Nom	Type	Description	Obligatoire	Par défaut
Filtres	OpenAI.WebSearchToolFilters ou null		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	moyenne
type	enum	Type de l’outil de recherche web. L’un de `web_search` ou `web_search_2025_08_26`. Valeurs possibles : `web_search`	Oui	recherche web
emplacement_utilisateur	OpenAI.WebSearchApproximateLocation ou null		Non

OpenAI.WebSearchToolFilters

Nom	Type	Description	Obligatoire	Par défaut
allowed_domains	tableau de chaînes ou null		Non

Last updated on 2026-07-10