Azure OpenAI dans Microsoft Foundry Models REST API preview reference

Cet article fournit des détails sur les terminaux d’inférence de l’API REST pour Azure OpenAI.

Spécifications de l’API

La gestion et l’interaction avec les modèles et ressources OpenAI Azure sont réparties sur trois surfaces principales d’API :

• Plan de contrôle
• Plan de données - création
• Plan de données - inférence

Chaque surface/spécification API englobe un ensemble différent de capacités Azure OpenAI. Chaque API possède son propre ensemble unique de versions d’aperçu et d’API stable/généralement disponibles (GA). Les sorties de prévisualisation suivent actuellement un rythme mensuel.

Important

Il existe désormais une nouvelle API d’inférence d’aperçu. Découvrez-en plus dans notre guide du cycle de vie de l’API.

API	Dernière version d’aperçu	Dernière sortie de GA	Spécifications	Description
Plan de contrôle	2025-07-01-preview	2025-06-01	Fichiers de spécifications	L’API du plan de contrôle est utilisée pour des opérations telles que la création de ressources, le déploiement de modèles et d’autres tâches de gestion des ressources de haut niveau. Le plan de contrôle régit également ce qui est possible à faire avec des fonctionnalités telles que Azure Resource Manager, Bicep, Terraform et Azure CLI.
Plan de données	v1 preview	v1	Fichiers de spécifications	L’API du plan de données contrôle les opérations d’inférence et d’authoring.

Authentication

Azure OpenAI propose deux méthodes d’authentification. Vous pouvez utiliser soit API Keys, soit Microsoft Entra ID.

• Authentification par clé API : Pour ce type d’authentification, toutes les requêtes API doivent inclure la clé API dans l’en-tête api-key HTTP. Le Quickstart fournit des conseils pour passer des appels avec ce type d’authentification.

• Microsoft Entra ID : Vous pouvez authentifier un appel API à l’aide d’un jeton Microsoft Entra. Les jetons d’authentification sont inclus dans une requête en tant qu’en-tête Authorization . Le jeton fourni doit être précédé de Bearer, par exemple Bearer YOUR_AUTH_TOKEN. Vous pouvez lire notre guide pratique sur authentifier avec Microsoft Entra ID.

Versionnement de l’API REST

Les API de service sont versionnées à l’aide du api-version paramètre de requête. Toutes les versions suivent la structure de dates YYYY-MM-DD. Par exemple:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Inférence dans les plans de données

Le reste de l’article traite de la version preview 2025-04-01-preview de la spécification d’inférence du plan de données OpenAI Azure.

Si vous recherchez de la documentation sur la dernière version de l’API GA, reportez-vous à la dernière API d’inférence du plan de données ga.

Complétions - Créer

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

Crée une complétion pour l’invite fournie, les paramètres et le modèle choisi.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
meilleures sélections	entier	Génère best_of des complétions côté serveur et retourne le « meilleur » (celui avec la plus grande probabilité logarithmique par jeton). Les résultats ne peuvent pas être diffusés en streaming. Lorsqu’elle est utilisée avec n, best_of contrôle le nombre de complétions candidates et n spécifie combien retourner ââ'¬â€œ best_of doit être supérieur à n. Note : Parce que ce paramètre génère de nombreuses complétions, il peut rapidement consommer votre quota de jetons. Utilisez avec soin et assurez-vous d’avoir des réglages raisonnables pour max_tokens et stop.	Non	1
echo	booléen	Faites écho à la consigne en plus de la complétion	Non	Faux
pénalité de fréquence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur fréquence existante dans le texte jusqu’à présent, diminuant la probabilité que le modèle répète la même phrase mot pour mot.	Non	0
logit_bias	Objet	Modifier la probabilité que des jetons spécifiés apparaissent dans la complétion. Accepte un objet JSON qui associe les jetons (spécifiés par leur identifiant de jeton dans le tokeniseur GPT) à une valeur de biais associée de -100 à 100. Mathématiquement, le biais est ajouté aux logits générés par le modèle avant l’échantillonnage. L’effet exact varie selon le modèle, mais les valeurs comprises entre -1 et 1 devraient diminuer ou augmenter la probabilité de sélection ; des valeurs comme -100 ou 100 devraient entraîner un bannissement ou une sélection exclusive du jeton concerné. Par exemple, vous pouvez passer {"50256": -100} pour empêcher la génération du <token |endoftext> .	Non	None
logprobs	entier	Incluez les probabilités logarithiques sur les logprobs jetons de sortie les plus probables, ainsi que les jetons choisis. Par exemple, si logprobs est 5, l’API renvoie une liste des 5 jetons les plus probables. L’API renvoie toujours le logprob du jeton échantillonné, donc il peut y avoir jusqu’à logprobs+1 jusqu’à des éléments dans la réponse. La valeur maximale pour logprobs est 5.	Non	None
nombre_maximal_de_tokens	entier	Le nombre maximal de jetons pouvant être générés dans la complétion. Le nombre de jetons de votre invite plus max_tokens ne peut pas dépasser la longueur contextuelle du modèle.	Non	16
n	entier	Combien de complétions générer pour chaque invite. Note : Parce que ce paramètre génère de nombreuses complétions, il peut rapidement consommer votre quota de jetons. Utilisez avec soin et assurez-vous d’avoir des réglages raisonnables pour max_tokens et stop.	Non	1
pénalité de présence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur apparence dans le texte jusqu’à présent, augmentant ainsi la probabilité du modèle d’aborder de nouveaux sujets.	Non	0
prompt	chaîne ou tableau	L’invite pour générer des complétions pour, encodée sous forme de chaîne, tableau de chaînes, tableau de jetons ou tableau de tableaux de jetons. Notez que <|endoftext|> est le séparateur de document que le modèle voit pendant l’entraînement, donc si une invite n’est pas spécifiée, le modèle se génère comme au début d’un nouveau document.	Oui
seed	entier	Si spécifié, notre système fait un meilleur effort pour échantillonner de manière déterministe, de sorte que des requêtes répétées avec les mêmes seed paramètres et doivent donner le même résultat. Le déterminisme n’est pas garanti, et vous devriez vous référer au system_fingerprint paramètre de réponse pour surveiller les changements dans le backend.	Non
Arrêter	chaîne ou tableau	Jusqu’à quatre séquences où l’API cesse de générer d’autres jetons. Le texte retourné ne contiendra pas la séquence d’arrêt.	Non
stream	booléen	Est-ce qu’il faut réintégrer un progrès partiel en détail. S’ils sont définis, les jetons sont envoyés comme des événements uniquement donnés par le serveur dès qu’ils deviennent disponibles, le flux étant terminé par un data: [DONE] message. Exemple Python code.	Non	Faux
Suffixe	string	Le suffixe qui vient après la fin du texte inséré. Ce paramètre n’est pris en charge que pour gpt-3.5-turbo-instruct.	Non	None
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	createCompletionResponse

Code de statut : par défaut

Description : Service indisponible

Type de contenu	Type	Description
application/json	errorResponse

Exemples

Example

Crée une complétion pour l’invite fournie, les paramètres et le modèle choisi.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Embeddings - Créer

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

Obtenez une représentation vectorielle d’une entrée donnée qui peut être facilement consommée par des modèles et algorithmes d’apprentissage automatique.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string	L’identifiant de déploiement du modèle qui a été déployé.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
dimensions	entier	Le nombre de dimensions que doivent avoir les embeddings de sortie résultantes. Pris en charge uniquement dans text-embedding-3 les modèles et les modèles ultérieurs.	Non
encoding_format	string	Le format pour renvoyer les embeddings. Peut être l’un ou l’autre float ou base64. Par défaut, .float	Non
entrée	chaîne ou tableau	Texte d’entrée pour l’intégrer, encodé sous forme de chaîne ou de tableau de jetons. Pour intégrer plusieurs entrées dans une seule requête, passez un tableau de chaînes ou un tableau de tableaux de jetons. L’entrée ne doit pas dépasser le maximum de jetons d’entrée pour le modèle (8 192 jetons pour text-embedding-ada-002), ne peut pas être une chaîne vide, et tout tableau doit avoir 2 048 dimensions ou moins. Outre la limite de jetons par entrée, tous les modèles d’incorporation appliquent un maximum de 300 000 jetons additionnés sur toutes les entrées dans une seule requête.	Oui
input_type	string	Type d’entrée de recherche d’intégration à utiliser	Non
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	Objet

Exemples

Example

Retournez les embeddings pour une invite donnée.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "input": [
  "this is a test"
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Complétions de chat - Créer

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Crée une complétion pour le message de chat

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
Audio	Objet	Paramètres pour la sortie audio. Requise lorsque la sortie audio est demandée avec modalities: ["audio"].	Non
└─ Format	enum	Spécifie le format audio de sortie. Doit être l’un des wavdeux , mp3, flac, opus, ou pcm16. Valeurs possibles : wav, mp3, flac, opus, pcm16	Non
└─ voix	enum	Précise le type de voix. Les voix soutenues sont alloy, echo, fable, onyx, nova, et shimmer. Valeurs possibles : alloy, echo, fable, onyx, nova, shimmer	Non
data_sources	tableau	Les entrées de configuration pour les extensions de chat Azure OpenAI qui les utilisent. Cette spécification supplémentaire n’est compatible qu’avec Azure OpenAI.	Non
pénalité de fréquence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur fréquence existante dans le texte jusqu’à présent, diminuant la probabilité que le modèle répète la même phrase mot pour mot.	Non	0
function_call	chaîne ou chatCompletionFunctionCallOption	Déprécié au profit de tool_choice. Contrôle quelle fonction (le cas échéant) est appelée par le modèle. none signifie que le modèle n’appellera pas de fonction et générera un message. auto signifie que le modèle peut choisir entre générer un message ou appeler une fonction. Spécifier une fonction particulière via {"name": "my_function"} force le modèle à appeler cette fonction. none est la fonction par défaut lorsqu’aucune fonction n’est présente. auto est la valeur par défaut si des fonctions sont présentes.	Non
functions	tableau	Déprécié au profit de tools. Une liste des fonctions pour lesquelles le modèle peut générer des entrées JSON.	Non
logit_bias	Objet	Modifier la probabilité que des jetons spécifiés apparaissent dans la complétion. Accepte un objet JSON qui associe les jetons (spécifiés par leur identifiant de jeton dans le tokenizador) à une valeur de biais associée de -100 à 100. Mathématiquement, le biais est ajouté aux logits générés par le modèle avant l’échantillonnage. L’effet exact varie selon le modèle, mais les valeurs comprises entre -1 et 1 devraient diminuer ou augmenter la probabilité de sélection ; des valeurs comme -100 ou 100 devraient entraîner un bannissement ou une sélection exclusive du jeton concerné.	Non	None
logprobs	booléen	S’il faut ou non retourner les probabilités logarithiques des jetons de sortie. Si c’est vrai, renvoie les probabilités logarithmitrophiques de chaque jeton de sortie retourné dans le content de message.	Non	Faux
max_completion_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une complétion, incluant les jetons de sortie visibles et les jetons de raisonnement.	Non
nombre_maximal_de_tokens	entier	Le nombre maximal de jetons pouvant être générés lors de la fin du chat. La longueur totale des jetons d’entrée et des jetons générés est limitée par la longueur du contexte du modèle.	Non
messages	tableau	Une liste des messages qui composent la conversation jusqu’à présent. Exemple Python code.	Oui
metadata	Objet	Étiquettes et valeurs définies par le développeur utilisées pour filtrer les complétions dans le tableau de bord des complétions stockées.	Non
Modalités	ChatCompletionModalities	Types de sortie que vous souhaitez que le modèle génère pour cette requête. La plupart des modèles sont capables de générer du texte, ce qui est le principe par défaut : ["text"] Le gpt-4o-audio-preview modèle peut également être utilisé pour générer de l’audio. Pour demander à ce modèle de générer à la fois des réponses textuelles et audio, vous pouvez utiliser : ["text", "audio"]	Non
n	entier	Combien de choix de fin de conversation générer pour chaque message d’entrée. Vous serez facturé en fonction du nombre de jetons générés dans toutes les options. Gardez n le minimum 1 pour minimiser les coûts.	Non	1
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
prediction	PredictionContent	Configuration pour une sortie prédite, qui peut grandement améliorer les temps de réponse lorsque de grandes parties de la réponse du modèle sont connues à l’avance. C’est le plus courant lorsque vous régénérez un fichier avec seulement des modifications mineures de la plupart du contenu.	Non
pénalité de présence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur apparence dans le texte jusqu’à présent, augmentant ainsi la probabilité du modèle d’aborder de nouveaux sujets.	Non	0
effort de raisonnement	enum	Uniquement les modèles O1 Limite l’effort de raisonnement pour les modèles de raisonnement. Les valeurs actuellement prises en charge sont low, medium, et high. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés pour raisonner dans une réponse. Valeurs possibles : low, medium, high	Non
format_de_réponse	ResponseFormatText ou ResponseFormatJsonObject ou ResponseFormatJsonSchema	Un objet spécifiant le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4o mini, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo plus récents que gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées, qui garantissent que le modèle correspond à votre schéma JSON fourni. Le réglage activant { "type": "json_object" } le mode JSON, qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
seed	entier	Cette fonctionnalité est en version Bêta. Si spécifié, notre système fait un meilleur effort pour échantillonner de manière déterministe, de sorte que des requêtes répétées avec les mêmes seed paramètres et doivent donner le même résultat. Le déterminisme n’est pas garanti, et vous devriez vous référer au system_fingerprint paramètre de réponse pour surveiller les changements dans le backend.	Non
Arrêter	chaîne ou tableau	Jusqu’à 4 séquences où l’API cesse de générer d’autres jetons.	Non
boutique	booléen	Savoir si la sortie de cette demande de complétion de chat doit être utilisée dans nos produits de distillation ou d’évaluation de modèles.	Non
stream	booléen	Si c’est défini, des deltas partiels de message sont envoyés, comme dans ChatGPT. Les jetons sont envoyés uniquement comme des événements envoyés par le serveur dès qu’ils deviennent disponibles, le flux étant interrompu par un data: [DONE] message. Exemple Python code.	Non	Faux
stream_options	chatCompletionStreamOptions	Options pour la réponse en streaming. Ne réglez cela que lorsque vous activez stream: true.	Non	None
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
tool_choice	chatCompletionToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none cela signifie que le modèle n’appellera aucun outil et générera un message à la place. 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. Spécifier un outil particulier force {"type": "function", "function": {"name": "my_function"}} le modèle à appeler cet outil. none est la norme par défaut lorsqu’aucun outil n’est présent. auto est la norme par défaut si des outils sont présents.	Non
Outils	tableau	Une liste d’outils que le modèle peut appeler. Actuellement, seules les fonctions sont prises en charge comme outil. Utilisez cela pour fournir une liste des fonctions pour lesquelles le modèle peut générer des entrées JSON. Un maximum de 128 fonctions sont pris en charge.	Non
top_logprobs	entier	Un entier compris entre 0 et 20 spécifiant le nombre de jetons les plus susceptibles de revenir à chaque position de jeton, chacun avec une probabilité logarithmique associée. logprobs doit être fixé à true si ce paramètre est utilisé.	Non
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non
user_security_context	userSecurityContext	Le contexte de sécurité utilisateur contient plusieurs paramètres qui décrivent l’application d’IA elle-même et l’utilisateur final qui interagit avec l’application IA. Ces domaines aident vos équipes d’opérations de sécurité à enquêter et à atténuer les incidents de sécurité en proposant une approche globale pour protéger vos applications d’IA. En savoir plus sur la protection des applications d’IA utilisant Microsoft Defender for Cloud.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	Objet

Code de statut : par défaut

Description : Service indisponible

Type de contenu	Type	Description
application/json	errorResponse

Exemples

Example

Crée une complétion pour l’invite fournie, les paramètres et le modèle choisi.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion basée sur les données Azure Search et l’identité managée assignée au système.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion basée sur les données vectorielles d’image Azure Search.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion basée sur les données du vecteur de recherche Azure, le message d’assistant précédent et l’identité gérée attribuée par l’utilisateur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion pour la Azure Cosmos DB fournie.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion pour la base de données Mongo fournie.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion pour l’Elasticsearch fourni.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Crée une complétion pour la ressource Pinepome fournie.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transcriptions - Créer

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Transcrit l’audio dans la langue d’entrée.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : multipart/form-data

Nom	Catégorie	Description	Obligatoire	Par défaut
model	string	ID du modèle à utiliser. Les options sont gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1, et gpt-4o-transcribe-diarize.	Oui
fichier	string	L’objet du fichier audio à transcrire.	Oui
language	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 améliore la précision et la latence.	Non
prompt	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. La consigne doit correspondre au langage audio.	Non
format_de_réponse	audioResponseFormat	Définit le format de la sortie.	Non
Température	number	La température d’échantillonnage, comprise entre 0 et 1. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Si elle est réglée à 0, le modèle utilise la probabilité logarithmique pour augmenter automatiquement la température jusqu’à atteindre certains seuils.	Non	0
timestamp_granularities[]	tableau	Les détails temporels à remplir pour cette transcription. response_format doit être réglé verbose_json pour utiliser des granularités horodatages. L’une ou l’autre de ces options est prise en charge : word, ou segment. Remarque : Il n’y a pas de latence supplémentaire pour les horodatages de segments, mais la génération de horodatages de mots entraîne une latence supplémentaire.	Non	['segment']

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	Objet
texte brut	string	Texte transcrit dans le format de sortie (lorsque response_format était l’un des text, vtt ou srt).

Exemples

Example

Obtient le texte transcrit et les métadonnées associées à partir des données audio parlées fournies.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Obtient le texte transcrit et les métadonnées associées à partir des données audio parlées fournies.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Réponses : Code de statut : 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Traductions - Create

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

Transcrit et traduit l’audio d’entrée en texte anglais.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : multipart/form-data

Nom	Catégorie	Description	Obligatoire	Par défaut
fichier	string	Le fichier audio à traduire.	Oui
prompt	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. Le prompt doit être en anglais.	Non
format_de_réponse	audioResponseFormat	Définit le format de la sortie.	Non
Température	number	La température d’échantillonnage, comprise entre 0 et 1. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Si elle est réglée à 0, le modèle utilise la probabilité logarithmique pour augmenter automatiquement la température jusqu’à atteindre certains seuils.	Non	0

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	Objet
texte brut	string	Texte transcrit au format de sortie (quand response_format était un texte de texte, vtt ou srt).

Exemples

Example

Obtient le texte transcrit en anglais et les métadonnées associées à partir des données audio parlées fournies.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Réponses : Code de statut : 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Obtient le texte transcrit en anglais et les métadonnées associées à partir des données audio parlées fournies.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Réponses : Code de statut : 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Parole - Créer

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Génère de l’audio à partir du texte d’entrée.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : multipart/form-data

Nom	Catégorie	Description	Obligatoire	Par défaut
entrée	string	Le texte pour synthétiser l’audio. La longueur maximale est de 4 096 caractères.	Oui
format_de_réponse	enum	Le format pour synthétiser l’audio. Valeurs possibles : mp3, opus, aac, flac, wav, pcm	Non
Vitesse	number	La vitesse de l’audio synthétisé. Sélectionnez une valeur de 0.25 vers 4.0. 1.0 est la norme par défaut.	Non	1.0
Voix	enum	La voix à utiliser pour la synthèse vocale. Valeurs possibles : alloy, echo, fable, onyx, nova, shimmer	Oui

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/octet-stream	string

Exemples

Example

Synthétise l’audio à partir du texte fourni.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Réponses : Code de statut : 200

{
  "body": "101010101"
}

Générations d’images - Créer

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Génère un lot d’images à partir d’une légende texte sur un déploiement donné du modèle de génération d’images

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
Arrière-plan	imageBackground	Permet de définir la transparence pour l’arrière-plan des images générées. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1.	Non	auto
n	entier	Le nombre d’images à générer. Pour dall-e-3, seul n=1 est pris en charge.	Non	1
compression_de_sortie	entier	Le niveau de compression (0-100%) pour les images générées. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1 avec le format de sortie jpeg.	Non	100
format de sortie	imagesOutputFormat	Le format de fichier dans lequel les images générées sont renvoyées. Pris en charge uniquement pour les modèles de la série GPT-image-1.	Non	png
prompt	string	Une description textuelle de l’image ou des images souhaitées. La longueur maximale est de 32 000 caractères pour la série gpt-image-1 et de 4 000 caractères pour dall-e-3	Oui
images partielles	entier	Le nombre d’images partielles à générer. Ce paramètre est utilisé pour les réponses en flux qui retournent des images partielles. La valeur doit être comprise entre 0 et 3. Lorsqu’elle est réglée à 0, la réponse sera une seule image envoyée lors d’un événement de streaming. Notez que l’image finale peut être envoyée avant que le nombre complet d’images partielles ne soit généré si l’image complète est générée plus rapidement.	0
stream	booléen	Modifie l’image en mode streaming.	non	false
Qualité	imageQuality	La qualité de l’image qui sera générée.	Non	auto
format_de_réponse	imagesResponseFormat	Le format dans lequel les images générées sont renvoyées. Ce paramètre n’est pas pris en charge pour gpt-image-1les modèles en série qui retournent toujours des images encodées en base64. Valeurs possibles : url, b64_json.	Non	url
size	imageSize	La taille des images générées.	Non	auto
style	imageStyle	Le style des images générées. Pris en charge uniquement pour DALL-E-3.	Non	vivid
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

Responses

Code de statut : 200

Description : Ok

Type de contenu	Type	Description
application/json	generateImagesResponse

Code de statut : par défaut

Description : Une erreur s’est produite.

Type de contenu	Type	Description
application/json	dalleErrorResponse

Exemples

Example

Crée des images à partir d’une invitation.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Réponses : Code de statut : 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Générations d’images - Modifier

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Modifie une image à partir d’une légende texte sur un déploiement donné du modèle gpt-image-1

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
id-de-déploiement	path	Oui	string
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : multipart/form-data

Nom	Catégorie	Description	Obligatoire	Par défaut
image	chaîne ou tableau	L’image à modifier. Il doit s’agir d’un fichier image pris en charge ou d’un tableau d’images. Chaque image doit être un fichier png ou jpg de moins de 50 Mo.	Oui
input_fidelity	string	Contrôlez l’effort que le modèle fournira pour correspondre au style et aux caractéristiques, en particulier aux traits du visage, des images d’entrée. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1. Supports high et low.	non	low.
Masque	string	Une image supplémentaire dont les zones entièrement transparentes (par exemple, où alpha est zéro) indiquent où l’image doit être éditée. Si plusieurs images sont fournies, le masque sera appliqué sur la première image. Il doit s’agir d’un fichier PNG valide, de moins de 4 Mo, et avoir les mêmes dimensions que l’image.	Non
n	entier	Le nombre d’images à générer. Ça doit être entre 1 et 10 ans.	Non	1
prompt	string	Une description textuelle de l’image ou des images souhaitées. La longueur maximale est de 32 000 caractères.	Oui
Qualité	imageQuality	La qualité de l’image qui sera générée.	Non	auto
images partielles	Le nombre d’images partielles à générer. Ce paramètre est utilisé pour les réponses en flux qui retournent des images partielles. La valeur doit être comprise entre 0 et 3. Lorsqu’elle est réglée à 0, la réponse sera une seule image envoyée lors d’un événement de streaming. Notez que l’image finale peut être envoyée avant que le nombre complet d’images partielles ne soit généré si l’image complète est générée plus rapidement.
stream	booléen	Modifie l’image en mode streaming.	non	false
format_de_réponse	imagesResponseFormat	Le format dans lequel les images générées sont renvoyées.	Non	url
size	imageSize	La taille des images générées.	Non	auto
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

Responses

Code de statut : 200

Description : Ok

Type de contenu	Type	Description
application/json	generateImagesResponse

Code de statut : par défaut

Description : Une erreur s’est produite.

Type de contenu	Type	Description
application/json	dalleErrorResponse

Liste - Assistants

Note

L’API des assistants est désuétude et sera retirée du service le 26 août 2026. Utilisez le service d’agents de fonderie Microsoft généralement disponible. Suivez le guide de migration pour mettre à jour vos charges de travail. En savoir plus.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Retourne une liste d’assistants.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listAssistantsResponse

Exemples

Example

Retourne une liste d’assistants.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Créer - Assistant

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Créez un assistant avec un modèle et des instructions.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	La description de l’assistant. La longueur maximale est de 512 caractères.	Non
consignes	string	Les instructions système que l’assistant utilise. La longueur maximale est de 256 000 caractères.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string		Oui
name	string	Le nom de l’assistante. La longueur maximale est de 256 caractères.	Non
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le stockage vectoriel est attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
└ vector_stores	tableau	Un assistant pour créer un stockage vectoriel avec file_ids et l’attacher à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Une liste des outils activés sur l’assistant. Il peut y avoir un maximum de 128 outils par assistant. Les outils peuvent être de types code_interpreter, retrieval, ou function.	Non	[]
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	assistantObject

Exemples

Example

Créez un assistant avec un modèle et des instructions.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Obtenez - Assistant

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Il récupère un assistant.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
assistant_id	path	Oui	string	La pièce d’identité de l’assistant à récupérer.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	assistantObject

Exemples

Example

Il récupère un assistant.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modifier - Assistant

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Modifie un assistant.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
assistant_id	path	Oui	string	L’ID de l’assistant à modifier.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	La description de l’assistant. La longueur maximale est de 512 caractères.	Non
consignes	string	Les instructions système que l’assistant utilise. La longueur maximale est de 32 768 caractères.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string		Non
name	string	Le nom de l’assistante. La longueur maximale est de 256 caractères.	Non
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Outrepasse la liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Remplace le stockage vectoriel attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Une liste des outils activés sur l’assistant. Il peut y avoir un maximum de 128 outils par assistant. Les outils peuvent être de types code_interpreter, retrieval, ou function.	Non	[]
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	assistantObject

Exemples

Example

Modifie un assistant.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Supprimer - Assistant

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Supprimez un assistant.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
assistant_id	path	Oui	string	L’ID de l’assistant à supprimer.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	deleteAssistantResponse

Exemples

Example

Supprime un assistant.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Créer - Fil de discussion

Note

L’API des assistants est désuétude et sera retirée du service le 26 août 2026. Utilisez le service d’agents de fonderie Microsoft généralement disponible. Suivez le guide de migration pour mettre à jour vos charges de travail. En savoir plus.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Créez un fil de discussion.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
messages	tableau	Une liste de messages pour commencer le fil.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
tool_resources	Objet	Un ensemble de ressources mises à disposition des outils de l’assistant dans ce fil. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le magasin vectoriel attaché à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non
└ vector_stores	tableau	Un assistant pour créer un stockage vectoriel avec file_ids et l’attacher à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	threadObject

Exemples

Example

Ça crée un fil de discussion.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Obtenez - Fil

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Récupère un fil.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant du fil à récupérer.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	threadObject

Exemples

Example

Récupère un fil.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modifier - Thread

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Modifie un fil de discussion.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant du fil à modifier. Seuls les metadata modèles peuvent être modifiés.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
tool_resources	Objet	Un ensemble de ressources mises à disposition des outils de l’assistant dans ce fil. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le magasin vectoriel attaché à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	threadObject

Exemples

Example

Modifie un fil de discussion.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Supprimer - Fil de discussion

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Supprimez un fil.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant du fil à supprimer.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	deleteThreadResponse

Exemples

Example

Supprime un fil.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Liste - Messages

Note

L’API des assistants est désuétude et sera retirée du service le 26 août 2026. Utilisez le service d’agents de fonderie Microsoft généralement disponible. Suivez le guide de migration pour mettre à jour vos charges de travail. En savoir plus.

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Renvoie une liste de messages pour un fil donné.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant des threads auxquels appartiennent les messages.
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
run_id	Requête	Non	string	Filtrez les messages selon l’identifiant de la sortie qui les a générés.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listMessagesResponse

Exemples

Example

Répertorier les messages

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Créer - Message

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Créez un message.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’ID des threads pour créer un message.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
attachments	tableau	Une liste des fichiers attachés au message, et les outils auxquels ils doivent être ajoutés.	Non
contenu	string	Le contenu du message.	Oui
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
role	string	Le rôle de l’entité qui crée le message. Les valeurs autorisées incluent : - user: Indique que le message est envoyé par un utilisateur réel et doit être utilisé dans la plupart des cas pour représenter des messages générés par l’utilisateur. - assistant: Indique que le message est généré par l’assistant. Utilisez cette valeur pour insérer des messages de l’assistant dans la conversation.	Oui

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	messageObject

Exemples

Example

Créez un message.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Obtenir - Message

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Récupérez un message.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’ID des threads auxquels ce message appartient.
message_id	path	Oui	string	L’identifiant du message à récupérer.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	messageObject

Exemples

Example

Récupérez un message.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Modifier - Message

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Modifie un message.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant du fil auquel ce message appartient.
message_id	path	Oui	string	L’ID du message à modifier.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	messageObject

Exemples

Example

Modifier un message.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Créer - Thread et exécuter

Note

L’API des assistants est désuétude et sera retirée du service le 26 août 2026. Utilisez le service d’agents de fonderie Microsoft généralement disponible. Suivez le guide de migration pour mettre à jour vos charges de travail. En savoir plus.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Créez un fil et exécutez-le en une seule requête.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
assistant_id	string	L’identifiant de l’assistant à utiliser pour exécuter cette course.	Oui
consignes	string	Écrase le message système par défaut de l’assistant. Cela est utile pour modifier le comportement par exécution.	Non
max_completion_tokens	entier	Le nombre maximal de jetons de complétion pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de complétion spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons d’achèvement spécifiés, elle se termine avec un statut incomplete. Voir incomplete_details pour plus d’informations.	Non
max_prompt_tokens	entier	Le nombre maximal de jetons de prompt pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de prompt spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons de prompt spécifiés, la série se termine avec le statut incomplete. Voir incomplete_details pour plus d’informations.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string	L’identifiant des modèles à utiliser pour exécuter cette exécution. Si une valeur est fournie ici, elle supprimera le modèle associé à l’assistant. Sinon, le modèle associé à l’assistant sera utilisé.	Non
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
stream	booléen	Si true, renvoie un flux d’événements qui se produisent pendant la Run comme événements envoyés par le serveur, se terminant lorsque la Run entre dans un état terminal avec un data: [DONE] message.	Non
stream_options	chatCompletionStreamOptions	Options pour la réponse en streaming. Ne réglez cela que lorsque vous activez stream: true.	Non	None
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
fil	createThreadRequest		Non
tool_choice	assistantsApiToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none cela signifie que le modèle n’appellera aucun outil et générera un message à la place. auto est la valeur par défaut et signifie que le modèle peut choisir entre générer un message ou appeler un outil. Spécifier un outil particulier comme {"type": "file_search"} ou {"type": "function", "function": {"name": "my_function"}} force le modèle à appeler cet outil.	Non
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	L’identifiant du magasin vectoriel attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Écartez les outils que l’assistant peut utiliser pour cette course. Cela est utile pour modifier le comportement par exécution.	Non
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1
truncation_strategy	truncationObject	Contrôles sur la façon dont un thread sera tronqué avant la sortie. Utilisez cela pour contrôler la fenêtre de contexte initiale de la partie.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runObject

Exemples

Example

Créez un fil et exécutez-le en une seule requête.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Liste - Points

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Retourne une liste des exécutions appartenant à un thread.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’ID du thread auquel appartient la séance.
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listRunsResponse

Exemples

Example

Retourne une liste des exécutions appartenant à un thread.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Créer - Courir

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Créez une course.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’ID du fil à exécuter.
include[]	Requête	Non	tableau	Une liste de champs supplémentaires à inclure dans la réponse. Actuellement, la seule valeur prise en charge est step_details.tool_calls[*].file_search.results[*].content de récupérer le contenu des résultats de recherche du fichier.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
additional_instructions	string	Ajoute des instructions supplémentaires à la fin des instructions pour la sélection. Cela est utile pour modifier le comportement par exécution sans outrepasser d’autres instructions.	Non
additional_messages	tableau	Ajoute des messages supplémentaires au fil avant de créer la séquence.	Non
assistant_id	string	L’identifiant de l’assistant à utiliser pour exécuter cette course.	Oui
consignes	string	Écrase le message système par défaut de l’assistant. Cela est utile pour modifier le comportement par exécution.	Non
max_completion_tokens	entier	Le nombre maximal de jetons de complétion pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de complétion spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons d’achèvement spécifiés, elle se termine avec un statut incomplete. Voir incomplete_details pour plus d’informations.	Non
max_prompt_tokens	entier	Le nombre maximal de jetons de prompt pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de prompt spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons de prompt spécifiés, la série se termine avec le statut incomplete. Voir incomplete_details pour plus d’informations.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string	L’ID du modèle à utiliser pour exécuter cette exécution. Si une valeur est fournie ici, elle supprimera le modèle associé à l’assistant. Sinon, le modèle associé à l’assistant sera utilisé.	Non
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
stream	booléen	Si true, renvoie un flux d’événements qui se produisent pendant la Run comme événements envoyés par le serveur, se terminant lorsque la Run entre dans un état terminal avec un data: [DONE] message.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_choice	assistantsApiToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none cela signifie que le modèle n’appellera aucun outil et générera un message à la place. auto est la valeur par défaut et signifie que le modèle peut choisir entre générer un message ou appeler un outil. Spécifier un outil particulier comme {"type": "file_search"} ou {"type": "function", "function": {"name": "my_function"}} force le modèle à appeler cet outil.	Non
Outils	tableau	Écartez les outils que l’assistant peut utiliser pour cette course. Cela est utile pour modifier le comportement par exécution.	Non
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1
truncation_strategy	truncationObject	Contrôles sur la façon dont un thread sera tronqué avant la sortie. Utilisez cela pour contrôler la fenêtre de contexte initiale de la partie.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runObject

Exemples

Example

Créez une course.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Vas-y, cours

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Il récupère une course.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant des threads qui ont été exécutés.
run_id	path	Oui	string	L’identifiant de la course à récupérer.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runObject

Exemples

Example

Il se dépêche.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Modifier - Run

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Modifie une partie.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant des threads qui ont été exécutés.
run_id	path	Oui	string	L’ID de la course à modifier.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runObject

Exemples

Example

Modifie une partie.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Soumettre - Sorties d’outils à exécuter

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Lorsqu’une exécution a le status: "requires_action" et required_action.type est submit_tool_outputs, ce point de terminaison peut être utilisé pour soumettre les sorties des appels d’outils une fois qu’elles sont toutes terminées. Toutes les sorties doivent être soumises dans une seule demande.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’ID des threads auxquels cette exécution appartient.
run_id	path	Oui	string	L’identifiant de la run qui nécessite la soumission de la sortie de l’outil.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
stream	booléen	Si true, renvoie un flux d’événements qui se produisent pendant la Run comme événements envoyés par le serveur, se terminant lorsque la Run entre dans un état terminal avec un data: [DONE] message.	Non
tool_outputs	tableau	Une liste des outils pour lesquels les résultats sont soumis.	Oui

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runObject

Exemples

Example

Lorsqu’une exécution a le status: "requires_action" et required_action.type est submit_tool_outputs, ce point de terminaison peut être utilisé pour soumettre les sorties des appels d’outils une fois qu’elles sont toutes terminées. Toutes les sorties doivent être soumises dans une seule demande.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Annuler - Courir

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Annule une partie qui est in_progress.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant du thread auquel cette exécution appartient.
run_id	path	Oui	string	L’ID de la course à annuler.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runObject

Exemples

Example

Annule une partie qui est in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Liste - Run Steps

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Retourne une liste des étapes de run appartenant à une run.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’ID du thread auquel appartiennent les étapes d’exécution et d’exécution.
run_id	path	Oui	string	L’ID de la course à laquelle appartiennent les étapes de run.
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
version de l'API	Requête	Oui	string
include[]	Requête	Non	tableau	Une liste de champs supplémentaires à inclure dans la réponse. Actuellement, la seule valeur prise en charge est step_details.tool_calls[*].file_search.results[*].content de récupérer le contenu des résultats de recherche du fichier.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listRunStepsResponse

Exemples

Example

Retourne une liste des étapes de run appartenant à une run.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Passe - Cours

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Il récupère une marche de course.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
thread_id	path	Oui	string	L’identifiant du thread auquel appartient l’étape run et run.
run_id	path	Oui	string	L’identifiant de la course à laquelle appartient l’étape de la séquence.
step_id	path	Oui	string	L’ID de l’étape de course à récupérer.
include[]	Requête	Non	tableau	Une liste de champs supplémentaires à inclure dans la réponse. Actuellement, la seule valeur prise en charge est step_details.tool_calls[*].file_search.results[*].content de récupérer le contenu des résultats de recherche du fichier.
version de l'API	Requête	Oui	string

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	runStepObject

Exemples

Example

Il récupère une marche de course.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Liste - Magasins vectoriels

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Retourne une liste de magasins vectoriels.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listVectorStoresResponse

Exemples

Example

Retourne une liste de magasins vectoriels.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Créer - Magasin vectoriel

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Créez un magasin vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	autoChunkingStrategyRequestParam ou staticChunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie. Applicable seulement si file_ids elle est non vide.	Non
expire_après	vectorStoreExpirationAfter	La politique d’expiration pour un magasin vectoriel.	Non
identifiants_de_fichiers	tableau	Une liste des identifiants de fichiers que le stockage vectoriel devrait utiliser. Utile pour ce file_search genre d’outils qui peuvent accéder aux fichiers.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
name	string	Le nom du magasin vectoriel.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreObject

Exemples

Example

Crée un magasin vectoriel.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Obtenir - Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Récupère un stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’ID du magasin vectoriel à récupérer.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreObject

Exemples

Example

Récupère un stockage vectoriel.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modifier - Stockage vectoriel

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Modifie un magasin vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’ID du stockage vectoriel à modifier.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
expire_après	vectorStoreExpirationAfter	La politique d’expiration pour un magasin vectoriel.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
name	string	Le nom du magasin vectoriel.	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreObject

Exemples

Example

Modifie un magasin vectoriel.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Supprimer - Stockage vectoriel

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Supprime un magasin vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’ID du magasin vectoriel à supprimer.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	deleteVectorStoreResponse

Exemples

Example

Ça supprime un magasin vectoriel.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Liste - Fichiers de stockage vectoriel

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Retourne une liste de fichiers de stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel auquel appartiennent les fichiers.
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
filter	Requête	Non	string Valeurs possibles : in_progress, completed, failed, cancelled	Filtrez par statut du fichier. L’un des in_progress, completed, failed, cancelled.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listVectorStoreFilesResponse

Exemples

Example

Retourne une liste de fichiers de stockage vectoriel.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Create - fichier de stockage vectoriel

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Créez un fichier de stockage vectoriel en associant un fichier à un stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’ID du magasin vectoriel pour lequel créer un fichier.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	chunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie.	Non
identifiant_de_fichier	string	Un identifiant de fichier que le stockage vectoriel devrait utiliser. Utile pour ce file_search genre d’outils qui peuvent accéder aux fichiers.	Oui

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreFileObject

Exemples

Example

Créez un fichier de stockage vectoriel en associant un fichier à un stockage vectoriel.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Réponses : Code de statut : 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - fichier Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Récupère un fichier de stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel auquel appartient le fichier.
identifiant_de_fichier	path	Oui	string	L’identifiant du fichier récupéré.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreFileObject

Exemples

Example

Récupère un fichier de stockage vectoriel.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Supprimer - fichier de stockage vectoriel

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Supprime un fichier de stockage vectoriel. Cela retirera le fichier du magasin vectoriel mais le fichier lui-même ne sera pas supprimé. Pour supprimer le fichier, utilisez le point de terminaison supprimer le fichier.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel auquel appartient le fichier.
identifiant_de_fichier	path	Oui	string	L’ID du fichier à supprimer.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	deleteVectorStoreFileResponse

Exemples

Example

Supprime un fichier de stockage vectoriel. Cela retirera le fichier du magasin vectoriel mais le fichier lui-même ne sera pas supprimé. Pour supprimer le fichier, utilisez le point de terminaison supprimer le fichier.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Mettre à jour les attributs sur un fichier de stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant de la mémoire vectorielle à laquelle appartient le fichier.
identifiant_de_fichier	path	Oui	string	L’ID du fichier pour mettre à jour les attributs.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
attributes	VectorStoreFileAttributes	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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères, des booléens ou des nombres.	Oui

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreFileObject

Récupérer le contenu du fichier de stockage vectoriel

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Récupérez le contenu analysé d’un fichier de stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’ID du magasin vectoriel.
identifiant_de_fichier	path	Oui	string	L’identifiant du fichier dans le magasin vectoriel.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	VectorStoreFileContentResponse

Stockage vectoriel de recherche

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Recherchez dans un magasin vectoriel les chunks pertinents à partir d’un filtre d’attributs de requête et de fichier.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’ID du magasin vectoriel à rechercher.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
Filtres	Filtre de comparaison ou filtre composé	Un filtre à appliquer basé sur les attributs du fichier.	Non
nombre_maximal_de_résultats	entier	Le nombre maximal de résultats à revendre. Ce nombre devrait être compris entre 1 et 50.	Non	10
Requête	chaîne ou tableau	Une chaîne de requête pour une recherche	Oui
options_de_classement	Objet	Options de classement pour la recherche.	Non
└─ classificateur	enum	Valeurs possibles : auto, default-2024-11-15	Non
└score_threshold	number		Non	0
rewrite_query	booléen	S’il faut réécrire la requête en langage naturel pour la recherche vectorielle.	Non	Faux

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	VectorStoreSearchResultsPage

Create - Fichier de stockage vectoriel par lots

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Créez un lot de fichiers de stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel pour créer un File Batch.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	chunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie.	Non
identifiants_de_fichiers	tableau	Une liste des identifiants de fichiers que le magasin vectoriel devrait utiliser. Utile pour ce file_search genre d’outils qui peuvent accéder aux fichiers.	Oui

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreFileBatchObject

Exemples

Example

Créez un lot de fichiers de stockage vectoriel.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Réponses : Code de statut : 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - Fichier Vector Store Batch

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Récupère un lot de fichiers de stockage vectoriel.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel auquel appartient le lot de fichiers.
batch_id	path	Oui	string	L’identifiant du lot de fichiers récupéré.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreFileBatchObject

Exemples

Example

Récupère un lot de fichiers de stockage vectoriel.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Annuler - Fichier de stockage vectoriel par lots

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Annulez un lot de fichiers de stockage vectoriel. Cela tente d’annuler le traitement des fichiers dans ce lot le plus rapidement possible.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel auquel appartient le lot de fichiers.
batch_id	path	Oui	string	L’identifiant du lot de fichiers à annuler.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	vectorStoreFileBatchObject

Exemples

Example

Annulez un lot de fichiers de stockage vectoriel. Cela tente d’annuler le traitement des fichiers dans ce lot le plus rapidement possible.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Liste - Fichiers batch de stockage vectoriel

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Retourne une liste de fichiers de stockage vectoriel en batch.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
vector_store_id	path	Oui	string	L’identifiant du magasin vectoriel auquel appartiennent les fichiers.
batch_id	path	Oui	string	L’ID du lot de fichiers auquel appartiennent les fichiers.
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	Triez selon l’horodatage created_at des objets. asc pour l’ordre croissant et desc l’ordre décroissant.
Après	Requête	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 faites une demande de liste et recevez 100 objets, se terminant par obj_foo, votre appel suivant peut inclure après = obj_foo afin de récupérer la page suivante de la liste.
before	Requête	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 faites une requête de liste et recevez 100 objets, en commençant par obj_foo, votre appel suivant peut inclure avant=obj_foo afin de récupérer la page précédente de la liste.
filter	Requête	Non	string Valeurs possibles : in_progress, completed, failed, cancelled	Filtrez par statut du fichier. L’un des in_progress, completed, failed, cancelled.
version de l'API	Requête	Oui	string	version de l’API

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	listVectorStoreFilesResponse

Exemples

Example

Retourne une liste de fichiers de stockage vectoriel.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Réponses : Code de statut : 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Créer - Session en Temps Réel

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Créez un jeton API éphémère pour une utilisation dans les applications côté client avec l’API Temps Réel. Peut être configuré avec les mêmes paramètres de session que l’événement session.update client. Il répond par un objet de session, ainsi qu’une client_secret clé contenant un jeton éphémère d’API utilisable pouvant être utilisé pour authentifier les clients navigateurs de l’API en temps réel.

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
input_audio_format	enum	Le format de l’audio d’entrée. Les options sont pcm16, g711_ulaw, ou g711_alaw. Pour pcm16, l’audio d’entrée doit être PCM 16 bits à un taux d’échantillonnage de 24 kHz, un seul canal (mono) et un ordre d’octets little-endian. Valeurs possibles : pcm16, g711_ulaw, g711_alaw	Non
input_audio_noise_reduction	Objet	Configuration pour la réduction du bruit audio en entrée. Cela peut être configuré pour null désactiver. La réduction de bruit filtre l’audio ajouté au tampon audio d’entrée avant qu’il ne soit envoyé au VAD et au modèle. Le filtrage audio peut améliorer la précision de la détection des VAD et des virages (réduisant les faux positifs) ainsi que la performance du modèle en améliorant la perception de l’audio en entrée.	Non
└─ Type	enum	Un type de réduction du bruit. near_field est pour les microphones à dialogue rapproché comme les casques, far_field pour les microphones à distance comme les ordinateurs portables ou les microphones de salle de conférence. Valeurs possibles : near_field, far_field	Non
input_audio_transcription	Objet	Configuration pour la transcription audio d’entrée, par défaut désactivée et peut être configurée pour null s’éteindre une fois activée. La transcription audio en entrée n’est pas native au modèle, car celui-ci consomme directement l’audio. La transcription s’exécute de manière asynchrone via le point de terminaison Transcriptions et doit être traitée comme une orientation du contenu audio d’entrée plutôt que comme ce que le modèle a entendu précisément. Le client peut optionnellement définir la langue et la demande de transcription, ce qui offre des conseils supplémentaires au service de transcription.	Non
└─ Langue	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 (par exemple en) améliore la précision et la latence.	Non
└─ Modèle	string	Le modèle à utiliser pour la transcription, les options actuelles sont gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, et whisper-1.	Non
└─ invite	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. Pour whisper-1, l’invite est une liste de mots-clés. Pour les gpt-4o-transcribe modèles, la demande est une chaîne de texte libre, par exemple « attendez-vous à des mots liés à la technologie ».	Non
consignes	string	Les instructions système par défaut (c’est-à-dire le message système) précédaient les appels de modèle. Ce champ permet au client de guider le modèle sur les réponses souhaitées. Le modèle peut être instruit sur le contenu et le format des réponses (par exemple « soyez extrêmement concis », « soyez amical », « voici des exemples de bonnes réponses ») et sur le comportement audio (par exemple « parlez vite », « injectez de l’émotion dans votre voix », « riez fréquemment »). Les instructions ne sont pas garanties d’être suivies par le modèle, mais elles fournissent des indications au modèle sur le comportement souhaité. Notez que le serveur définit des instructions par défaut qui seront utilisées si ce champ n’est pas défini et qui sont visibles lors de l’événement session.created au début de la session.	Non
max_response_output_tokens	entier ou chaîne	Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, incluant les appels d’outils. Fournir un entier compris entre 1 et 4096 pour limiter les jetons de sortie, ou inf pour le nombre maximal de jetons disponibles pour un modèle donné. Par défaut, .inf	Non
Modalités		L’ensemble des modalités auxquelles le modèle peut répondre. Pour désactiver l’audio, réglez cela sur [« texte »].	Non
model	string	Le nom du déploiement utilisé pour cette session.	Non
output_audio_format	enum	Le format de l’audio de sortie. Les options sont pcm16, g711_ulaw, ou g711_alaw. Pour pcm16, l’audio de sortie est échantillonné à un débit de 24 kHz. Valeurs possibles : pcm16, g711_ulaw, g711_alaw	Non
Température	number	Température d’échantillonnage pour le modèle, limitée à [0,6, 1,2]. Pour les modèles audio, une température de 0,8 est fortement recommandée pour de meilleures performances.	Non	0.8
tool_choice	string	Comment le modèle choisit les outils. Les options sont auto, none, required, ou spécifier une fonction.	Non	auto
Outils	tableau	Outils (fonctions) disponibles pour le modèle.	Non
turn_detection	Objet	Configuration pour la détection de tour, VAD serveur ether ou VAD sémantique. Cela peut être configuré pour null désactiver, auquel cas le client doit déclencher manuellement la réponse du modèle. Le VAD serveur signifie que le modèle détecte le début et la fin de la parole en fonction du volume audio et répond à la fin de la parole de l’utilisateur. Le VAD sémantique est plus avancé et utilise un modèle de détection de virage (en conjonction avec le VAD) pour estimer sémantiquement si l’utilisateur a terminé de parler, puis fixe dynamiquement un délai d’attente basé sur cette probabilité. Par exemple, si l’audio de l’utilisateur s’éteint avec uhhm, le modèle obtiendra une faible probabilité de fin de tour et attendra plus longtemps que l’utilisateur continue à parler. Cela peut être utile pour des conversations plus naturelles, mais peut avoir une latence plus élevée.	Non
└─create_response	booléen	S’il faut ou non générer automatiquement une réponse lorsqu’un arrêt VAD se produit.	Non	True
└─ enthousiasme	enum	Utilisé uniquement pour le semantic_vad mode. L’empressement du modèle à répondre. low attendra plus longtemps que l’utilisateur continue de parler, high répondra plus rapidement. auto est le par défaut et est équivalent à medium. Valeurs possibles : low, medium, high, auto	Non
└interrupt_response	booléen	S’il faut ou non interrompre automatiquement toute réponse en cours avec une sortie vers la conversation par défaut (c’est-à-dire conversation de auto) lorsqu’un événement de démarrage VAD se produit.	Non	True
prefix_padding_ms	entier	Utilisé uniquement pour le server_vad mode. Quantité d’audio à inclure avant que le VAD ne détecte la parole (en millisecondes). Par défaut, c’est 300 ms.	Non
└durée_du_silence_ms	entier	Utilisé uniquement pour le server_vad mode. Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Par défaut, c’est 500ms. Avec des valeurs plus courtes, le modèle répondra plus rapidement, mais peut intervenir lors de courtes pauses de l’utilisateur.	Non
└─ seuil	number	Utilisé uniquement pour le server_vad mode. Le seuil d’activation pour le VAD (0,0 à 1,0) est par défaut de 0,5. Un seuil plus élevé nécessitera un son plus fort pour activer le modèle, et pourrait donc mieux fonctionner dans des environnements bruyants.	Non
└─ Type	enum	Type de détection de virage. Valeurs possibles : server_vad, semantic_vad	Non
Voix	VoiceIdsShared		Non

Responses

Code de statut : 200

Description : Session créée avec succès.

Type de contenu	Type	Description
application/json	RealtimeSessionCreateResponse

Créer - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Créez un jeton API éphémère pour une utilisation dans les applications côté client avec l’API Temps Réel, spécifiquement pour les transcriptions en temps réel. Peut être configuré avec les mêmes paramètres de session que l’événement transcription_session.update client. Il répond par un objet de session, ainsi qu’une client_secret clé contenant un jeton éphémère d’API utilisable pouvant être utilisé pour authentifier les clients navigateurs de l’API en temps réel.

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
Inclure	tableau	L’ensemble des éléments à inclure dans la transcription. Les articles actuellement disponibles sont : - item.input_audio_transcription.logprobs	Non
input_audio_format	enum	Le format de l’audio d’entrée. Les options sont pcm16, g711_ulaw, ou g711_alaw. Pour pcm16, l’audio d’entrée doit être PCM 16 bits à un taux d’échantillonnage de 24 kHz, un seul canal (mono) et un ordre d’octets little-endian. Valeurs possibles : pcm16, g711_ulaw, g711_alaw	Non
input_audio_noise_reduction	Objet	Configuration pour la réduction du bruit audio en entrée. Cela peut être configuré pour null désactiver. La réduction de bruit filtre l’audio ajouté au tampon audio d’entrée avant qu’il ne soit envoyé au VAD et au modèle. Le filtrage audio peut améliorer la précision de la détection des VAD et des virages (réduisant les faux positifs) ainsi que la performance du modèle en améliorant la perception de l’audio en entrée.	Non
└─ Type	enum	Un type de réduction du bruit. near_field est pour les microphones à dialogue rapproché comme les casques, far_field pour les microphones à distance comme les ordinateurs portables ou les microphones de salle de conférence. Valeurs possibles : near_field, far_field	Non
input_audio_transcription	Objet	Configuration pour la transcription audio en entrée. Le client peut optionnellement définir la langue et la demande de transcription, ce qui offre des conseils supplémentaires au service de transcription.	Non
└─ Langue	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 (par exemple en) améliore la précision et la latence.	Non
└─ Modèle	enum	Le modèle à utiliser pour la transcription, les options actuelles sont gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, et whisper-1. Valeurs possibles : gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1	Non
└─ invite	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. Pour whisper-1, l’invite est une liste de mots-clés. Pour les gpt-4o-transcribe modèles, la demande est une chaîne de texte libre, par exemple « attendez-vous à des mots liés à la technologie ».	Non
Modalités		L’ensemble des modalités auxquelles le modèle peut répondre. Pour désactiver l’audio, réglez cela sur [« texte »].	Non
turn_detection	Objet	Configuration pour la détection de tour, VAD serveur ether ou VAD sémantique. Cela peut être configuré pour null désactiver, auquel cas le client doit déclencher manuellement la réponse du modèle. Le VAD serveur signifie que le modèle détecte le début et la fin de la parole en fonction du volume audio et répond à la fin de la parole de l’utilisateur. Le VAD sémantique est plus avancé et utilise un modèle de détection de virage (en conjonction avec le VAD) pour estimer sémantiquement si l’utilisateur a terminé de parler, puis fixe dynamiquement un délai d’attente basé sur cette probabilité. Par exemple, si l’audio de l’utilisateur s’éteint avec uhhm, le modèle obtiendra une faible probabilité de fin de tour et attendra plus longtemps que l’utilisateur continue à parler. Cela peut être utile pour des conversations plus naturelles, mais peut avoir une latence plus élevée.	Non
└─create_response	booléen	S’il faut ou non générer automatiquement une réponse lorsqu’un arrêt VAD se produit. Non disponible pour les séances de transcription.	Non	True
└─ enthousiasme	enum	Utilisé uniquement pour le semantic_vad mode. L’empressement du modèle à répondre. low attendra plus longtemps que l’utilisateur continue de parler, high répondra plus rapidement. auto est le par défaut et est équivalent à medium. Valeurs possibles : low, medium, high, auto	Non
└interrupt_response	booléen	S’il faut ou non interrompre automatiquement toute réponse en cours avec une sortie vers la conversation par défaut (c’est-à-dire conversation de auto) lorsqu’un événement de démarrage VAD se produit. Non disponible pour les séances de transcription.	Non	True
prefix_padding_ms	entier	Utilisé uniquement pour le server_vad mode. Quantité d’audio à inclure avant que le VAD ne détecte la parole (en millisecondes). Par défaut, c’est 300 ms.	Non
└durée_du_silence_ms	entier	Utilisé uniquement pour le server_vad mode. Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Par défaut, c’est 500ms. Avec des valeurs plus courtes, le modèle répondra plus rapidement, mais peut intervenir lors de courtes pauses de l’utilisateur.	Non
└─ seuil	number	Utilisé uniquement pour le server_vad mode. Le seuil d’activation pour le VAD (0,0 à 1,0) est par défaut de 0,5. Un seuil plus élevé nécessitera un son plus fort pour activer le modèle, et pourrait donc mieux fonctionner dans des environnements bruyants.	Non
└─ Type	enum	Type de détection de virage. Valeurs possibles : server_vad, semantic_vad	Non

Responses

Code de statut : 200

Description : Session créée avec succès.

Type de contenu	Type	Description
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Crée une réponse modèle.

Corps de la requête

Content-Type : application/json

Nom	Catégorie	Description	Obligatoire	Par défaut
Inclure	tableau		Non
entrée	chaîne ou tableau	Entrées de modèle	Oui
consignes	string	Insère un message système (ou développeur) comme premier élément dans le contexte du modèle. Lorsqu’on utilise avec previous_response_id, les instructions d’une réponse précédente ne seront pas relayées vers la réponse suivante. Cela facilite le remplacement des messages système (ou développeur) par de nouvelles réponses.	Non
max_output_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une réponse, y compris les jetons de sortie visibles et l’état de la conversation.	Non
parallel_tool_calls	booléen	Permettre au modèle d’exécuter des appels d’outils en parallèle.	Non	True
previous_response_id	string	L’identifiant unique de la réponse précédente au modèle. Utilisez cela pour créer des conversations sur plusieurs tours. En savoir plus sur l’état de la conversation.	Non
reasoning	Reasoning	Options de configuration pour les modèles de raisonnement.	Non
boutique	booléen	Savoir s’il faut stocker la réponse du modèle généré pour une récupération ultérieure via API.	Non	True
stream	booléen	Si elle est réglée sur true, les données de réponse du modèle seront diffusées au client au fur et à mesure de leur génération via des événements envoyés par le serveur. Voir la section Streaming ci-dessous pour plus d’informations.	Non	Faux
texte	Objet	Options de configuration pour une réponse texte du modèle. Cela 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	Non
└─ Format	TextResponseFormatConfiguration	Un objet spécifiant le format que le modèle doit produire. La configuration { "type": "json_schema" } permet de créer des sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. Le format par défaut est { "type": "text" } sans 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 préférée pour les modèles qui le supportent.	Non
tool_choice	OptionsDeDeChoix-de-Outils, TypesDeDeChoix-d’Outils, ou FonctionChoixDeChoix-deOutils	Comment le modèle doit choisir quel outil (ou outils) utiliser lors de la génération d’une réponse. Voir le tools paramètre pour voir comment spécifier quels outils le modèle peut appeler.	Non
Outils	tableau	Un ensemble d’outils que le modèle peut appeler lors de la génération d’une réponse. Vous pouvez spécifier quel outil utiliser en définissant le tool_choice paramètre. Les deux catégories d’outils que vous pouvez fournir au modèle sont : - Outils intégrés : Outils fournis par OpenAI qui étendent la fonctionnalités du modèle	Non
truncation	enum	La stratégie de troncature à utiliser pour la réponse du modèle. - auto: Si le contexte de cette réponse et des précédentes dépasse la taille de la fenêtre contextuelle du modèle, le modèle tronquera la réponse pour s’adapter à la fenêtre de contexte en supprimant des éléments d’entrée au milieu de la conversation. - disabled (par défaut) : Si une réponse de modèle dépasse la taille de la fenêtre de contexte pour un modèle, la requête échouera avec une erreur 400. Valeurs possibles : auto, disabled	Non

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	response
text/event-stream	responseStreamEvent

Code de statut : par défaut

Description : Service indisponible

Type de contenu	Type	Description
application/json	errorResponse

API Réponses - éléments d’entrée

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

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

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
response_id	path	Oui	string	L’identifiant de la réponse à récupérer.
Inclure	Requête	Non	tableau	Champs supplémentaires à inclure dans la réponse. Voir le include paramètre de création de réponse ci-dessus pour plus d’informations.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	response

Code de statut : par défaut

Description : Service indisponible

Type de contenu	Type	Description
application/json	errorResponse

Supprimer la réponse

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Supprime une réponse de modèle avec l’ID indiqué.

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
response_id	path	Oui	string	L’identifiant de la réponse à supprimer.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Code de statut : 404

Description : Non trouvé

Type de contenu	Type	Description
application/json	error

Code de statut : par défaut

Description : Service indisponible

Type de contenu	Type	Description
application/json	errorResponse

API Réponses - liste des éléments de réponse

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

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

Paramètres d’URI

Nom	Dans	Obligatoire	Catégorie	Description
endpoint	path	Oui	URL en chaîne	Pris en charge Azure terminaux OpenAI (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre ressource Azure OpenAI). https://{your-resource-name}.openai.azure.com
response_id	path	Oui	string	L’identifiant de la réponse pour récupérer les éléments d’entrée pour.
limit	Requête	Non	entier	Une limite au nombre d’objets à retourner. La limite peut varier entre 1 et 100, et la valeur par défaut est 20.
order	Requête	Non	string Valeurs possibles : asc, desc	L’ordre pour renvoyer les éléments d’entrée. Par défaut est asc. - asc: Retourner les éléments d’entrée dans l’ordre croissant. - desc: Retourner les éléments d’entrée dans l’ordre décroissant.
Après	Requête	Non	string	Un identifiant d’élément pour lister les éléments après, utilisé lors de la pagination.
before	Requête	Non	string	Un identifiant d’élément pour lister les éléments précédents, utilisé lors de la pagination.

En-tête de requête

Utilisez soit une authentification basée sur un jeton, soit une clé API. L’authentification par jeton est recommandée et plus sécurisée.

Nom	Obligatoire	Catégorie	Description
Authorization	True	string	Exemple :Authorization: Bearer {Azure_OpenAI_Auth_Token} Pour générer un jeton d’authentification en utilisant Azure CLI : az account get-access-token --resource https://cognitiveservices.azure.com Type : oauth2 URL d’autorisation : https://login.microsoftonline.com/common/oauth2/v2.0/authorize Portée : https://ai.azure.com/.default
clé API	True	string	Fournissez ici la clé API Azure OpenAI

Responses

Code de statut : 200

Description : OK

Type de contenu	Type	Description
application/json	responseItemList

Composants

errorResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
erreur	error		Non

errorBase

Nom	Catégorie	Description	Obligatoire	Par défaut
code	string		Non
message	string		Non

erreur

Nom	Catégorie	Description	Obligatoire	Par défaut
inner_error	innerError	Erreur intérieure avec des détails supplémentaires.	Non
param	string		Non
type	string		Non

innerError

Erreur intérieure avec des détails supplémentaires.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	innerErrorCode	Codes d’erreur pour l’objet d’erreur interne.	Non
content_filter_results	contentFilterPromptResults	Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.	Non

innerErrorCode

Codes d’erreur pour l’objet d’erreur interne.

Propriété	Valeur
Description	Codes d’erreur pour l’objet d’erreur interne.
Type	string
Valeurs	ResponsibleAIPolicyViolation

dalleErrorResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
erreur	dalleError		Non

dalleError

Nom	Catégorie	Description	Obligatoire	Par défaut
inner_error	dalleInnerError	Erreur intérieure avec des détails supplémentaires.	Non
param	string		Non
type	string		Non

dalleInnerError

Erreur intérieure avec des détails supplémentaires.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	innerErrorCode	Codes d’erreur pour l’objet d’erreur interne.	Non
content_filter_results	dalleFilterResults	Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.	Non
revised_prompt	string	La demande utilisée pour générer l’image, s’il y avait une révision de la requête.	Non

contentFilterCompletionTextSpan

Décrit une portée dans le texte de complétion généré. Le décalage 0 est le premier point de code UTF32 du texte de complétion.

Nom	Catégorie	Description	Obligatoire	Par défaut
completion_end_offset	entier	Décalage du premier point de code UTF32 qui est exclu de la portée. Ce champ est toujours égal à completion_start_offset pour les portées vides. Ce champ est toujours plus grand que completion_start_offset pour les travées non vides.	Oui
completion_start_offset	entier	Décalage du point de code UTF32 qui commence la portée.	Oui

BaseDeRésultatDeFiltreDeContenu

Nom	Catégorie	Description	Obligatoire	Par défaut
filtered	booléen		Oui

Résultat de la sévérité du filtre de contenu

Nom	Catégorie	Description	Obligatoire	Par défaut
filtered	booléen		Oui
severity	string		Non

contentFilterDetectedResult

Nom	Catégorie	Description	Obligatoire	Par défaut
détecté	booléen		Non
filtered	booléen		Oui

contentFilterDetectedWithCitationResult

Nom	Catégorie	Description	Obligatoire	Par défaut
citation	Objet		Non
URL └>	string		Non
└─ licence	string		Non

contentFilterDetectedWithCompletionTextSpansResult

Nom	Catégorie	Description	Obligatoire	Par défaut
details	tableau		Non

contentFilterIdResult

Nom	Catégorie	Description	Obligatoire	Par défaut
filtered	booléen		Oui
ID	string		Non

contentFilterResultsBase

Informations sur les résultats du filtrage de contenu.

Nom	Catégorie	Description	Obligatoire	Par défaut
custom_blocklists	contentFilterDetailedResults	Le filtrage de contenu donne un détail des identifiants de filtre de contenu pour les segments filtrés.	Non
erreur	errorBase		Non
Déteste	résultatDeSévéritéDuFiltreDeContenu		Non
Blasphème	RésultatDeFiltreDeContenuDétecté		Non
self_harm	résultatDeSévéritéDuFiltreDeContenu		Non
Sexuelle	résultatDeSévéritéDuFiltreDeContenu		Non
violence	résultatDeSévéritéDuFiltreDeContenu		Non

contentFilterPromptResults

Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.

Nom	Catégorie	Description	Obligatoire	Par défaut
custom_blocklists	contentFilterDetailedResults	Le filtrage de contenu donne un détail des identifiants de filtre de contenu pour les segments filtrés.	Non
erreur	errorBase		Non
Déteste	résultatDeSévéritéDuFiltreDeContenu		Non
indirect_attack	RésultatDeFiltreDeContenuDétecté		Non
jailbreak	RésultatDeFiltreDeContenuDétecté		Non
Blasphème	RésultatDeFiltreDeContenuDétecté		Non
self_harm	résultatDeSévéritéDuFiltreDeContenu		Non
Sexuelle	résultatDeSévéritéDuFiltreDeContenu		Non
violence	résultatDeSévéritéDuFiltreDeContenu		Non

contentFilterChoiceResults

Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur les textes et jurons tiers, si cela a été détecté, et s’il a été filtré ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.

Nom	Catégorie	Description	Obligatoire	Par défaut
custom_blocklists	contentFilterDetailedResults	Le filtrage de contenu donne un détail des identifiants de filtre de contenu pour les segments filtrés.	Non
erreur	errorBase		Non
Déteste	résultatDeSévéritéDuFiltreDeContenu		Non
Blasphème	RésultatDeFiltreDeContenuDétecté		Non
protected_material_code	filtreDeContenuDetectéAvecRésultatDeCitation		Non
protected_material_text	RésultatDeFiltreDeContenuDétecté		Non
self_harm	résultatDeSévéritéDuFiltreDeContenu		Non
Sexuelle	résultatDeSévéritéDuFiltreDeContenu		Non
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		Non
violence	résultatDeSévéritéDuFiltreDeContenu		Non

contentFilterDetailedResults

Le filtrage de contenu donne un détail des identifiants de filtre de contenu pour les segments filtrés.

Nom	Catégorie	Description	Obligatoire	Par défaut
details	tableau		Non
filtered	booléen		Oui

promptFilterResult

Résultats de filtrage de contenu pour une seule invite dans la requête.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_filter_results	contentFilterPromptResults	Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.	Non
prompt_index	entier		Non

promptFilterResults

Filtrage de contenu pour zéro ou plus d’invites dans la requête. Dans une requête en streaming, les résultats pour différentes invitations peuvent arriver à des moments ou dans des ordres différents.

Aucune propriété définie pour ce composant.

RésultatsDalleFiltreDeContenu

Informations sur les résultats du filtrage de contenu.

Nom	Catégorie	Description	Obligatoire	Par défaut
Déteste	résultatDeSévéritéDuFiltreDeContenu		Non
self_harm	résultatDeSévéritéDuFiltreDeContenu		Non
Sexuelle	résultatDeSévéritéDuFiltreDeContenu		Non
violence	résultatDeSévéritéDuFiltreDeContenu		Non

dalleFilterResults

Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.

Nom	Catégorie	Description	Obligatoire	Par défaut
custom_blocklists	contentFilterDetailedResults	Le filtrage de contenu donne un détail des identifiants de filtre de contenu pour les segments filtrés.	Non
Déteste	résultatDeSévéritéDuFiltreDeContenu		Non
jailbreak	RésultatDeFiltreDeContenuDétecté		Non
Blasphème	RésultatDeFiltreDeContenuDétecté		Non
self_harm	résultatDeSévéritéDuFiltreDeContenu		Non
Sexuelle	résultatDeSévéritéDuFiltreDeContenu		Non
violence	résultatDeSévéritéDuFiltreDeContenu		Non

chatCompletionsRequestCommon

Nom	Catégorie	Description	Obligatoire	Par défaut
pénalité de fréquence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur fréquence existante dans le texte jusqu’à présent, diminuant la probabilité que le modèle répète la même phrase mot pour mot.	Non	0
logit_bias	Objet	Modifier la probabilité que des jetons spécifiés apparaissent dans la complétion. Accepte un objet json qui associe les jetons (spécifiés par leur identifiant de jeton dans le tokenizador) à une valeur de biais associée de -100 à 100. Mathématiquement, le biais est ajouté aux logits générés par le modèle avant l’échantillonnage. L’effet exact varie selon le modèle, mais les valeurs comprises entre -1 et 1 devraient diminuer ou augmenter la probabilité de sélection ; des valeurs comme -100 ou 100 devraient entraîner un bannissement ou une sélection exclusive du jeton concerné.	Non
max_completion_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une complétion, incluant les jetons de sortie visibles et les jetons de raisonnement.	Non
nombre_maximal_de_tokens	entier	Le nombre maximal de jetons autorisé pour la réponse générée. Par défaut, le nombre de jetons que le modèle peut retourner sera (4096 - jetons à invites). Ce n’est pas compatible avec les modèles de la série O1.	Non	4096
metadata	Objet	Étiquettes et valeurs définies par le développeur utilisées pour filtrer les complétions dans le tableau de bord des complétions stockées.	Non
pénalité de présence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur apparence dans le texte jusqu’à présent, augmentant ainsi la probabilité du modèle d’aborder de nouveaux sujets.	Non	0
Arrêter	chaîne ou tableau	Jusqu’à 4 séquences où l’API cesse de générer d’autres jetons.	Non
boutique	booléen	Savoir si la sortie de cette demande de complétion de chat doit être utilisée dans nos produits de distillation ou d’évaluation de modèles.	Non
stream	booléen	Si c’est défini, des deltas partiels de message sont envoyés, comme dans ChatGPT. Les jetons sont envoyés uniquement comme des événements envoyés par le serveur dès qu’ils deviennent disponibles, le flux étant interrompu par un data: [DONE] message.	Non	Faux
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider Azure OpenAI à surveiller et détecter les abus.	Non

créerDemandeDeComplétion

Nom	Catégorie	Description	Obligatoire	Par défaut
meilleures sélections	entier	Génère best_of des complétions côté serveur et retourne le « meilleur » (celui avec la plus grande probabilité logarithmique par jeton). Les résultats ne peuvent pas être diffusés en streaming. Lorsqu’elle est utilisée avec n, best_of contrôle le nombre de complétions candidates et n spécifie combien retourner. best_of doit être supérieur à n. Note : Parce que ce paramètre génère de nombreuses complétions, il peut rapidement consommer votre quota de jetons. Utilisez avec soin et assurez-vous d’avoir des réglages raisonnables pour max_tokens et stop.	Non	1
echo	booléen	Faites écho à la consigne en plus de la complétion	Non	Faux
pénalité de fréquence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur fréquence existante dans le texte jusqu’à présent, diminuant la probabilité que le modèle répète la même phrase mot pour mot.	Non	0
logit_bias	Objet	Modifier la probabilité que des jetons spécifiés apparaissent dans la complétion. Accepte un objet JSON qui associe les jetons (spécifiés par leur identifiant de jeton dans le tokeniseur GPT) à une valeur de biais associée de -100 à 100. Mathématiquement, le biais est ajouté aux logits générés par le modèle avant l’échantillonnage. L’effet exact varie selon le modèle, mais les valeurs comprises entre -1 et 1 devraient diminuer ou augmenter la probabilité de sélection ; des valeurs comme -100 ou 100 devraient entraîner un bannissement ou une sélection exclusive du jeton concerné. Par exemple, vous pouvez passer {"50256": -100} pour empêcher la génération du <token |endoftext> .	Non	None
logprobs	entier	Incluez les probabilités logarithiques sur les logprobs jetons de sortie les plus probables, ainsi que les jetons choisis. Par exemple, si logprobs est 5, l’API renverra une liste des 5 jetons les plus probables. L’API retournera toujours le logprob du jeton échantillonné, donc il peut y avoir jusqu’à jusqu’à logprobs+1 des éléments dans la réponse. La valeur maximale pour logprobs est 5.	Non	None
nombre_maximal_de_tokens	entier	Le nombre maximal de jetons pouvant être générés lors de la complétion. Le nombre de jetons de votre invite plus max_tokens ne peut pas dépasser la longueur contextuelle du modèle.	Non	16
n	entier	Combien de complétions générer pour chaque invite. Note : Parce que ce paramètre génère de nombreuses complétions, il peut rapidement consommer votre quota de jetons. Utilisez avec soin et assurez-vous d’avoir des réglages raisonnables pour max_tokens et stop.	Non	1
pénalité de présence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur apparence dans le texte jusqu’à présent, augmentant ainsi la probabilité du modèle d’aborder de nouveaux sujets.	Non	0
prompt	chaîne ou tableau	Le(s) prompt(s) pour générer des complétions pour , encodé sous forme de chaîne, tableau de chaînes, tableau de jetons ou tableau de tableaux de jetons. Notez que <|endoftext|> est le séparateur de document que le modèle voit lors de l’entraînement, donc si une invite n’est pas spécifiée, le modèle sera généré comme si c’était le début d’un nouveau document.	Oui
seed	entier	Si spécifié, notre système fait un meilleur effort pour échantillonner de manière déterministe, de sorte que des requêtes répétées avec les mêmes seed paramètres et doivent donner le même résultat. Le déterminisme n’est pas garanti, et vous devriez vous référer au system_fingerprint paramètre de réponse pour surveiller les changements dans le backend.	Non
Arrêter	chaîne ou tableau	Jusqu’à 4 séquences où l’API cesse de générer d’autres jetons. Le texte retourné ne contiendra pas la séquence d’arrêt.	Non
stream	booléen	Est-ce qu’il faut réintégrer un progrès partiel en détail. S’ils sont définis, les jetons sont envoyés comme des événements uniquement donnés par le serveur dès qu’ils deviennent disponibles, le flux étant terminé par un data: [DONE] message. Exemple Python code.	Non	Faux
Suffixe	string	Le suffixe qui vient après la fin du texte inséré. Ce paramètre n’est pris en charge que pour gpt-3.5-turbo-instruct.	Non	None
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

createCompletionResponse

Représente une réponse de complétion de l’API. Note : les objets de réponse streamés et non streamés partagent la même forme (contrairement au point de terminaison du chat).

Nom	Catégorie	Description	Obligatoire	Par défaut
choix	tableau	La liste des choix de complétion générés par le modèle pour l’invite d’entrée.	Oui
créé	entier	L’horodatage Unix (en secondes) de la création de la complétion.	Oui
ID	string	Un identifiant unique pour l’achèvement.	Oui
model	string	Le modèle utilisé pour la complétion.	Oui
Objet	enum	Le type d’objet, qui est toujours « text_completion » Valeurs possibles : text_completion	Oui
prompt_filter_results	promptFilterResults	Filtrage de contenu pour zéro ou plus d’invites dans la requête. Dans une requête en streaming, les résultats pour différentes invitations peuvent arriver à des moments ou dans des ordres différents.	Non
system_fingerprint	string	Cette empreinte digitale représente la configuration backend avec laquelle le modèle fonctionne. Peut être utilisé conjointement avec le seed paramètre de requête pour comprendre quand des modifications en backend ont été effectuées pouvant impacter le déterminisme.	Non
utilisation	completionUsage	Statistiques d’utilisation pour la demande de complétion.	Non

createChatCompletionRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
Audio	Objet	Paramètres pour la sortie audio. Requise lorsque la sortie audio est demandée avec modalities: ["audio"].	Non
└─ Format	enum	Spécifie le format audio de sortie. Doit être l’un des wavdeux , mp3, flac, opus, ou pcm16. Valeurs possibles : wav, mp3, flac, opus, pcm16	Non
└─ voix	enum	Précise le type de voix. Les voix soutenues sont alloy, echo, fable, onyx, nova, et shimmer. Valeurs possibles : alloy, echo, fable, onyx, nova, shimmer	Non
data_sources	tableau	Les entrées de configuration pour les extensions de chat Azure OpenAI qui les utilisent. Cette spécification supplémentaire n’est compatible qu’avec Azure OpenAI.	Non
pénalité de fréquence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur fréquence existante dans le texte jusqu’à présent, diminuant la probabilité que le modèle répète la même phrase mot pour mot.	Non	0
function_call	chaîne ou chatCompletionFunctionCallOption	Déprécié au profit de tool_choice. Contrôle quelle fonction (le cas échéant) est appelée par le modèle. none signifie que le modèle n’appellera pas de fonction et générera un message. auto signifie que le modèle peut choisir entre générer un message ou appeler une fonction. Spécifier une fonction particulière via {"name": "my_function"} force le modèle à appeler cette fonction. none est la fonction par défaut lorsqu’aucune fonction n’est présente. auto est la valeur par défaut si des fonctions sont présentes.	Non
functions	tableau	Déprécié au profit de tools. Une liste des fonctions pour lesquelles le modèle peut générer des entrées JSON.	Non
logit_bias	Objet	Modifier la probabilité que des jetons spécifiés apparaissent dans la complétion. Accepte un objet JSON qui associe les jetons (spécifiés par leur identifiant de jeton dans le tokenizador) à une valeur de biais associée de -100 à 100. Mathématiquement, le biais est ajouté aux logits générés par le modèle avant l’échantillonnage. L’effet exact varie selon le modèle, mais les valeurs comprises entre -1 et 1 devraient diminuer ou augmenter la probabilité de sélection ; des valeurs comme -100 ou 100 devraient entraîner un bannissement ou une sélection exclusive du jeton concerné.	Non	None
logprobs	booléen	S’il faut ou non retourner les probabilités logarithiques des jetons de sortie. Si c’est vrai, renvoie les probabilités logarithmitrophiques de chaque jeton de sortie retourné dans le content de message.	Non	Faux
max_completion_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une complétion, incluant les jetons de sortie visibles et les jetons de raisonnement.	Non
nombre_maximal_de_tokens	entier	Le nombre maximal de jetons pouvant être générés lors de la fin du chat. La longueur totale des jetons d’entrée et des jetons générés est limitée par la longueur du contexte du modèle.	Non
messages	tableau	Une liste des messages qui composent la conversation jusqu’à présent. Exemple Python code.	Oui
metadata	Objet	Étiquettes et valeurs définies par le développeur utilisées pour filtrer les complétions dans le tableau de bord des complétions stockées.	Non
Modalités	ChatCompletionModalities	Types de sortie que vous souhaitez que le modèle génère pour cette requête. La plupart des modèles sont capables de générer du texte, ce qui est le principe par défaut : ["text"] Le gpt-4o-audio-preview modèle peut également être utilisé pour générer de l’audio. Pour demander à ce modèle de générer à la fois des réponses textuelles et audio, vous pouvez utiliser : ["text", "audio"]	Non
n	entier	Combien de choix de fin de conversation générer pour chaque message d’entrée. Notez que vous serez facturé en fonction du nombre de jetons générés sur toutes les options. Gardez n le minimum 1 pour minimiser les coûts.	Non	1
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
prediction	PredictionContent	Configuration pour une sortie prédite, qui peut grandement améliorer les temps de réponse lorsque de grandes parties de la réponse du modèle sont connues à l’avance. C’est le plus courant lorsque vous régénérez un fichier avec seulement des modifications mineures de la plupart du contenu.	Non
pénalité de présence	number	Nombre compris entre -2,0 et 2,0. Les valeurs positives pénalisent les nouveaux jetons en fonction de leur apparence dans le texte jusqu’à présent, augmentant ainsi la probabilité du modèle d’aborder de nouveaux sujets.	Non	0
effort de raisonnement	enum	Uniquement les modèles O1 Limite l’effort de raisonnement pour les modèles de raisonnement. Les valeurs actuellement prises en charge sont low, medium, et high. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés pour raisonner dans une réponse. Valeurs possibles : low, medium, high	Non
format_de_réponse	ResponseFormatText ou ResponseFormatJsonObject ou ResponseFormatJsonSchema	Un objet spécifiant le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4o mini, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo plus récents que gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. Le réglage activant { "type": "json_object" } le mode JSON, qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
seed	entier	Cette fonctionnalité est en version Bêta. Si spécifié, notre système fait un meilleur effort pour échantillonner de manière déterministe, de sorte que des requêtes répétées avec les mêmes seed paramètres et doivent donner le même résultat. Le déterminisme n’est pas garanti, et vous devriez vous référer au system_fingerprint paramètre de réponse pour surveiller les changements dans le backend.	Non
Arrêter	chaîne ou tableau	Jusqu’à 4 séquences où l’API cesse de générer d’autres jetons.	Non
boutique	booléen	Savoir si la sortie de cette demande de complétion de chat doit être utilisée dans nos produits de distillation ou d’évaluation de modèles.	Non
stream	booléen	Si c’est défini, des deltas partiels de message sont envoyés, comme dans ChatGPT. Les jetons sont envoyés uniquement comme des événements envoyés par le serveur dès qu’ils deviennent disponibles, le flux étant interrompu par un data: [DONE] message. Exemple Python code.	Non	Faux
stream_options	chatCompletionStreamOptions	Options pour la réponse en streaming. Ne réglez cela que lorsque vous activez stream: true.	Non	None
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
tool_choice	chatCompletionToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera 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. Spécifier un outil particulier force {"type": "function", "function": {"name": "my_function"}} le modèle à appeler cet outil. none est la norme par défaut lorsqu’aucun outil n’est présent. auto est la norme par défaut si des outils sont présents.	Non
Outils	tableau	Une liste d’outils que le modèle peut appeler. Actuellement, seules les fonctions sont prises en charge comme outil. Utilisez cela pour fournir une liste des fonctions pour lesquelles le modèle peut générer des entrées JSON. Un maximum de 128 fonctions sont pris en charge.	Non
top_logprobs	entier	Un entier compris entre 0 et 20 spécifiant le nombre de jetons les plus susceptibles de revenir à chaque position de jeton, chacun avec une probabilité logarithmique associée. logprobs doit être fixé à true si ce paramètre est utilisé.	Non
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non
user_security_context	userSecurityContext	Le contexte de sécurité utilisateur contient plusieurs paramètres qui décrivent l’application d’IA elle-même et l’utilisateur final qui interagit avec l’application IA. Ces domaines aident vos équipes d’opérations de sécurité à enquêter et à atténuer les incidents de sécurité en proposant une approche globale pour protéger vos applications d’IA. En savoir plus sur la protection des applications d’IA utilisant Microsoft Defender for Cloud.	Non

userSecurityContext

Le contexte de sécurité utilisateur contient plusieurs paramètres qui décrivent l’application d’IA elle-même et l’utilisateur final qui interagit avec l’application IA. Ces domaines aident vos équipes d’opérations de sécurité à enquêter et à atténuer les incidents de sécurité en proposant une approche globale pour protéger vos applications d’IA. En savoir plus sur la protection des applications d’IA utilisant Microsoft Defender for Cloud.

Nom	Catégorie	Description	Obligatoire	Par défaut
application_name	string	Le nom de la demande. Les informations personnelles sensibles ne doivent pas être incluses dans ce champ.	Non
end_user_id	string	Cet identifiant est l’ID d’objet utilisateur Microsoft Entra ID (anciennement Azure Active Directory), utilisé pour authentifier les utilisateurs finaux au sein de l’application d’IA générative. Les informations personnelles sensibles ne doivent pas être incluses dans ce champ.	Non
end_user_tenant_id	string	L’ID de locataire Microsoft 365 auquel appartient l’utilisateur final. C’est nécessaire lorsque l’application d’IA générative est multi-locataire.	Non
source_ip	string	Capture l’adresse IP du client d’origine, acceptant à la fois les formats IPv4 et IPv6.	Non

chatCompletionFunctions

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
name	string	Le nom de la fonction à appeler. Doit être de A à Z, de A à Z, de 0 à 9, ou contenir des sous-traits et des titres, avec une longueur maximale de 64.	Oui
parameters	FunctionParameters	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, ainsi que la référence du schéma JSON pour la documentation sur le format. Omettre parameters définit une fonction avec une liste de paramètres vide.	Non

chatCompletionFunctionCallOption

Spécifier une fonction particulière via {"name": "my_function"} force le modèle à appeler cette fonction.

Nom	Catégorie	Description	Obligatoire	Par défaut
name	string	Le nom de la fonction à appeler.	Oui

chatCompletionFunctionParameters

Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, ainsi que la référence du schéma JSON pour la documentation sur le format.

Aucune propriété définie pour ce composant.

chatCompletionRequestMessage

Ce composant peut être l’un des suivants :

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

Instructions fournies par le développeur que le modèle doit suivre, indépendamment des messages envoyés par l’utilisateur. Avec les modèles O1 et plus récents, developer les messages remplacent les messages précédents system .

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou tableau	Le contenu du message développeur.	Oui
name	string	Un nom optionnel pour le participant. Fournit les informations du modèle permettant de différencier les participants ayant le même rôle.	Non
role	enum	Le rôle de l’auteur des messages, dans ce cas developer. Valeurs possibles : developer	Oui

Message du système de demande d'achèvement du chat

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou tableau	Le contenu du message système.	Oui
name	string	Un nom optionnel pour le participant. Fournit les informations du modèle permettant de différencier les participants ayant le même rôle.	Non
role	enum	Le rôle de l’auteur des messages, dans ce cas system. Valeurs possibles : system	Oui

chatCompletionRequestUserMessage

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou tableau	Le contenu du message utilisateur.	Oui
name	string	Un nom optionnel pour le participant. Fournit les informations du modèle permettant de différencier les participants ayant le même rôle.	Non
role	enum	Le rôle de l’auteur des messages, dans ce cas user. Valeurs possibles : user	Oui

chatCompletionRequestAssistantMessage

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou tableau	Le contenu du message de l’assistant. Obligatoire sauf tool_calls indication contraire function_call .	Non
function_call	Objet	Déprécié et remplacé par tool_calls. Le nom et les arguments d’une fonction à appeler, tels que générés par le modèle.	Non
└─ Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON. Notez que le modèle ne génère pas toujours un JSON valide, et peut halluciner des paramètres non définis par votre schéma de fonction. Validez les arguments de votre code avant d’appeler votre fonction.	Non
└─ Nom	string	Le nom de la fonction à appeler.	Non
name	string	Un nom optionnel pour le participant. Fournit les informations du modèle permettant de différencier les participants ayant le même rôle.	Non
refusal	string	Le message de refus de l’assistant.	Non
role	enum	Le rôle de l’auteur des messages, dans ce cas assistant. Valeurs possibles : assistant	Oui
tool_calls	chatCompletionMessageToolCalls	Les appels d’outils générés par le modèle, tels que les appels de fonction.	Non

chatCompletionRequestToolMessage

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou tableau	Le contenu du message de l’outil.	Oui
role	enum	Le rôle de l’auteur des messages, dans ce cas tool. Valeurs possibles : tool	Oui
tool_call_id	string	Appel d’outil auquel ce message répond.	Oui

chatCompletionRequestFunctionMessage

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	string	Le contenu du message de fonction.	Oui
name	string	Le nom de la fonction à appeler.	Oui
role	enum	Le rôle de l’auteur des messages, dans ce cas function. Valeurs possibles : function	Oui

chatCompletionRequestDeveloperMessageContentPart

Ce composant peut être l’un des suivants :

• chatCompletionRequestMessageContentPartText

Partie de contenu du message système de requête de finalisation de chat

Ce composant peut être l’un des suivants :

• chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

Ce composant peut être l’un des suivants :

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

Ce composant peut être l’un des suivants :

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

Ce composant peut être l’un des suivants :

• chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

Nom	Catégorie	Description	Obligatoire	Par défaut
texte	string	Le contenu du texte.	Oui
type	enum	Le type de contenu. Valeurs possibles : text	Oui

chatCompletionRequestMessageContentPartAudio

Nom	Catégorie	Description	Obligatoire	Par défaut
input_audio	Objet		Oui
└─ données	string	Données audio encodées en Base64.	Non
└─ Format	enum	Le format des données audio encodées. Prend actuellement en charge « wav » et « mp3 ». Valeurs possibles : wav, mp3	Non
type	enum	Le type de contenu. Toujours input_audio. Valeurs possibles : input_audio	Oui

chatCompletionRequestMessageContentPartImage

Nom	Catégorie	Description	Obligatoire	Par défaut
image_url	Objet		Oui
└─ détail	enum	Précise le niveau de détail de l’image. En savoir plus dans le guide Vision. Valeurs possibles : auto, low, high	Non
URL └>	string	Soit une URL de l’image, soit les données d’image encodées en base64.	Non
type	enum	Le type de contenu. Valeurs possibles : image_url	Oui

chatCompletionRequestMessageContentPartRefusal

Nom	Catégorie	Description	Obligatoire	Par défaut
refusal	string	Le message de refus généré par le modèle.	Oui
type	enum	Le type de contenu. Valeurs possibles : refusal	Oui

configuration de l'extension de chat Azure

Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.

###Discriminant pour azureChatExtensionConfiguration

Ce composant utilise la propriété type pour distinguer différents types :

Valeur de type	Schema
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

Nom	Catégorie	Description	Obligatoire	Par défaut
type	azureChatExtensionType	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.	Oui

azureChatExtensionType

Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.

Propriété	Valeur
Description	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.
Type	string
Valeurs	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

Configuration d'extension de chat Azure Search

Une représentation spécifique des options configurables pour Azure Search lorsqu’on l’utilise comme extension de chat OpenAI d’Azure.

Nom	Catégorie	Description	Obligatoire	Par défaut
parameters	azureSearchChatExtensionParameters	Paramètres pour Azure Search lorsqu’ils sont utilisés comme extension de chat OpenAI Azure.	Non
type	azureChatExtensionType	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.	Oui

azureSearchChatExtensionParameters

Paramètres pour Azure Search lorsqu’ils sont utilisés comme extension de chat OpenAI Azure.

Nom	Catégorie	Description	Obligatoire	Par défaut
allow_partial_result	booléen	Si spécifié comme vrai, le système permettra d’utiliser des résultats partiels de recherche et la requête échoue si toutes les requêtes échouent. Si elle n’est pas spécifiée ou spécifiée comme fausse, la requête échouera si une requête de recherche échoue.	Non	Faux
Authentification	onYourDataApiKeyAuthenticationOptions ou surVotReDataSystemAssignéGéréIdentitatOptionsAuthentication , ou surVotReDataUtilisateurAssignéGéréIdentityOptionsAuthenticationOusurTVotresDonnéesAccessTokenAuthenticationOptions		Oui
embedding_dependency	onTonDataDataEndpointVectorisationSource ou surTonDataDéploiementNomVectorisationSource ou surTesDonnéesIntégréeVectorisationSource		Non
endpoint	string	Le chemin d’extrémité absolu pour la ressource Azure Search à utiliser.	Oui
cartographie des champs	Options de mappage de champs de l'index de recherche Azure	Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Azure Search configurée.	Non
filter	string	Filtre de recherche.	Non
in_scope	booléen	Est-ce que les requêtes doivent être restreintes à l’utilisation de données indexées.	Non
include_contexts	tableau	Les propriétés incluses du contexte de sortie. Si ce n’est pas spécifié, la valeur par défaut est citations et intent.	Non
nom_de_l'index	string	Le nom de l’index à utiliser tel que disponible dans la ressource Azure Search référencée.	Oui
max_search_queries	entier	Le nombre maximal de requêtes réécrites doit être envoyé au fournisseur de recherche pour un message utilisateur. Si ce n’est pas spécifié, le système décidera du nombre de requêtes à envoyer.	Non
type_de_requête	azureSearchQueryType	Le type de requête de recherche Azure qui doit être exécutée lorsqu’on l’utilise comme extension de chat OpenAI Azure.	Non
configuration_sémantique	string	La configuration sémantique supplémentaire pour la requête.	Non
Rigueur	entier	La stricteur configurée du filtrage de pertinence de recherche. Plus la rigueur est élevée, plus la précision est élevée mais moins la mémoire de la réponse est élevée.	Non
top_n_documents	entier	Le nombre supérieur configuré de documents à présenter pour la requête configurée.	Non

Options de mappage de champs de l'index de recherche Azure

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Azure Search configurée.

Nom	Catégorie	Description	Obligatoire	Par défaut
champs_de_contenu	tableau	Les noms des champs d’index qui doivent être considérés comme du contenu.	Non
séparateur_de_champs_de_contenu	string	Le motif séparateur que les champs de contenu doivent utiliser.	Non
filepath_field	string	Le nom du champ d’index à utiliser comme chemin de fichier.	Non
image_vector_fields	tableau	Les noms des champs qui représentent les données vectorielles d’image.	Non
champ_titre	string	Le nom du champ index à utiliser comme titre.	Non
url_field	string	Le nom du champ index à utiliser comme URL.	Non
champs vectoriels	tableau	Les noms des champs qui représentent des données vectorielles.	Non

azureSearchQueryType

Le type de requête de recherche Azure qui doit être exécutée lorsqu’on l’utilise comme extension de chat OpenAI Azure.

Propriété	Valeur
Description	Le type de requête de recherche Azure qui doit être exécutée lorsqu’on l’utilise comme extension de chat OpenAI Azure.
Type	string
Valeurs	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

azureCosmosDBChatExtensionConfiguration

Une représentation spécifique des options configurables pour Azure Cosmos DB lorsqu’il est utilisé comme extension de chat Azure OpenAI.

Nom	Catégorie	Description	Obligatoire	Par défaut
parameters	azureCosmosDBChatExtensionParameters	Paramètres à utiliser lors de la configuration des extensions de chat Azure OpenAI On Your Data lors de l’utilisation d’Azure Cosmos DB pour MongoDB vCore.	Non
type	azureChatExtensionType	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.	Oui

azureCosmosDBChatExtensionParameters

Paramètres à utiliser lors de la configuration des extensions de chat Azure OpenAI On Your Data lors de l’utilisation d’Azure Cosmos DB pour MongoDB vCore.

Nom	Catégorie	Description	Obligatoire	Par défaut
allow_partial_result	booléen	Si spécifié comme vrai, le système permettra d’utiliser des résultats partiels de recherche et la requête échoue si toutes les requêtes échouent. Si elle n’est pas spécifiée ou spécifiée comme fausse, la requête échouera si une requête de recherche échoue.	Non	Faux
Authentification	onYourDataConnectionStringAuthenticationOptions	Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une chaîne de connexion.	Oui
nom_du_conteneur	string	Le nom du conteneur de ressources Azure Cosmos DB.	Oui
database_name	string	Le nom de base de données MongoDB vCore à utiliser avec Azure Cosmos DB.	Oui
embedding_dependency	onTonDataDataEndpointVectorisationSource ou surVotReDonnéesDéploiementNomVectorisationSource		Oui
cartographie des champs	azureCosmosDBFieldMappingOptions	Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Azure Cosmos DB configurée.	Oui
in_scope	booléen	Est-ce que les requêtes doivent être restreintes à l’utilisation de données indexées.	Non
include_contexts	tableau	Les propriétés incluses du contexte de sortie. Si ce n’est pas spécifié, la valeur par défaut est citations et intent.	Non
nom_de_l'index	string	Le nom d’index MongoDB vCore à utiliser avec Azure Cosmos DB.	Oui
max_search_queries	entier	Le nombre maximal de requêtes réécrites doit être envoyé au fournisseur de recherche pour un message utilisateur. Si ce n’est pas spécifié, le système décidera du nombre de requêtes à envoyer.	Non
Rigueur	entier	La stricteur configurée du filtrage de pertinence de recherche. Plus la rigueur est élevée, plus la précision est élevée mais moins la mémoire de la réponse est élevée.	Non
top_n_documents	entier	Le nombre supérieur configuré de documents à présenter pour la requête configurée.	Non

azureCosmosDBFieldMappingOptions

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Azure Cosmos DB configurée.

Nom	Catégorie	Description	Obligatoire	Par défaut
champs_de_contenu	tableau	Les noms des champs d’index qui doivent être considérés comme du contenu.	Oui
séparateur_de_champs_de_contenu	string	Le motif séparateur que les champs de contenu doivent utiliser.	Non
filepath_field	string	Le nom du champ d’index à utiliser comme chemin de fichier.	Non
champ_titre	string	Le nom du champ index à utiliser comme titre.	Non
url_field	string	Le nom du champ index à utiliser comme URL.	Non
champs vectoriels	tableau	Les noms des champs qui représentent des données vectorielles.	Oui

elasticsearchChatExtensionConfiguration

Une représentation spécifique des options configurables pour Elasticsearch lorsqu’il est utilisé comme extension de chat OpenAI sur Azure.

Nom	Catégorie	Description	Obligatoire	Par défaut
parameters	elasticsearchChatExtensionParameters	Paramètres à utiliser lors de la configuration d’Elasticsearch® en tant qu’extension de chat OpenAI d’Azure.	Non
type	azureChatExtensionType	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.	Oui

elasticsearchChatExtensionParameters

Paramètres à utiliser lors de la configuration d’Elasticsearch® en tant qu’extension de chat OpenAI d’Azure.

Nom	Catégorie	Description	Obligatoire	Par défaut
allow_partial_result	booléen	Si spécifié comme vrai, le système permettra d’utiliser des résultats partiels de recherche et la requête échoue si toutes les requêtes échouent. Si elle n’est pas spécifiée ou spécifiée comme fausse, la requête échouera si une requête de recherche échoue.	Non	Faux
Authentification	onYourDataKeyAndKeyIdAuthenticationOptions ou onYourDataEncodedApiKeyAuthenticationOptions		Oui
embedding_dependency	onTonDataDataEndpointVectorisationSource ou surTonDataDéploiementNomVectorisationSource ou surVotReModèleIdVectorisationSource		Non
endpoint	string	Le point culminant d’Elasticsearch®.	Oui
cartographie des champs	elasticsearchIndexFieldMappingOptions	Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Elasticsearch® configurée.	Non
in_scope	booléen	Est-ce que les requêtes doivent être restreintes à l’utilisation de données indexées.	Non
include_contexts	tableau	Les propriétés incluses du contexte de sortie. Si ce n’est pas spécifié, la valeur par défaut est citations et intent.	Non
nom_de_l'index	string	Le nom d’index d’Elasticsearch®.	Oui
max_search_queries	entier	Le nombre maximal de requêtes réécrites doit être envoyé au fournisseur de recherche pour un message utilisateur. Si ce n’est pas spécifié, le système décidera du nombre de requêtes à envoyer.	Non
type_de_requête	elasticsearchQueryType	Le type de requête de récupération Elasticsearch® qui doit être exécutée lorsqu’il est utilisé comme extension de chat OpenAI sur Azure.	Non
Rigueur	entier	La stricteur configurée du filtrage de pertinence de recherche. Plus la rigueur est élevée, plus la précision est élevée mais moins la mémoire de la réponse est élevée.	Non
top_n_documents	entier	Le nombre supérieur configuré de documents à présenter pour la requête configurée.	Non

elasticsearchIndexFieldMappingOptions

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Elasticsearch® configurée.

Nom	Catégorie	Description	Obligatoire	Par défaut
champs_de_contenu	tableau	Les noms des champs d’index qui doivent être considérés comme du contenu.	Non
séparateur_de_champs_de_contenu	string	Le motif séparateur que les champs de contenu doivent utiliser.	Non
filepath_field	string	Le nom du champ d’index à utiliser comme chemin de fichier.	Non
champ_titre	string	Le nom du champ index à utiliser comme titre.	Non
url_field	string	Le nom du champ index à utiliser comme URL.	Non
champs vectoriels	tableau	Les noms des champs qui représentent des données vectorielles.	Non

elasticsearchQueryType

Le type de requête de récupération Elasticsearch® qui doit être exécutée lorsqu’il est utilisé comme extension de chat OpenAI sur Azure.

Propriété	Valeur
Description	Le type de requête de récupération Elasticsearch® qui doit être exécutée lorsqu’il est utilisé comme extension de chat OpenAI sur Azure.
Type	string
Valeurs	simple vector

mongoDBChatExtensionConfiguration

Une représentation spécifique des options configurables pour Mongo DB lorsqu’il est utilisé comme extension de chat OpenAI Azure.

Nom	Catégorie	Description	Obligatoire	Par défaut
parameters	mongoDBChatExtensionParameters	Paramètres à utiliser lors de la configuration des extensions de chat Azure OpenAI On Your Data lors de l’utilisation de la base de données Mongo.	Non
type	azureChatExtensionType	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.	Oui

mongoDBChatExtensionParameters

Paramètres à utiliser lors de la configuration des extensions de chat Azure OpenAI On Your Data lors de l’utilisation de la base de données Mongo.

Nom	Catégorie	Description	Obligatoire	Par défaut
allow_partial_result	booléen	Si spécifié comme vrai, le système permettra d’utiliser des résultats partiels de recherche et la requête échoue si toutes les requêtes échouent. Si elle n’est pas spécifiée ou spécifiée comme fausse, la requête échouera si une requête de recherche échoue.	Non	Faux
app_name	string	Le nom de l’application de la base de données Mongo.	Oui
Authentification	onYourDataUsernameAndPasswordAuthenticationOptions	Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’un nom d’utilisateur et d’un mot de passe.	Oui
collection_name	string	Le nom de la collection Mongo DB.	Oui
database_name	string	Le nom de la base de données Mongo.	Oui
embedding_dependency	onTonDataDataEndpointVectorisationSource ou surVotReDonnéesDéploiementNomVectorisationSource		Oui
endpoint	string	Le nom du point de terminaison du cluster Mongo DB.	Oui
cartographie des champs	mongoDBFieldMappingOptions	Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource de base de données Mongo configurée.	Oui
in_scope	booléen	Est-ce que les requêtes doivent être restreintes à l’utilisation de données indexées.	Non
include_contexts	tableau	Les propriétés incluses du contexte de sortie. Si ce n’est pas spécifié, la valeur par défaut est citations et intent.	Non
nom_de_l'index	string	Le nom de l’index de la base de données Mongo.	Oui
max_search_queries	entier	Le nombre maximal de requêtes réécrites doit être envoyé au fournisseur de recherche pour un message utilisateur. Si ce n’est pas spécifié, le système décidera du nombre de requêtes à envoyer.	Non
Rigueur	entier	La stricteur configurée du filtrage de pertinence de recherche. Plus la rigueur est élevée, plus la précision est élevée mais moins la mémoire de la réponse est élevée.	Non
top_n_documents	entier	Le nombre supérieur configuré de documents à présenter pour la requête configurée.	Non

mongoDBFieldMappingOptions

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource de base de données Mongo configurée.

Nom	Catégorie	Description	Obligatoire	Par défaut
champs_de_contenu	tableau	Les noms des champs d’index qui doivent être considérés comme du contenu.	Oui
séparateur_de_champs_de_contenu	string	Le motif séparateur que les champs de contenu doivent utiliser.	Non
filepath_field	string	Le nom du champ d’index à utiliser comme chemin de fichier.	Non
champ_titre	string	Le nom du champ index à utiliser comme titre.	Non
url_field	string	Le nom du champ index à utiliser comme URL.	Non
champs vectoriels	tableau	Les noms des champs qui représentent des données vectorielles.	Oui

pineconeChatExtensionConfiguration

Une représentation spécifique des options configurables pour Pinecone lorsqu’il est utilisé comme extension de chat OpenAI Azure.

Nom	Catégorie	Description	Obligatoire	Par défaut
parameters	pineconeChatExtensionParameters	Paramètres pour configurer les extensions de chat Azure OpenAI Pinecone.	Non
type	azureChatExtensionType	Une représentation des données de configuration pour une seule extension de chat OpenAI d’Azure. Cela sera utilisé par une demande de complétion de chat qui devrait utiliser les extensions de chat OpenAI d’Azure pour renforcer le comportement de réponse. L’utilisation de cette configuration est compatible uniquement avec Azure OpenAI.	Oui

pineconeChatExtensionParameters

Paramètres pour configurer les extensions de chat Azure OpenAI Pinecone.

Nom	Catégorie	Description	Obligatoire	Par défaut
allow_partial_result	booléen	Si spécifié comme vrai, le système permettra d’utiliser des résultats partiels de recherche et la requête échoue si toutes les requêtes échouent. Si elle n’est pas spécifiée ou spécifiée comme fausse, la requête échouera si une requête de recherche échoue.	Non	Faux
Authentification	onYourDataApiKeyAuthenticationOptions	Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une clé API.	Oui
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Les détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un nom de déploiement interne du modèle d’embeddings dans la même ressource Azure OpenAI.	Oui
environment	string	Le nom d’environnement est Pinecone.	Oui
cartographie des champs	pineconeFieldMappingOptions	Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Pinecone configurée.	Oui
in_scope	booléen	Est-ce que les requêtes doivent être restreintes à l’utilisation de données indexées.	Non
include_contexts	tableau	Les propriétés incluses du contexte de sortie. Si ce n’est pas spécifié, la valeur par défaut est citations et intent.	Non
nom_de_l'index	string	Le nom de l’index de la base de données Pinecone.	Oui
max_search_queries	entier	Le nombre maximal de requêtes réécrites doit être envoyé au fournisseur de recherche pour un message utilisateur. Si ce n’est pas spécifié, le système décidera du nombre de requêtes à envoyer.	Non
Rigueur	entier	La stricteur configurée du filtrage de pertinence de recherche. Plus la rigueur est élevée, plus la précision est élevée mais moins la mémoire de la réponse est élevée.	Non
top_n_documents	entier	Le nombre supérieur configuré de documents à présenter pour la requête configurée.	Non

pineconeFieldMappingOptions

Paramètres optionnels pour contrôler le traitement des champs lors de l’utilisation d’une ressource Pinecone configurée.

Nom	Catégorie	Description	Obligatoire	Par défaut
champs_de_contenu	tableau	Les noms des champs d’index qui doivent être considérés comme du contenu.	Oui
séparateur_de_champs_de_contenu	string	Le motif séparateur que les champs de contenu doivent utiliser.	Non
filepath_field	string	Le nom du champ d’index à utiliser comme chemin de fichier.	Non
champ_titre	string	Le nom du champ index à utiliser comme titre.	Non
url_field	string	Le nom du champ index à utiliser comme URL.	Non

surVosOptionsD'AuthentificationDesDonnées

Les options d’authentification pour Azure OpenAI sur vos données.

Discriminateur pour onYourDataAuthenticationOptions

Ce composant utilise la propriété type pour distinguer différents types :

Valeur de type	Schema
api_key	onYourDataApiKeyAuthenticationOptions
connection_string	onYourDataConnectionStringAuthenticationOptions
key_and_key_id	onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key	onYourDataEncodedApiKeyAuthenticationOptions
access_token	onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password	onYourDataUsernameAndPasswordAuthenticationOptions

Nom	Catégorie	Description	Obligatoire	Par défaut
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataContextProperty

La propriété de contexte.

Propriété	Valeur
Description	La propriété de contexte.
Type	string
Valeurs	citations intent all_retrieved_documents

onYourDataAuthenticationType

Les types d’authentification pris en charge par Azure OpenAI On Your Data.

Propriété	Valeur
Description	Les types d’authentification pris en charge par Azure OpenAI On Your Data.
Type	string
Valeurs	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

onYourDataApiKeyAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une clé API.

Nom	Catégorie	Description	Obligatoire	Par défaut
clé	string	La clé API à utiliser pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataConnectionStringAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une chaîne de connexion.

Nom	Catégorie	Description	Obligatoire	Par défaut
connection_string	string	La chaîne de connexion à utiliser pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataKeyAndKeyIdAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lorsqu’on utilise une paire clé et identifiant de clé Elasticsearch.

Nom	Catégorie	Description	Obligatoire	Par défaut
clé	string	La clé Elasticsearch à utiliser pour l’authentification.	Non
key_id	string	L’identifiant de clé Elasticsearch à utiliser pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataEncodedApiKeyAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une clé API codée par Elasticsearch.

Nom	Catégorie	Description	Obligatoire	Par défaut
encoded_api_key	string	La clé API codée par Elasticsearch pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataAccessTokenAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation du jeton d’accès.

Nom	Catégorie	Description	Obligatoire	Par défaut
jeton d'accès	string	Le jeton d’accès à utiliser pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une identité managée attribuée au système.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’une identité managée attribuée par l’utilisateur.

Nom	Catégorie	Description	Obligatoire	Par défaut
managed_identity_resource_id	string	L’identifiant de ressource de l’identité managée attribuée par l’utilisateur à utiliser pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui

onYourDataUsernameAndPasswordAuthenticationOptions

Les options d’authentification pour Azure OpenAI On Your Data lors de l’utilisation d’un nom d’utilisateur et d’un mot de passe.

Nom	Catégorie	Description	Obligatoire	Par défaut
mot de passe	string	Mot de passe. pour l’authentification.	Non
type	onYourDataAuthenticationType	Les types d’authentification pris en charge par Azure OpenAI On Your Data.	Oui
username	string	Le nom d’utilisateur à utiliser pour l’authentification.	Non

onYourDataVectorizationSource

Une représentation abstraite d’une source de vectorisation pour Azure OpenAI On Your Data avec recherche vectorielle.

Ce composant utilise la propriété type pour distinguer différents types :

Valeur de type	Schema
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

Nom	Catégorie	Description	Obligatoire	Par défaut
type	onYourDataVectorizationSourceType	Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.	Oui

onYourDataVectorizationSourceType

Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.

Propriété	Valeur
Description	Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.
Type	string
Valeurs	endpoint deployment_name integrated model_id

onYourDataEndpointVectorizationSource

Les détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un appel public d’intégration Azure OpenAI.

Nom	Catégorie	Description	Obligatoire	Par défaut
Authentification	onYourDataApiKeyAuthenticationOptions ou onYourDataAccessTokenAuthenticationOptions		Non
dimensions	entier	Le nombre de dimensions que les embeddings doivent avoir. Pris en charge uniquement dans text-embedding-3 les modèles et les modèles ultérieurs.	Non
endpoint	string	Spécifie l’URL du point de terminaison de ressource à partir duquel les embeddings doivent être récupérés. Elle doit être au format .https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings Le paramètre de requête version API n’est pas autorisé.	Non
type	onYourDataVectorizationSourceType	Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.	Oui

onYourDataDeploymentNameVectorizationSource

Les détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, basée sur un nom de déploiement interne de modèle d’embeddings dans la même ressource Azure OpenAI.

Nom	Catégorie	Description	Obligatoire	Par défaut
nom_de_déploiement	string	Spécifie le nom du déploiement du modèle à utiliser pour la vectorisation. Ce déploiement du modèle doit se faire dans la même ressource Azure OpenAI, mais On Your Data utilisera ce déploiement via un appel interne plutôt que public, ce qui permet la recherche vectorielle même dans les réseaux privés.	Non
dimensions	entier	Le nombre de dimensions que les embeddings doivent avoir. Pris en charge uniquement dans text-embedding-3 les modèles et les modèles ultérieurs.	Non
type	onYourDataVectorizationSourceType	Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.	Oui

onYourDataIntegratedVectorizationSource

Représente le vectoriseur intégré défini dans la ressource de recherche.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	onYourDataVectorizationSourceType	Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.	Oui

onYourDataModelIdVectorizationSource

Les détails d’une source de vectorisation, utilisée par Azure OpenAI On Your Data lors de l’application de la recherche vectorielle, est basée sur un ID de modèle de service de recherche. Actuellement uniquement pris en charge par Elasticsearch®.

Nom	Catégorie	Description	Obligatoire	Par défaut
model_id	string	Spécifie l’identifiant du modèle à utiliser pour la vectorisation. Cet ID de modèle doit être défini dans le service de recherche.	Non
type	onYourDataVectorizationSourceType	Représente les sources disponibles qu’Azure OpenAI On Your Data peut utiliser pour configurer la vectorisation des données à utiliser avec la recherche vectorielle.	Oui

azureChatExtensionsMessageContext

Une représentation des informations contextuelles supplémentaires disponibles lorsque des extensions de chat OpenAI d’Azure sont impliquées dans la génération d’une réponse de complétion de chat correspondante. Ces informations contextuelles ne sont remplies que lorsqu’on utilise une requête OpenAI Azure configurée pour utiliser une extension correspondante.

Nom	Catégorie	Description	Obligatoire	Par défaut
all_retrieved_documents	tableau	Tous les documents récupérés.	Non
citations	tableau	Le résultat de la récupération de la source de données, utilisé pour générer le message de l’assistant dans la réponse.	Non
objectif	string	L’intention détectée dans l’historique du chat, utilisée pour passer au tour suivant afin de transmettre le contexte.	Non

citation

Informations de citation pour un message de réponse à la fin d’un chat.

Nom	Catégorie	Description	Obligatoire	Par défaut
identifiant_du_segment	string	L’identifiant du bloc de la contravention.	Non
contenu	string	Le contenu de la citation.	Oui
chemin d’accès	string	Le chemin du fichier de la citation.	Non
rerank_score	number	Le score de reclassement du document récupéré.	Non
title	string	Le titre de la citation.	Non
url	string	L’URL de la source.	Non

retrievedDocument

Le document récupéré.

Nom	Catégorie	Description	Obligatoire	Par défaut
identifiant_du_segment	string	L’identifiant du bloc de la contravention.	Non
contenu	string	Le contenu de la citation.	Oui
data_source_index	entier	L’index de la source de données.	Non
chemin d’accès	string	Le chemin du fichier de la citation.	Non
filter_reason	filterReason	La raison de filtrage du document récupéré.	Non
original_search_score	number	Le score de recherche original du document récupéré.	Non
rerank_score	number	Le score de reclassement du document récupéré.	Non
search_queries	tableau	Les requêtes de recherche utilisées pour récupérer le document.	Non
title	string	Le titre de la citation.	Non
url	string	L’URL de la source.	Non

filterReason

La raison de filtrage du document récupéré.

Propriété	Valeur
Description	La raison de filtrage du document récupéré.
Type	string
Valeurs	score rerank

chatCompletionMessageToolCall

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet	La fonction que le modèle a appelée.	Oui
└─ Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON. Notez que le modèle ne génère pas toujours un JSON valide, et peut halluciner des paramètres non définis par votre schéma de fonction. Validez les arguments de votre code avant d’appeler votre fonction.	Non
└─ Nom	string	Le nom de la fonction à appeler.	Non
ID	string	L’identifiant de l’appel à outils.	Oui
type	toolCallType	Le type d’appel de l’outil, dans ce cas function.	Oui

toolCallType

Le type d’appel de l’outil, dans ce cas function.

Propriété	Valeur
Description	Le type d’appel de l’outil, dans ce cas function.
Type	string
Valeurs	function

chatCompletionRequestMessageTool

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	string	Le contenu du message.	Non
tool_call_id	string	Appel d’outil auquel ce message répond.	Non

chatCompletionRequestMessageFunction

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	string	Le contenu du message.	Non
name	string	Le contenu du message.	Non
role	enum	Le rôle de l’auteur des messages, dans ce cas function. Valeurs possibles : function	Non

createChatCompletionResponse

Représente une réponse de fin de discussion retournée par le modèle, basée sur l’entrée fournie.

Nom	Catégorie	Description	Obligatoire	Par défaut
choix	tableau	Une liste des options pour compléter le chat. Peut être plus d’un si n c’est supérieur à 1.	Oui
créé	entier	L’horodatage Unix (en quelques secondes) de la création de la fin du chat.	Oui
ID	string	Un identifiant unique pour la fin du chat.	Oui
model	string	Le modèle utilisé pour compléter le chat.	Oui
Objet	enum	Le type d’objet, qui est toujours chat.completion. Valeurs possibles : chat.completion	Oui
prompt_filter_results	promptFilterResults	Filtrage de contenu pour zéro ou plus d’invites dans la requête. Dans une requête en streaming, les résultats pour différentes invitations peuvent arriver à des moments ou dans des ordres différents.	Non
system_fingerprint	string	Cette empreinte digitale représente la configuration backend avec laquelle le modèle fonctionne. Peut être utilisé conjointement avec le seed paramètre de requête pour comprendre quand des modifications en backend ont été effectuées pouvant impacter le déterminisme.	Non
utilisation	completionUsage	Statistiques d’utilisation pour la demande de complétion.	Non

createChatCompletionStreamResponse

Représente un segment diffusé d’une réponse de fin de chat retournée par le modèle, basé sur l’entrée fournie.

Nom	Catégorie	Description	Obligatoire	Par défaut
choix	tableau	Une liste des options pour compléter le chat. Peut contenir plus d’un élément si n est supérieur à 1.	Oui
créé	entier	L’horodatage Unix (en quelques secondes) de la création de la fin du chat. Chaque morceau a le même horodatage.	Oui
ID	string	Un identifiant unique pour la fin du chat. Chaque morceau a le même ID.	Oui
model	string	Le modèle pour générer la complétion.	Oui
Objet	enum	Le type d’objet, qui est toujours chat.completion.chunk. Valeurs possibles : chat.completion.chunk	Oui
system_fingerprint	string	Cette empreinte digitale représente la configuration backend avec laquelle le modèle fonctionne. Peut être utilisé conjointement avec le seed paramètre de requête pour comprendre quand des modifications en backend ont été effectuées pouvant impacter le déterminisme.	Non

chatCompletionStreamResponseDelta

Un delta de complétion du chat généré par les réponses du modèle en streaming.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	string	Le contenu du message du bloc.	Non
function_call	Objet	Déprécié et remplacé par tool_calls. Le nom et les arguments d’une fonction à appeler, tels que générés par le modèle.	Non
└─ Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON. Notez que le modèle ne génère pas toujours un JSON valide, et peut halluciner des paramètres non définis par votre schéma de fonction. Validez les arguments de votre code avant d’appeler votre fonction.	Non
└─ Nom	string	Le nom de la fonction à appeler.	Non
refusal	string	Le message de refus généré par le modèle.	Non
role	enum	Le rôle de l’auteur de ce message. Valeurs possibles : system, user, assistant, tool	Non
tool_calls	tableau		Non

chatCompletionMessageToolCallChunk

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet		Non
└─ Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON. Notez que le modèle ne génère pas toujours un JSON valide, et peut halluciner des paramètres non définis par votre schéma de fonction. Validez les arguments de votre code avant d’appeler votre fonction.	Non
└─ Nom	string	Le nom de la fonction à appeler.	Non
ID	string	L’identifiant de l’appel à outils.	Non
index	entier		Oui
type	enum	Le type d’outil. Actuellement, seul function est pris en charge. Valeurs possibles : function	Non

chatCompletionStreamOptions

Options pour la réponse en streaming. Ne réglez cela que lorsque vous activez stream: true.

Nom	Catégorie	Description	Obligatoire	Par défaut
include_usage	booléen	Si elle est définie, un segment supplémentaire sera diffusé avant le data: [DONE] message. Le usage champ sur ce chunk affiche les statistiques d’utilisation du token pour l’ensemble de la requête, et le choices champ restera toujours un tableau vide. Tous les autres chunks incluront également un usage champ, mais avec une valeur nulle.	Non

chatCompletionChoiceLogProbs

Enregistrez les informations de probabilité pour le choix.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	tableau	Une liste des jetons de contenu des messages avec les informations de probabilité logarithmique.	Oui
refusal	tableau	Une liste de jetons de refus de message avec des informations de probabilité logarithmique.	Non

chatCompletionTokenLogprob

Nom	Catégorie	Description	Obligatoire	Par défaut
Octets	tableau	Une liste d’entiers représentant la représentation UTF-8 octets du jeton. Utile dans les cas où les caractères sont représentés par plusieurs jetons et où leurs représentations en octets doivent être combinées pour générer la représentation du texte correcte. Peut l’être null s’il n’y a pas de représentation en octets pour le jeton.	Oui
logprob	number	La probabilité logarithmique de ce jeton.	Oui
Jeton	string	Jeton.	Oui
top_logprobs	tableau	Liste des jetons les plus probables et de leur probabilité logarithmique, à cette position de jeton. Dans de rares cas, il peut y avoir moins de top_logprobs demandes retournées.	Oui

Message de réponse de complétion de chat

Un message de complétion de chat généré par le modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
Audio	Objet	Si la modalité de sortie audio est demandée, cet objet contient des données sur la réponse audio du modèle.	Non
└─ données	string	Base64 a encodé des octets audio générés par le modèle, dans le format spécifié dans la requête.	Non
expires_at	entier	L’horodatage Unix (en secondes) indiquant que cette réponse audio ne sera plus accessible sur le serveur pour une utilisation dans des conversations à plusieurs tours.	Non
└─ identifiant	string	Identifiant unique pour cette réponse audio.	Non
└─ transcription	string	Transcription de l’audio généré par le modèle.	Non
contenu	string	Le contenu du message.	Oui
context	azureChatExtensionsMessageContext	Une représentation des informations contextuelles supplémentaires disponibles lorsque des extensions de chat OpenAI d’Azure sont impliquées dans la génération d’une réponse de complétion de chat correspondante. Ces informations contextuelles ne sont remplies que lorsqu’on utilise une requête OpenAI Azure configurée pour utiliser une extension correspondante.	Non
function_call	chatCompletionFunctionCall	Déprécié et remplacé par tool_calls. Le nom et les arguments d’une fonction à appeler, tels que générés par le modèle.	Non
refusal	string	Le message de refus généré par le modèle.	Oui
role	chatCompletionResponseMessageRole	Le rôle de l’auteur du message de réponse.	Oui
tool_calls	tableau	Les appels d’outils générés par le modèle, tels que les appels de fonction.	Non

chatCompletionResponseMessageRole

Le rôle de l’auteur du message de réponse.

Propriété	Valeur
Description	Le rôle de l’auteur du message de réponse.
Type	string
Valeurs	assistant

chatCompletionToolChoiceOption

Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera 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. Spécifier un outil particulier force {"type": "function", "function": {"name": "my_function"}} le modèle à appeler cet outil. none est la norme par défaut lorsqu’aucun outil n’est présent. auto est la norme par défaut si des outils sont présents.

Ce composant peut être l’un des suivants :

• chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

Spécifie un outil que le modèle doit utiliser. À utiliser pour forcer le modèle à appeler une fonction spécifique.

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet		Oui
└─ Nom	string	Le nom de la fonction à appeler.	Non
type	enum	Le type d’outil. Actuellement, seul function est pris en charge. Valeurs possibles : function	Oui

ParallelToolCalls

S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.

Aucune propriété définie pour ce composant.

PredictionContent

Contenu de sortie prédit statique, comme le contenu d’un fichier texte en cours de régénération.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou tableau	Le contenu qui doit être correspondu lors de la génération d’une réponse modèle. Si les jetons générés correspondent à ce contenu, la réponse complète du modèle peut être retournée beaucoup plus rapidement.	Oui
type	enum	Le type de contenu prédit que vous souhaitez fournir. Ce type est actuellement toujours content. Valeurs possibles : content	Oui

chatCompletionMessageToolCalls

Les appels d’outils générés par le modèle, tels que les appels de fonction.

Aucune propriété définie pour ce composant.

ChatCompletionModalities

Types de sortie que vous souhaitez que le modèle génère pour cette requête. La plupart des modèles sont capables de générer du texte, ce qui est le principe par défaut :

["text"]

Le gpt-4o-audio-preview modèle peut également être utilisé pour générer de l’audio. Pour demander à ce modèle de générer à la fois des réponses textuelles et audio, vous pouvez utiliser :

["text", "audio"]

Aucune propriété définie pour ce composant.

chatCompletionFunctionCall

Déprécié et remplacé par tool_calls. Le nom et les arguments d’une fonction à appeler, tels que générés par le modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
Arguments	string	Les arguments pour appeler la fonction avec, telle que générée par le modèle au format JSON. Notez que le modèle ne génère pas toujours un JSON valide, et peut halluciner des paramètres non définis par votre schéma de fonction. Validez les arguments de votre code avant d’appeler votre fonction.	Oui
name	string	Le nom de la fonction à appeler.	Oui

completionUsage

Statistiques d’utilisation pour la demande de complétion.

Nom	Catégorie	Description	Obligatoire	Par défaut
completion_tokens	entier	Nombre de jetons dans la complétion générée.	Oui
completion_tokens_details	Objet	Répartition des jetons utilisés dans une complétion.	Non
└─ jetons_de_prédiction_acceptés	entier	Lors de l’utilisation des sorties prédites, le nombre de jetons dans la prédiction apparaissant dans la complétion.	Non
└audio_tokens	entier	Jetons d’entrée audio générés par le modèle.	Non
└─ jetons_de_raisonnement	entier	Des jetons générés par le modèle pour raisonner.	Non
└─ jetons_de_prédiction_rejetés	entier	Lors de l’utilisation des sorties prédites, le nombre de jetons dans la prédiction qui n’apparaissaient pas dans la complétion. Cependant, comme les jetons de raisonnement, ces jetons sont toujours comptabilisés dans le total des jetons de complétion pour les besoins de facturation, de sortie et de limites de fenêtres contextuelles.	Non
prompt_tokens	entier	Nombre de jetons dans la consigne.	Oui
prompt_tokens_details	Objet	Détails des jetons de la consigne.	Non
└audio_tokens	entier	Jetons d’entrée audio présents dans la demande.	Non
└cached_tokens	entier	Le nombre de jetons d’invite mis en cache.	Non
total_tokens	entier	Nombre total de jetons utilisés dans la requête (prompt + complétion).	Oui

chatCompletionTool

Nom	Catégorie	Description	Obligatoire	Par défaut
function	FunctionObject		Oui
type	enum	Le type d’outil. Actuellement, seul function est pris en charge. Valeurs possibles : function	Oui

FunctionParameters

Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, ainsi que la référence du schéma JSON pour la documentation sur le format.

Omettre parameters définit une fonction avec une liste de paramètres vide.

Aucune propriété définie pour ce composant.

FunctionObject

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
name	string	Le nom de la fonction à appeler. Doit être de A à Z, de A à Z, de 0 à 9, ou contenir des sous-traits et des titres, avec une longueur maximale de 64.	Oui
parameters	FunctionParameters	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, ainsi que la référence du schéma JSON pour la documentation sur le format. Omettre parameters définit une fonction avec une liste de paramètres vide.	Non
strict	booléen	S’il faut activer une stricte adhésion au schéma lors de la génération de l’appel de fonction. Si le modèle est réglé sur true, le modèle suivra exactement le schéma défini dans le parameters champ. Seul un sous-ensemble de JSON Schema est pris en charge lorsque strict est true.	Non	Faux

ResponseFormatText

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Le type de format de réponse défini : text Valeurs possibles : text	Oui

ResponseFormatJsonObject

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Le type de format de réponse défini : json_object Valeurs possibles : json_object	Oui

ResponseFormatJsonSchemaSchema

Le schéma pour le format de réponse est décrit comme un objet de schéma JSON.

Aucune propriété définie pour ce composant.

ResponseFormatJsonSchema

Nom	Catégorie	Description	Obligatoire	Par défaut
json_schema	Objet		Oui
Description de └>	string	Une description du format de réponse, utilisée par le modèle pour déterminer comment répondre dans ce format.	Non
└─ Nom	string	Le nom du format de la réponse. Doit être de A à Z, de A à Z, de 0 à 9, ou contenir des sous-traits et des titres, avec une longueur maximale de 64.	Non
└─ Schéma	ResponseFormatJsonSchemaSchema	Le schéma pour le format de réponse est décrit comme un objet de schéma JSON.	Non
└' strict	booléen	S’il faut activer une stricte adhésion au schéma lors de la génération de la sortie. Si le modèle est réglé sur vrai, le modèle suivra toujours exactement le schéma défini sur le schema terrain. Seul un sous-ensemble de JSON Schema est pris en charge lorsque strict est true.	Non	Faux
type	enum	Le type de format de réponse défini : json_schema Valeurs possibles : json_schema	Oui

chatCompletionChoiceCommon

Nom	Catégorie	Description	Obligatoire	Par défaut
finish_reason	string		Non
index	entier		Non

créerDemandeDeTraduction

Demande de traduction.

Nom	Catégorie	Description	Obligatoire	Par défaut
fichier	string	Le fichier audio à traduire.	Oui
prompt	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. Le prompt doit être en anglais.	Non
format_de_réponse	audioResponseFormat	Définit le format de la sortie.	Non
Température	number	La température d’échantillonnage, comprise entre 0 et 1. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Si elle est réglée à 0, le modèle utilise la probabilité logarithmique pour augmenter automatiquement la température jusqu’à atteindre certains seuils.	Non	0

réponse audio

Réponse à la traduction ou à la transcription lorsque response_format était json

Nom	Catégorie	Description	Obligatoire	Par défaut
texte	string	Texte traduit ou transcrit.	Oui

audioVerboseResponse

Réponse à la traduction ou à la transcription lorsque response_format était verbose_json

Nom	Catégorie	Description	Obligatoire	Par défaut
durée	number	Durée.	Non
language	string	Language.	Non
segments	tableau		Non
tâche	string	Type de tâche audio.	Non
texte	string	Texte traduit ou transcrit.	Oui
words	tableau		Non

audioResponseFormat

Définit le format de la sortie.

Propriété	Valeur
Description	Définit le format de la sortie.
Type	string
Valeurs	json text srt verbose_json vtt

créerDemandeDeTranscription

Demande de transcription.

Nom	Catégorie	Description	Obligatoire	Par défaut
fichier	string	L’objet du fichier audio à transcrire.	Oui
language	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 améliore la précision et la latence.	Non
prompt	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. La consigne doit correspondre au langage audio.	Non
format_de_réponse	audioResponseFormat	Définit le format de la sortie.	Non
Température	number	La température d’échantillonnage, comprise entre 0 et 1. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Si elle est réglée à 0, le modèle utilise la probabilité logarithmique pour augmenter automatiquement la température jusqu’à atteindre certains seuils.	Non	0
timestamp_granularities[]	tableau	Les détails temporels à remplir pour cette transcription. response_format doit être réglé verbose_json pour utiliser des granularités horodatages. L’une ou l’autre de ces options est prise en charge : word, ou segment. Remarque : Il n’y a pas de latence supplémentaire pour les horodatages de segments, mais la génération de horodatages de mots entraîne une latence supplémentaire.	Non	['segment']

audioSegment

Segment de transcription ou de traduction.

Nom	Catégorie	Description	Obligatoire	Par défaut
avg_logprob	number	Probabilité logarithmique moyenne.	Non
compression_ratio	number	Taux de compression.	Non
fin	number	Décalage de fin de segment.	Non
ID	entier	Identificateur de segment.	Non
no_speech_prob	number	Probabilité de « pas de parole ».	Non
Chercher	number	Décalage du segment.	Non
start	number	Décalage de début de segment.	Non
Température	number	Température.	Non
texte	string	Texte segmenté.	Non
tokens	tableau	Des symboles du texte.	Non

audioWord

Mot de transcription ou de traduction.

Nom	Catégorie	Description	Obligatoire	Par défaut
fin	number	Décalage de fin de Word.	Non
start	number	Décalage de départ Word.	Non
word	string	Word	Non

createSpeechRequest

Demande vocale.

Nom	Catégorie	Description	Obligatoire	Par défaut
entrée	string	Le texte pour synthétiser l’audio. La longueur maximale est de 4 096 caractères.	Oui
format_de_réponse	enum	Le format pour synthétiser l’audio. Valeurs possibles : mp3, opus, aac, flac, wav, pcm	Non
Vitesse	number	La vitesse de l’audio synthétisé. Sélectionnez une valeur de 0.25 vers 4.0. 1.0 est la norme par défaut.	Non	1.0
Voix	enum	La voix à utiliser pour la synthèse vocale. Valeurs possibles : alloy, echo, fable, onyx, nova, shimmer	Oui

imageQuality

La qualité de l’image qui sera générée.

Propriété	Valeur
Description	La qualité de l’image qui sera générée.
Type	string
Par défaut	auto
Valeurs	auto high medium low hd standard

imagesResponseFormat

Le format dans lequel les images générées sont renvoyées.

Propriété	Valeur
Description	Le format dans lequel les images générées sont renvoyées.
Type	string
Par défaut	url
Valeurs	url b64_json

imagesOutputFormat

Le format de fichier dans lequel les images générées sont renvoyées. Pris en charge uniquement pour les modèles de série.

Propriété	Valeur
Description	Le format de fichier dans lequel les images générées sont renvoyées. Pris en charge uniquement pour les modèles de la série GPT-image-1.
Type	string
Par défaut	png
Valeurs	png jpeg

taille de l’image

La taille des images générées.

Propriété	Valeur
Description	La taille des images générées.
Type	string
Par défaut	auto
Valeurs	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

imageStyle

Le style des images générées. Pris en charge uniquement pour DALL-E-3.

Propriété	Valeur
Description	Le style des images générées. Pris en charge uniquement pour DALL-E-3.
Type	string
Par défaut	vivid
Valeurs	vivid natural

imageBackground

Permet de définir la transparence pour l’arrière-plan de l’image ou des images générées. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1.

Propriété	Valeur
Description	Permet de définir la transparence pour l’arrière-plan de l’image ou des images générées. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1.
Type	string
Par défaut	auto
Valeurs	transparent opaque auto

demandeDeGénérationD'Images

Nom	Catégorie	Description	Obligatoire	Par défaut
Arrière-plan	imageBackground	Permet de définir la transparence pour l’arrière-plan de l’image ou des images générées. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1.	Non	auto
n	entier	Le nombre d’images à générer. Pour dall-e-3, seul n=1 est pris en charge.	Non	1
compression_de_sortie	entier	Le niveau de compression (0-100%) pour les images générées. Ce paramètre n’est pris en charge que pour les modèles série gpt-image-1 avec le format de sortie jpeg.	Non	100
format de sortie	imagesOutputFormat	Le format de fichier dans lequel les images générées sont renvoyées. Pris en charge uniquement pour les modèles de la série GPT-image-1.	Non	png
prompt	string	Une description textuelle de l’image ou des images souhaitées. La longueur maximale est de 32 000 caractères pour les modèles de la série gpt-image-1 et de 4 000 caractères pour dall-e-3	Oui
Qualité	imageQuality	La qualité de l’image qui sera générée.	Non	auto
format_de_réponse	imagesResponseFormat	Le format dans lequel les images générées sont renvoyées. Pris en charge uniquement pour DALL-E-3.	Non	url
size	imageSize	La taille des images générées.	Non	auto
style	imageStyle	Le style des images générées. Pris en charge uniquement pour DALL-E-3.	Non	vivid
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

imageEditsRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
image	chaîne ou tableau	L’image à modifier. Il doit s’agir d’un fichier image pris en charge ou d’un tableau d’images. Chaque image doit être un fichier png ou jpg de moins de 25 Mo.	Oui
Masque	string	Une image supplémentaire dont les zones entièrement transparentes (par exemple, où alpha est zéro) indiquent où l’image doit être éditée. Si plusieurs images sont fournies, le masque sera appliqué sur la première image. Il doit s’agir d’un fichier PNG valide, de moins de 4 Mo, et avoir les mêmes dimensions que l’image.	Non
n	entier	Le nombre d’images à générer.	Non	1
prompt	string	Une description textuelle de l’image ou des images souhaitées. La longueur maximale est de 32 000 caractères.	Oui
Qualité	imageQuality	La qualité de l’image qui sera générée.	Non	auto
format_de_réponse	imagesResponseFormat	Le format dans lequel les images générées sont renvoyées.	Non	url
size	imageSize	La taille des images générées.	Non	auto
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider à surveiller et détecter les abus.	Non

generateImagesResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
créé	entier	L’horodatage Unix lors de la création de l’opération.	Oui
Données	tableau	Les données de résultat de l’opération, si elles ont réussi	Oui
utilisation	imageGenerationsUsage	Représente les détails d’utilisation des jetons pour les requêtes de génération d’images. Uniquement pour les modèles GPT-image-1.	Non

résultat d'image

L’URL de l’image ou l’image encodée si elle réussit, et une erreur sinon.

Nom	Catégorie	Description	Obligatoire	Par défaut
b64_json	string	L’image codée en base64	Non
content_filter_results	dalleContentFilterResults	Informations sur les résultats du filtrage de contenu.	Non
prompt_filter_results	dalleFilterResults	Informations sur la catégorie de filtrage de contenu (haine, sexuel, violence, self_harm), si elle a été détectée, ainsi que sur le niveau de gravité (very_low, faible, moyen, élevé qui détermine l’intensité et le niveau de risque du contenu nuisible) et si elle a été filtrée ou non. Informations sur le contenu jailbreak et les jurons, s’ils ont été détectés, et si ils ont été filtrés ou non. Et des informations sur la liste de blocage des clients, si elle a été filtrée et son identifiant.	Non
revised_prompt	string	La demande utilisée pour générer l’image, s’il y avait une révision de la requête.	Non
url	string	L’URL de l’image.	Non

imageGenerationsUsage

Représente les détails d’utilisation des jetons pour les requêtes de génération d’images. Uniquement pour les modèles GPT-image-1.

Nom	Catégorie	Description	Obligatoire	Par défaut
input_tokens	entier	Le nombre de jetons d’entrée.	Non
input_tokens_details	Objet	Une analyse détaillée des jetons d’entrée.	Non
└image_tokens	entier	Le nombre de jetons d’image.	Non
└ text_tokens	entier	Le nombre de jetons textuels.	Non
output_tokens	entier	Le nombre de jetons de sortie.	Non
total_tokens	entier	Le nombre total de jetons utilisés.	Non

Ligne

Un objet ligne de contenu constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection.

Nom	Catégorie	Description	Obligatoire	Par défaut
spans	tableau	Un tableau de plages qui représentent les objets détectés et leurs informations de boîtes englobantes.	Oui
texte	string		Oui

span

Un objet span qui représente un objet détecté et ses informations de boîte englobante.

Nom	Catégorie	Description	Obligatoire	Par défaut
length	entier	La longueur de l’étendue en caractères, mesurée en points de code Unicode.	Oui
offset	entier	Le décalage de caractère dans le texte où commence l’étendue. Ce décalage est défini comme la position du premier caractère de l’étendue, comptant à partir du début du texte comme des points de code Unicode.	Oui
Polygone	tableau	Un tableau d’objets représentant des points dans le polygone qui enferme l’objet détecté.	Oui
texte	string	Le contenu textuel de l’étendue qui représente l’objet détecté.	Oui

runCompletionUsage

Statistiques d’utilisation liées à la course. Cette valeur sera null si la course n’est pas en état terminal (c’est-à-dire in_progress, queued, etc.).

Nom	Catégorie	Description	Obligatoire	Par défaut
completion_tokens	entier	Nombre de jetons de complétion utilisés au cours de la partie.	Oui
prompt_tokens	entier	Nombre de jetons d’invite utilisés au cours de la partie.	Oui
total_tokens	entier	Nombre total de jetons utilisés (invite + complétion).	Oui

runStepCompletionUsage

Statistiques d’utilisation liées à la phase de course. Cette valeur sera null alors que le statut de l’étape de course est in_progress.

Nom	Catégorie	Description	Obligatoire	Par défaut
completion_tokens	entier	Nombre de jetons de complétion utilisés au cours de l’étape de la course.	Oui
prompt_tokens	entier	Nombre de jetons de prompt utilisés au cours de l’étape de la course.	Oui
total_tokens	entier	Nombre total de jetons utilisés (invite + complétion).	Oui

assistantsApiResponseFormatOption

Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106.

Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées.

Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide.

Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.

Ce composant peut être l’un des suivants :

• ResponseFormatText
• ResponseFormatJsonObject
• ResponseFormatJsonSchema

assistantsApiResponseFormat

Un objet décrivant la sortie attendue du modèle. Si json_object seuls function les types tools sont autorisés à être transmis à la Run. Si text le modèle peut retourner du texte ou toute valeur nécessaire.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	string	Doit être l’un des text ou json_object.	Non	texte

type Enum : AssistantsApiResponseFormat

Valeur	Description
texte
json_object

assistantObject

Représente un assistant qui peut appeler le modèle et utiliser des outils.

Nom	Catégorie	Description	Obligatoire	Par défaut
date_de_création	entier	L’horodatage Unix (en secondes) indique la création de l’assistant.	Oui
description	string	La description de l’assistant. La longueur maximale est de 512 caractères.	Oui
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
consignes	string	Les instructions système que l’assistant utilise. La longueur maximale est de 256 000 caractères.	Oui
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Oui
model	string	ID du modèle à utiliser.	Oui
name	string	Le nom de l’assistante. La longueur maximale est de 256 caractères.	Oui
Objet	string	Le type d’objet, qui est toujours assistant.	Oui
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	L’identifiant du magasin vectoriel attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Une liste des outils activés sur l’assistant. Il peut y avoir un maximum de 128 outils par assistant. Les outils peuvent être de types code_interpreter, file_search, ou function.	Oui	[]
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1

objet Enum : AssistantObjectType

Valeur	Description
assistant	Le type d’objet, qui est toujours assistant

createAssistantRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	La description de l’assistant. La longueur maximale est de 512 caractères.	Non
consignes	string	Les instructions système que l’assistant utilise. La longueur maximale est de 256 000 caractères.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string		Oui
name	string	Le nom de l’assistante. La longueur maximale est de 256 caractères.	Non
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le stockage vectoriel est attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
└ vector_stores	tableau	Un assistant pour créer un stockage vectoriel avec file_ids et l’attacher à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Une liste des outils activés sur l’assistant. Il peut y avoir un maximum de 128 outils par assistant. Les outils peuvent être de types code_interpreter, retrieval, ou function.	Non	[]
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1

modifyAssistantRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	La description de l’assistant. La longueur maximale est de 512 caractères.	Non
consignes	string	Les instructions système que l’assistant utilise. La longueur maximale est de 32 768 caractères.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string		Non
name	string	Le nom de l’assistante. La longueur maximale est de 256 caractères.	Non
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Outrepasse la liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Remplace le stockage vectoriel attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Une liste des outils activés sur l’assistant. Il peut y avoir un maximum de 128 outils par assistant. Les outils peuvent être de types code_interpreter, retrieval, ou function.	Non	[]
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1

deleteAssistantResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
supprimé	booléen		Oui
ID	string		Oui
Objet	string		Oui

objet Enum : DeleteAssistantResponseState

Valeur	Description
assistant.deleted

listAssistantsResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

assistantToolsCode

Nom	Catégorie	Description	Obligatoire	Par défaut
type	string	Le type d’outil défini : code_interpreter	Oui

type Enum : assistantCodeCodeType

Valeur	Description
code_interpreter

assistantToolsFileSearch

Nom	Catégorie	Description	Obligatoire	Par défaut
file_search	Objet	Des dérogations pour l’outil de recherche de fichiers.	Non
└─ max_nombre_de_résultats	entier	Le nombre maximal de résultats que l’outil de recherche de fichiers devrait produire. Par défaut est 20 pour les modèles GPT-4* et 5 pour les GPT-3,5-turbo. Ce nombre devrait être compris entre 1 et 50. Notez que l’outil de recherche de fichiers peut produire moins de résultats.max_num_results	Non
type	string	Le type d’outil défini : file_search	Oui

type Enum : assistantToolsFileSearchType

Valeur	Description
file_search

assistantToolsFileSearchTypeOnly

Nom	Catégorie	Description	Obligatoire	Par défaut
type	string	Le type d’outil défini : file_search	Oui

type Enum : assistantToolsFileSearchType

Valeur	Description
file_search

assistantToolsFunction

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet	La définition de la fonction.	Oui
Description de └>	string	Une description de ce que fait la fonction, utilisée par le modèle pour choisir quand et comment appeler la fonction.	Non
└─ Nom	string	Le nom de la fonction à appeler. Doit être de A à Z, de A à Z, de 0 à 9, ou contenir des sous-traits et des titres, avec une longueur maximale de 64.	Non
└─ Paramètres	chatCompletionFunctionParameters	Les paramètres acceptés par les fonctions sont décrits comme un objet schéma JSON. Voir le guide pour des exemples, ainsi que la référence du schéma JSON pour la documentation sur le format.	Non
type	string	Le type d’outil défini : function	Oui

type Enum : assistantToolsFunction

Valeur	Description
function

truncationObject

Contrôles sur la façon dont un thread sera tronqué avant la sortie. Utilisez cela pour contrôler la fenêtre de contexte initiale de la partie.

Nom	Catégorie	Description	Obligatoire	Par défaut
last_messages	entier	Le nombre de messages les plus récents du thread lors de la construction du contexte de la séquence.	Non
type	string	La stratégie de troncature à utiliser pour le thread. La valeur par défaut est auto. Si elle est définie à last_messages, le thread sera tronqué aux n messages les plus récents du thread. Lorsqu’elle est définie à auto, les messages au milieu du thread seront supprimés pour correspondre à la longueur contextuelle du modèle, max_prompt_tokens.	Oui

type Enum : troncatureType

Valeur	Description
auto
last_messages

assistantsApiToolChoiceOption

Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera un message. auto est la valeur par défaut et signifie que le modèle peut choisir entre générer un message ou appeler un outil. Spécifier un outil particulier comme {"type": "file_search"} ou {"type": "function", "function": {"name": "my_function"}} force le modèle à appeler cet outil.

Ce composant peut être l’un des suivants :

• assistantsNamedToolChoice

assistantsNamedToolChoice

Spécifie un outil que le modèle doit utiliser. À utiliser pour forcer le modèle à appeler un outil spécifique.

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet		Non
└─ Nom	string	Le nom de la fonction à appeler.	Non
type	string	Le type d’outil. Si le type est function, le nom de la fonction doit être défini	Oui

type Enum : AssistantsNamedToolChoiceType

Valeur	Description
function
code_interpreter
file_search

runObject

Représente une exécution sur un thread.

Nom	Catégorie	Description	Obligatoire	Par défaut
assistant_id	string	L’identifiant de l’assistant utilisé pour l’exécution de cette course.	Oui
cancelled_at	entier	L’horodatage Unix (en quelques secondes) indique quand l’exécution a été annulée.	Oui
terminé_à	entier	L’horodatage Unix (en secondes) indique la fin de l’exécution.	Oui
date_de_création	entier	L’horodatage Unix (en secondes) indique la création de l’exécution.	Oui
expires_at	entier	L’horodatage Unix (en secondes) indique quand l’exécution expire.	Oui
failed_at	entier	L’horodatage Unix (en secondes) pour indiquer l’échec de l’exécution.	Oui
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
incomplete_details	Objet	Détails sur les raisons pour lesquelles la série est incomplète. Ça le null sera si la série n’est pas incomplète.	Oui
└─ raison	string	La raison pour laquelle la série est incomplète. Cela indiquera quelle limite spécifique de jetons a été atteinte au cours de la partie.	Non
consignes	string	Les instructions que l’assistant a utilisées pour cette course.	Oui
dernière_erreur	Objet	La dernière erreur associée à cette exécution. Ça le null sera s’il n’y a pas d’erreurs.	Oui
└─ Code	string	L’un des server_error ou rate_limit_exceeded.	Non
└─ Message	string	Une description lisible par l’homme de l’erreur.	Non
max_completion_tokens	entier	Le nombre maximal de jetons de complétion spécifiés à avoir utilisés au cours de la course.	Oui
max_prompt_tokens	entier	Le nombre maximal de jetons d’invite spécifiés à utiliser au cours de la séquence.	Oui
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Oui
model	string	Le modèle que l’assistant a utilisé pour cette séquence.	Oui
Objet	string	Le type d’objet, qui est toujours thread.run.	Oui
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
required_action	Objet	Détails sur l’action nécessaire pour poursuivre la course. Ce sera null le cas si aucune action n’est nécessaire.	Oui
soumettre_les_résultats_des_outils	Objet	Détails sur les sorties de l’outil nécessaires pour que cette série se poursuive.	Non
└─ appels_outils	tableau	Une liste des appels d’outils pertinents.	Non
└─ Type	enum	Pour l’instant, c’est toujours submit_tool_outputsça. Valeurs possibles : submit_tool_outputs	Non
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Oui
started_at	entier	L’horodatage Unix (en quelques secondes) indique le moment où la sortie a été lancée.	Oui
statut	string	Le statut de la séquence, qui peut être soit queued, in_progress, requires_action, cancelling, cancelledfailed, completed, ou expired.	Oui
Température	number	La température d’échantillonnage utilisée pour cette course. Si ce n’est pas réglé, par défaut est à 1.	Non
thread_id	string	L’identifiant des threads qui ont été exécutés dans le cadre de cette exécution.	Oui
tool_choice	assistantsApiToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera un message. auto est la valeur par défaut et signifie que le modèle peut choisir entre générer un message ou appeler un outil. Spécifier un outil particulier comme {"type": "file_search"} ou {"type": "function", "function": {"name": "my_function"}} force le modèle à appeler cet outil.	Oui
Outils	tableau	La liste des outils que l’assistant a utilisés pour cette course.	Oui	[]
top_p	number	La valeur d’échantillonnage du noyau utilisée pour cette course. Si ce n’est pas réglé, par défaut est à 1.	Non
truncation_strategy	truncationObject	Contrôles sur la façon dont un thread sera tronqué avant la sortie. Utilisez cela pour contrôler la fenêtre de contexte initiale de la partie.	Oui
utilisation	runCompletionUsage	Statistiques d’utilisation liées à la course. Cette valeur sera null si la course n’est pas en état terminal (c’est-à-dire in_progress, queued, etc.).	Oui

object Enum : runObjectType

Valeur	Description
thread.run	Le type d’objet run qui est toujours thread.run

status Enum : RunObjectStatus

Valeur	Description
queued	L’état en file d’attente
in_progress	L’État in_progress
requires_action	L’État required_action
cancelling	L’état d’annulation
cancelled	L’État annulé
a échoué	L’État en faillite
Terminé	L’état achevé
Expiré	L’État expiré

createRunRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
additional_instructions	string	Ajoute des instructions supplémentaires à la fin des instructions pour la sélection. Cela est utile pour modifier le comportement par exécution sans outrepasser d’autres instructions.	Non
additional_messages	tableau	Ajoute des messages supplémentaires au fil avant de créer la séquence.	Non
assistant_id	string	L’identifiant de l’assistant à utiliser pour exécuter cette course.	Oui
consignes	string	Écrase le message système par défaut de l’assistant. Cela est utile pour modifier le comportement par exécution.	Non
max_completion_tokens	entier	Le nombre maximal de jetons de complétion pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de complétion spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons d’achèvement spécifiés, elle se termine avec un statut incomplete. Voir incomplete_details pour plus d’informations.	Non
max_prompt_tokens	entier	Le nombre maximal de jetons de prompt pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de prompt spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons de prompt spécifiés, la série se termine avec le statut incomplete. Voir incomplete_details pour plus d’informations.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string	L’ID du modèle à utiliser pour exécuter cette exécution. Si une valeur est fournie ici, elle supprimera le modèle associé à l’assistant. Sinon, le modèle associé à l’assistant sera utilisé.	Non
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
stream	booléen	Si true, renvoie un flux d’événements qui se produisent pendant la Run comme événements envoyés par le serveur, se terminant lorsque la Run entre dans un état terminal avec un data: [DONE] message.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
tool_choice	assistantsApiToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera un message. auto est la valeur par défaut et signifie que le modèle peut choisir entre générer un message ou appeler un outil. Spécifier un outil particulier comme {"type": "file_search"} ou {"type": "function", "function": {"name": "my_function"}} force le modèle à appeler cet outil.	Non
Outils	tableau	Écartez les outils que l’assistant peut utiliser pour cette course. Cela est utile pour modifier le comportement par exécution.	Non
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1
truncation_strategy	truncationObject	Contrôles sur la façon dont un thread sera tronqué avant la sortie. Utilisez cela pour contrôler la fenêtre de contexte initiale de la partie.	Non

listRunsResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

modifyRunRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non

submitToolOutputsRunRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
stream	booléen	Si true, renvoie un flux d’événements qui se produisent pendant la Run comme événements envoyés par le serveur, se terminant lorsque la Run entre dans un état terminal avec un data: [DONE] message.	Non
tool_outputs	tableau	Une liste des outils pour lesquels les résultats sont soumis.	Oui

runToolCallObject

Objets d’appel d’outils

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet	La définition de la fonction.	Oui
└─ Arguments	string	Les arguments que le modèle attend de vous à transmettre à la fonction.	Non
└─ Nom	string	Le nom de la fonction.	Non
ID	string	L’identifiant de l’appel à outils. Cet ID doit être référencé lorsque vous soumettez les sorties de l’outil en utilisant les sorties d’outil d’envoi pour exécuter endpointendpoint.	Oui
type	string	Le type d’appel d’outil pour lequel la sortie est requise. Pour l’instant, c’est toujours functionça.	Oui

type Enum : RunToolCallObjectType

Valeur	Description
function

createThreadAndRunRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
assistant_id	string	L’identifiant de l’assistant à utiliser pour exécuter cette course.	Oui
consignes	string	Écrase le message système par défaut de l’assistant. Cela est utile pour modifier le comportement par exécution.	Non
max_completion_tokens	entier	Le nombre maximal de jetons de complétion pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de complétion spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons d’achèvement spécifiés, elle se termine avec un statut incomplete. Voir incomplete_details pour plus d’informations.	Non
max_prompt_tokens	entier	Le nombre maximal de jetons de prompt pouvant être utilisés au cours de la partie. La partie fait de son mieux pour n’utiliser que le nombre de jetons de prompt spécifiés, sur plusieurs tours de la partie. Si la série dépasse le nombre de jetons de prompt spécifiés, la série se termine avec le statut incomplete. Voir incomplete_details pour plus d’informations.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
model	string	L’identifiant des modèles à utiliser pour exécuter cette exécution. Si une valeur est fournie ici, elle supprimera le modèle associé à l’assistant. Sinon, le modèle associé à l’assistant sera utilisé.	Non
parallel_tool_calls	ParallelToolCalls	S’il faut activer l’appel de fonctions parallèles lors de l’utilisation de l’outil.	Non	True
format_de_réponse	assistantsApiResponseFormatOption	Précise le format que le modèle doit produire. Compatible avec GPT-4o, GPT-4 Turbo et tous les modèles GPT-3.5 Turbo depuis gpt-3.5-turbo-1106. Le réglage sur { "type": "json_schema", "json_schema": {...} } active les sorties structurées qui garantissent que le modèle correspond à votre schéma JSON fourni. En savoir plus dans le guide des sorties structurées. Activer { "type": "json_object" } le mode JSON, ce qui garantit que le message généré par le modèle est un JSON valide. Important : lors de l’utilisation du mode JSON, vous devez également demander au modèle de produire vous-même le JSON via un message système ou utilisateur. Sans cela, le modèle peut générer un flux ininterrompu d’espaces blancs jusqu’à ce que la génération atteigne la limite de tokens, ce qui entraîne une demande de longue durée et apparemment « bloquée ». Notez également que le contenu du message peut être partiellement coupé si finish_reason="length", ce qui indique que la génération a max_tokens dépassé ou que la conversation a dépassé la longueur maximale du contexte.	Non
stream	booléen	Si true, renvoie un flux d’événements qui se produisent pendant la Run comme événements envoyés par le serveur, se terminant lorsque la Run entre dans un état terminal avec un data: [DONE] message.	Non
stream_options	chatCompletionStreamOptions	Options pour la réponse en streaming. Ne réglez cela que lorsque vous activez stream: true.	Non	None
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe.	Non	1
fil	createThreadRequest		Non
tool_choice	assistantsApiToolChoiceOption	Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera un message. auto est la valeur par défaut et signifie que le modèle peut choisir entre générer un message ou appeler un outil. Spécifier un outil particulier comme {"type": "file_search"} ou {"type": "function", "function": {"name": "my_function"}} force le modèle à appeler cet outil.	Non
tool_resources	Objet	Un ensemble de ressources utilisées par les outils de l’assistant. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	L’identifiant du magasin vectoriel attaché à cet assistant. Il peut y avoir un maximum de 1 mémoire vectorielle attachée à l’assistant.	Non
Outils	tableau	Écartez les outils que l’assistant peut utiliser pour cette course. Cela est utile pour modifier le comportement par exécution.	Non
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela ou la température, mais pas les deux.	Non	1
truncation_strategy	truncationObject	Contrôles sur la façon dont un thread sera tronqué avant la sortie. Utilisez cela pour contrôler la fenêtre de contexte initiale de la partie.	Non

threadObject

Représente un fil qui contient des messages.

Nom	Catégorie	Description	Obligatoire	Par défaut
date_de_création	entier	L’horodatage Unix (en quelques secondes) indique la création du thread.	Oui
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Oui
Objet	string	Le type d’objet, qui est toujours thread.	Oui
tool_resources	Objet	Un ensemble de ressources mises à disposition des outils de l’assistant dans ce fil. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Oui
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le magasin vectoriel attaché à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non

objet Enum : ThreadObjectType

Valeur	Description
fil	Le type d’objet thread qui est toujours thread

createThreadRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
messages	tableau	Une liste de messages pour commencer le fil.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
tool_resources	Objet	Un ensemble de ressources mises à disposition des outils de l’assistant dans ce fil. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le magasin vectoriel attaché à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non
└ vector_stores	tableau	Un assistant pour créer un stockage vectoriel avec file_ids et l’attacher à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non

modifyThreadRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
tool_resources	Objet	Un ensemble de ressources mises à disposition des outils de l’assistant dans ce fil. Les ressources sont spécifiques au type d’outil. Par exemple, l’outil code_interpreter nécessite une liste d’identifiants de fichiers, tandis qu’il file_search nécessite une liste d’identifiants de stockage vectoriel.	Non
└─ interpréteur_de_code	Objet		Non
file_ids	tableau	Une liste des identifiants de fichiers mis à disposition de l’outil code_interpreter . Il peut y avoir un maximum de 20 fichiers associés à l’outil.	Non	[]
└recherche_fichier	Objet		Non
└vector_store_ids	tableau	Le magasin vectoriel attaché à ce fil. Il peut y avoir un maximum d’un stockage vectoriel attaché au fil.	Non

deleteThreadResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
supprimé	booléen		Oui
ID	string		Oui
Objet	string		Oui

objet Enum : DeleteThreadResponseObjectState

Valeur	Description
thread.deleted	L’état de l’objet réponse du fil supprimé, qui est thread.deleted

listThreadsResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

messageObject

Représente un message au sein d’un thread.

Nom	Catégorie	Description	Obligatoire	Par défaut
assistant_id	string	Le cas échéant, l’identifiant de l’assistant qui a rédigé ce message.	Oui
attachments	tableau	Une liste des fichiers attachés au message, et des outils auxquels ils ont été ajoutés.	Oui
terminé_à	entier	L’horodatage Unix (en secondes) indique la date de complétion du message.	Oui
contenu	tableau	Le contenu du message sous forme de texte et/ou d’images.	Oui
date_de_création	entier	L’horodatage Unix (en secondes) indique la création du message.	Oui
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
incomplete_at	entier	L’horodatage Unix (en secondes) indique quand le message était marqué comme incomplet.	Oui
incomplete_details	Objet	Sur un message incomplet, des détails expliquant pourquoi le message est incomplet.	Oui
└─ raison	string	La raison pour laquelle le message est incomplet.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Oui
Objet	string	Le type d’objet, qui est toujours thread.message.	Oui
role	string	L’entité qui a produit le message. L’un des user ou assistant.	Oui
run_id	string	Le cas échéant, l’ID de la run associée à l’auteur de ce message.	Oui
statut	string	Le statut du message, qui peut être soit in_progress, incomplete, soit completed.	Oui
thread_id	string	L’identifiant du thread auquel ce message appartient.	Oui

objet Enum : MessageObjectType

Valeur	Description
thread.message	Le type d’objet message qui est thread.message

status Enum : MessageObjectStatus

Valeur	Description
in_progress
incomplete
Terminé

rôle Enum : MessageObjectRole

Valeur	Description
utilisateur
assistant

messageDeltaObject

Représente un delta de message, c’est-à-dire tout champ modifié sur un message pendant le streaming.

Nom	Catégorie	Description	Obligatoire	Par défaut
delta	Objet	Le delta contenant les champs qui ont changé sur le Message.	Oui
└─ Contenu	tableau	Le contenu du message sous forme de texte et/ou d’images.	Non
└─ Rôle	string	L’entité qui a produit le message. L’un des user ou assistant.	Non
ID	string	L’identifiant du message, qui peut être référencé dans les points de terminaison de l’API.	Oui
Objet	string	Le type d’objet, qui est toujours thread.message.delta.	Oui

objet Enum : MessageDeltaObjectType

Valeur	Description
thread.message.delta

createMessageRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
attachments	tableau	Une liste des fichiers attachés au message, et les outils auxquels ils doivent être ajoutés.	Non
contenu	string	Le contenu du message.	Oui
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
role	string	Le rôle de l’entité qui crée le message. Les valeurs autorisées incluent : - user: Indique que le message est envoyé par un utilisateur réel et doit être utilisé dans la plupart des cas pour représenter des messages générés par l’utilisateur. - assistant: Indique que le message est généré par l’assistant. Utilisez cette valeur pour insérer des messages de l’assistant dans la conversation.	Oui

rôle Enum : CreateMessageRequestRole

Valeur	Description
utilisateur
assistant

modifyMessageRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non

deleteMessageResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
supprimé	booléen		Oui
ID	string		Oui
Objet	string		Oui

objet Enum : DeleteMessageResponseObject

Valeur	Description
thread.message.deleted	L’état de l’objet de réponse au message supprimé

listMessagesResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

messageContentImageFileObject

Fait référence à un fichier image dans le contenu d’un message.

Nom	Catégorie	Description	Obligatoire	Par défaut
image_file	Objet		Oui
└ file_id	string	L’ID du fichier de l’image dans le contenu du message.	Non
type	string	Toujours image_file.	Oui

type Enum : MessageContentImageFileObjectType

Valeur	Description
image_file	Le type de fichier image de contenu du message

messageContentTextObject

Le contenu textuel qui fait partie d’un message.

Nom	Catégorie	Description	Obligatoire	Par défaut
texte	Objet		Oui
└─ Annotations	tableau		Non
└─ valeur	string	Les données qui composent le texte.	Non
type	string	Toujours text.	Oui

type Enum : messageContenttextObjectType

Valeur	Description
texte	Le contenu du message texte Type d’objet

messageContentTextAnnotationsFileCitationObject

Une citation dans le message qui pointe vers une citation spécifique d’un fichier spécifique associé à l’assistant ou au message. Généré lorsque l’assistant utilise l’outil de « récupération » pour rechercher des fichiers.

Nom	Catégorie	Description	Obligatoire	Par défaut
end_index	entier		Oui
file_citation	Objet		Oui
└ file_id	string	L’identifiant du fichier spécifique dont provient la citation.	Non
start_index	entier		Oui
texte	string	Le texte dans le contenu du message qui doit être remplacé.	Oui
type	string	Toujours file_citation.	Oui

type Enum : FileCitationObjectType

Valeur	Description
file_citation	Le type d’objet de citation du fichier

messageContentTextAnnotationsFilePathObject

Une URL pour le fichier généré lorsque l’assistant a utilisé l’outil code_interpreter pour générer un fichier.

Nom	Catégorie	Description	Obligatoire	Par défaut
end_index	entier		Oui
file_path	Objet		Oui
└ file_id	string	L’identifiant du fichier qui a été généré.	Non
start_index	entier		Oui
texte	string	Le texte dans le contenu du message qui doit être remplacé.	Oui
type	string	Toujours file_path.	Oui

type Enum : FilePathObjectType

Valeur	Description
file_path	Le type d’objet chemin de fichier

messageDeltaContentImageFileObject

Fait référence à un fichier image dans le contenu d’un message.

Nom	Catégorie	Description	Obligatoire	Par défaut
image_file	Objet		Non
└ file_id	string	L’ID du fichier de l’image dans le contenu du message.	Non
index	entier	L’index du contenu dans le message.	Oui
type	string	Toujours image_file.	Oui

type Enum : MessageDeltaContentImageFileObjectType

Valeur	Description
image_file

messageDeltaContentTextObject

Le contenu textuel qui fait partie d’un message.

Nom	Catégorie	Description	Obligatoire	Par défaut
index	entier	L’index du contenu dans le message.	Oui
texte	Objet		Non
└─ Annotations	tableau		Non
└─ valeur	string	Les données qui composent le texte.	Non
type	string	Toujours text.	Oui

type Enum : MessageDeltaContentTextObjectType

Valeur	Description
texte

messageDeltaContentTextAnnotationsFileCitationObject

Une citation dans le message qui pointe vers une citation spécifique d’un fichier spécifique associé à l’assistant ou au message. Généré lorsque l’assistant utilise l’outil « file_search » pour rechercher dans les fichiers.

Nom	Catégorie	Description	Obligatoire	Par défaut
end_index	entier		Non
file_citation	Objet		Non
└ file_id	string	L’identifiant du fichier spécifique dont provient la citation.	Non
└─ citation	string	La citation spécifique dans le dossier.	Non
index	entier	L’index de l’annotation dans la partie contenu textuel.	Oui
start_index	entier		Non
texte	string	Le texte dans le contenu du message qui doit être remplacé.	Non
type	string	Toujours file_citation.	Oui

type Enum : MessageDeltaContenuTexteAnnotationsFichierCitationObjectType

Valeur	Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

Une URL pour le fichier généré lorsque l’assistant a utilisé l’outil code_interpreter pour générer un fichier.

Nom	Catégorie	Description	Obligatoire	Par défaut
end_index	entier		Non
file_path	Objet		Non
└ file_id	string	L’identifiant du fichier qui a été généré.	Non
index	entier	L’index de l’annotation dans la partie contenu textuel.	Oui
start_index	entier		Non
texte	string	Le texte dans le contenu du message qui doit être remplacé.	Non
type	string	Toujours file_path.	Oui

type Enum : MessageDeltaContenuTexteAnnotationsFilePathObjectType

Valeur	Description
file_path

runStepObject

Représente une étape dans l’exécution d’une partie.

Nom	Catégorie	Description	Obligatoire	Par défaut
assistant_id	string	L’identifiant de l’assistant associé au pas de course.	Oui
cancelled_at	entier	L’horodatage Unix (en quelques secondes) indique quand l’étape de run a été annulée.	Oui
terminé_à	entier	L’horodatage Unix (en secondes) indique la fin de l’étape d’exécution.	Oui
date_de_création	entier	L’horodatage Unix (en secondes) indique la création de l’étape d’exécution.	Oui
expired_at	entier	L’horodatage Unix (en secondes) indique quand l’étape d’exécution a expiré. Une étape est considérée comme expirée si la série mère est expirée.	Oui
failed_at	entier	L’horodatage Unix (en quelques secondes) indique quand l’étape d’exécution échoue.	Oui
ID	string	L’identifiant de l’étape d’exécution, qui peut être référencé dans les points de terminaison API.	Oui
dernière_erreur	Objet	La dernière erreur associée à cette étape de course. Ça le null sera s’il n’y a pas d’erreurs.	Oui
└─ Code	string	L’un des server_error ou rate_limit_exceeded.	Non
└─ Message	string	Une description lisible par l’homme de l’erreur.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Oui
Objet	string	Le type d’objet, qui est toujours assistant.run.step.	Oui
run_id	string	L’identifiant de la course à laquelle cette étape de course fait partie.	Oui
statut	string	Le statut de la séquence, qui peut être soit in_progress, cancelled, failed, completed, ou expired.	Oui
step_details	runStepDetailsMessageCreationObject ou runStepDetailsToolCallsObject	Les détails de la course à pied.	Oui
thread_id	string	L’identifiant des threads qui ont été exécutés.	Oui
type	string	Le type de pas de course, qui peut être soit message_creation soit tool_calls.	Oui

objet Enum : RunStepObjectType

Valeur	Description
assistant.run.step	Le type d’objet, qui est toujours assistant.run.step

type Enum : RunStepObjectType

Valeur	Description
message_creation	L’étape message_creation course
tool_calls	L’étape tool_calls course

statut Enum : RunStepObjectStatus

Valeur	Description
in_progress	Le statut de la in_progress
cancelled	Le statut de la série annulée
a échoué	Le statut de la série annulée
Terminé	Le statut de la série annulée
Expiré	Le statut de la série annulée

runStepDeltaObject

Représente un delta de run step, c’est-à-dire tous les champs modifiés lors d’un run step pendant le streaming.

Nom	Catégorie	Description	Obligatoire	Par défaut
delta	Objet	Le delta contenant les champs qui ont changé lors de la phase de course.	Oui
└─ détails_étape	runStepDeltaStepDetailsMessageCreationObject ou runStepDeltaStepToolsToolCallsObject	Les détails de la course à pied.	Non
ID	string	L’identifiant de l’étape d’exécution, qui peut être référencé dans les points de terminaison API.	Oui
Objet	string	Le type d’objet, qui est toujours thread.run.step.delta.	Oui

objet Enum : RunStepDeltaObjectType

Valeur	Description
thread.run.step.delta

listRunStepsResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

runStepDetailsMessageCreationObject

Détails de la création du message par étape de course.

Nom	Catégorie	Description	Obligatoire	Par défaut
message_creation	Objet		Oui
└ message_id	string	L’ID du message créé par cette étape d’exécution.	Non
type	string	Toujours message_creation.	Oui

type Enum : RunStepDetailsMessageCreationObjectType

Valeur	Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

Détails de la création du message par étape de course.

Nom	Catégorie	Description	Obligatoire	Par défaut
message_creation	Objet		Non
└ message_id	string	L’ID du message créé par cette étape d’exécution.	Non
type	string	Toujours message_creation.	Oui

type Enum : RunStepDeltaStepsMessagesCreationObjectType

Valeur	Description
message_creation

runStepDetailsToolCallsObject

Détails de l’appel à outils.

Nom	Catégorie	Description	Obligatoire	Par défaut
tool_calls	tableau	Une série d’appels d’outils dans lesquels l’étape d’exécution était impliquée. Celles-ci peuvent être associées à l’un des trois types d’outils : code_interpreter, retrieval ou function.	Oui
type	string	Toujours tool_calls.	Oui

type Enum : RunStepDetailsToolCallsObjectType

Valeur	Description
tool_calls

runStepDeltaStepDetailsToolCallsObject

Détails de l’appel à outils.

Nom	Catégorie	Description	Obligatoire	Par défaut
tool_calls	tableau	Une série d’appels d’outils dans lesquels l’étape d’exécution était impliquée. Celles-ci peuvent être associées à l’un des trois types d’outils : code_interpreter, file_search ou function.	Non
type	string	Toujours tool_calls.	Oui

type Enum : RunStepDeltaStepsToolCallsObjectType

Valeur	Description
tool_calls

runStepDetailsToolCallsCodeObject

Les détails de l’outil d’interprétation de code appelaient l’étape d’exécution dans laquelle était impliqué.

Nom	Catégorie	Description	Obligatoire	Par défaut
code_interpreter	Objet	Définition de l’appel de l’outil d’interpréteur de code.	Oui
└─ Entrée	string	L’entrée de l’outil Code Interpreter appelle.	Non
└─ sorties	tableau	Les sorties de l’outil d’interprétation de code appellent. L’interprète de code peut produire un ou plusieurs éléments, y compris du texte (logs) ou des images (image). Chacun de ces éléments est représenté par un type d’objet différent.	Non
ID	string	L’identifiant de l’appel à outils.	Oui
type	string	Le type d’appel à outils. C’est toujours code_interpreter pour ce type d’appel d’outils.	Oui

type Enum : RunStepDetailsToolCallsCodeObjectType

Valeur	Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Les détails de l’outil d’interprétation de code appelaient l’étape d’exécution dans laquelle était impliqué.

Nom	Catégorie	Description	Obligatoire	Par défaut
code_interpreter	Objet	Définition de l’appel de l’outil d’interpréteur de code.	Non
└─ Entrée	string	L’entrée de l’outil Code Interpreter appelle.	Non
└─ sorties	tableau	Les sorties de l’outil d’interprétation de code appellent. L’interprète de code peut produire un ou plusieurs éléments, y compris du texte (logs) ou des images (image). Chacun de ces éléments est représenté par un type d’objet différent.	Non
ID	string	L’identifiant de l’appel à outils.	Non
index	entier	L’index de l’appel d’outil dans le tableau d’appels d’outils.	Oui
type	string	Le type d’appel à outils. C’est toujours code_interpreter pour ce type d’appel d’outils.	Oui

type Enum : RunStepDeltaStepsToolCallsCodeObjectType

Valeur	Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

La sortie texte de l’outil Code Interpreter est appelée dans le cadre d’une étape de course.

Nom	Catégorie	Description	Obligatoire	Par défaut
logs	string	La sortie texte de l’outil Code Interpreter appelle.	Oui
type	string	Toujours logs.	Oui

type Enum : RunStepDetailsToolCallsCodeOutputLogsObjectType

Valeur	Description
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

La sortie texte de l’outil Code Interpreter est appelée dans le cadre d’une étape de course.

Nom	Catégorie	Description	Obligatoire	Par défaut
index	entier	L’indice de la sortie dans le tableau de sorties.	Oui
logs	string	La sortie texte de l’outil Code Interpreter appelle.	Non
type	string	Toujours logs.	Oui

type Enum : RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Valeur	Description
logs

runStepDetailsToolCallsCodeOutputImageObject

Nom	Catégorie	Description	Obligatoire	Par défaut
image	Objet		Oui
└ file_id	string	L’identifiant du fichier de l’image.	Non
type	string	Toujours image.	Oui

type Enum : RunStepDetailsToolCallsCodeOutputImageObjectType

Valeur	Description
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Nom	Catégorie	Description	Obligatoire	Par défaut
image	Objet		Non
└ file_id	string	L’identifiant du fichier de l’image.	Non
index	entier	L’indice de la sortie dans le tableau de sorties.	Oui
type	string	Toujours image.	Oui

type Enum : RunStepDeltaStepsToolCallsCodeOutputImageObject

Valeur	Description
image

runStepDetailsToolCallsFileSearchObject

Nom	Catégorie	Description	Obligatoire	Par défaut
file_search	Objet	Pour l’instant, ce sera toujours un objet vide.	Oui
─ résultats	tableau	Les résultats de la recherche de fichiers.	Non
ID	string	L’ID de l’objet d’appel de l’outil.	Oui
type	string	Le type d’appel à outils. C’est toujours file_search pour ce type d’appel d’outils.	Oui

type Enum : RunStepDetailsToolCallsFileSearchObjectType

Valeur	Description
file_search

runStepDetailsToolCallsFileSearchResultObject

Un résultat de la recherche de fichiers.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	tableau	Le contenu du résultat qui a été trouvé. Le contenu n’est inclus que si demandé via le paramètre de requête d’inclusion.	Non
identifiant_de_fichier	string	L’identifiant du fichier dans lequel le résultat a été trouvé.	Oui
nom_de_fichier	string	Le nom du fichier dans lequel le résultat a été trouvé.	Oui
Résultat	number	Le score du résultat. Toutes les valeurs doivent être un nombre à virgule flottante entre 0 et 1.	Oui

runStepDeltaStepDetailsToolCallsFileSearchObject

Nom	Catégorie	Description	Obligatoire	Par défaut
file_search	Objet	Pour l’instant, ce sera toujours un objet vide.	Oui
ID	string	L’ID de l’objet d’appel de l’outil.	Non
index	entier	L’index de l’appel d’outil dans le tableau d’appels d’outils.	Oui
type	string	Le type d’appel à outils. C’est toujours retrieval pour ce type d’appel d’outils.	Oui

type Enum : RunStepDeltaStepsToolCallsFileSearchObjectType

Valeur	Description
file_search

runStepDetailsToolCallsFunctionObject

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet	La définition de la fonction appelée.	Oui
└─ Arguments	string	Les arguments passaient à la fonction.	Non
└─ Nom	string	Le nom de la fonction.	Non
└─ Sortie	string	La sortie de la fonction. Cela se fera null si les résultats n’ont pas encore été soumis.	Non
ID	string	L’ID de l’objet d’appel de l’outil.	Oui
type	string	Le type d’appel à outils. C’est toujours function pour ce type d’appel d’outils.	Oui

type Enum : RunStepDetailsToolCallsFunctionObjectType

Valeur	Description
function

runStepDeltaStepDetailsToolCallsFunctionObject

Nom	Catégorie	Description	Obligatoire	Par défaut
function	Objet	La définition de la fonction appelée.	Non
└─ Arguments	string	Les arguments passaient à la fonction.	Non
└─ Nom	string	Le nom de la fonction.	Non
└─ Sortie	string	La sortie de la fonction. Cela se fera null si les résultats n’ont pas encore été soumis.	Non
ID	string	L’ID de l’objet d’appel de l’outil.	Non
index	entier	L’index de l’appel d’outil dans le tableau d’appels d’outils.	Oui
type	string	Le type d’appel à outils. C’est toujours function pour ce type d’appel d’outils.	Oui

type Enum : RunStepDetailsToolCallsFunctionObjectType

Valeur	Description
function

vectorStoreExpirationAfter

La politique d’expiration pour un magasin vectoriel.

Nom	Catégorie	Description	Obligatoire	Par défaut
ancre	string	Fixez l’heure de l’ancre après laquelle la politique d’expiration s’applique. Ancrages supportés : last_active_at.	Oui
Jours	entier	Le nombre de jours après la période d’ancrage pendant laquelle le stockage vectoriel expirera.	Oui

Enum ancre : VectorStoreExpirationAfterAnchor

Valeur	Description
date_dernière_activité	L’horodatage de l’ancre après lequel la politique d’expiration s’applique.

vectorStoreObject

Un stockage vectoriel est une collection de fichiers traités pouvant être utilisés par l’outil file_search .

Nom	Catégorie	Description	Obligatoire	Par défaut
date_de_création	entier	L’horodatage Unix (en secondes) indique la création du magasin vectoriel.	Oui
expire_après	vectorStoreExpirationAfter	La politique d’expiration pour un magasin vectoriel.	Non
expires_at	entier	L’horodatage Unix (en quelques secondes) pour indiquer quand le magasin vectoriel expirera.	Non
nombre_de_fichiers	Objet		Oui
└' annulé	entier	Le nombre de fichiers qui ont été annulés.	Non
└' terminé	entier	Le nombre de fichiers qui ont été traités avec succès.	Non
Échec	entier	Le nombre de fichiers qui n’ont pas été traités.	Non
└ en_cours	entier	Le nombre de fichiers actuellement en cours de traitement.	Non
└─ Total	entier	Le nombre total de fichiers.	Non
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
date_dernière_activité	entier	L’horodatage Unix (en secondes) indique la dernière fois que le magasin vectoriel était actif.	Oui
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Oui
name	string	Le nom du magasin vectoriel.	Oui
Objet	enum	Le type d’objet, qui est toujours vector_store. Valeurs possibles : vector_store	Oui
statut	string	L’état du stockage vectoriel, qui peut être expiredsoit , in_progress, soit completed. Un statut de completed indique que le stockage vectoriel est prêt à être utilisé.	Oui
usage_bytes	entier	Le nombre total d’octets utilisés par les fichiers dans la mémoire vectorielle.	Oui

status Enum : VectorStoreObjectStatus

Valeur	Description
Expiré
in_progress
Terminé

createVectorStoreRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	autoChunkingStrategyRequestParam ou staticChunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie. Applicable seulement si file_ids elle est non vide.	Non
expire_après	vectorStoreExpirationAfter	La politique d’expiration pour un magasin vectoriel.	Non
identifiants_de_fichiers	tableau	Une liste des identifiants de fichiers que le stockage vectoriel devrait utiliser. Utile pour ce file_search genre d’outils qui peuvent accéder aux fichiers.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
name	string	Le nom du magasin vectoriel.	Non

updateVectorStoreRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
expire_après	vectorStoreExpirationAfter	La politique d’expiration pour un magasin vectoriel.	Non
metadata	Objet	Ensemble de 16 paires clé-valeur pouvant être attachées à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré. Les clés peuvent atteindre jusqu’à 64 caractères et les valeurs peuvent atteindre un maximum de 512 caractères.	Non
name	string	Le nom du magasin vectoriel.	Non

listVectorStoresResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

deleteVectorStoreResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
supprimé	booléen		Oui
ID	string		Oui
Objet	string		Oui

objet Enum : DeleteVectorStoreResponseObject

Valeur	Description
vector_store.deleted	L’état de l’objet de réponse du mémoire vectoriel supprimer

vectorStoreFileObject

Une liste de fichiers attachés à un magasin vectoriel.

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	autoChunkingStrategyRequestParam ou staticChunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie. Applicable seulement si file_ids elle est non vide.	Non
date_de_création	entier	L’horodatage Unix (en secondes) pour la création du fichier de stockage vectoriel.	Oui
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
dernière_erreur	Objet	La dernière erreur associée à ce fichier de stockage vectoriel. Ça le null sera s’il n’y a pas d’erreurs.	Oui
└─ Code	string	Un de server_error ou invalid_file ou unsupported_file.	Non
└─ Message	string	Une description lisible par l’homme de l’erreur.	Non
Objet	string	Le type d’objet, qui est toujours vector_store.file.	Oui
statut	string	Le statut du fichier de stockage vectoriel, qui peut être soit in_progress, completed, cancelled, ou failed. Le statut completed indique que le fichier de stockage vectoriel est prêt à être utilisé.	Oui
usage_bytes	entier	L’utilisation totale de stockage vectoriel en octets. Notez que cela peut différer de la taille originale du fichier.	Oui
vector_store_id	string	L’identifiant du magasin vectoriel auquel le fichier est attaché.	Oui

objet Enum : VectorStoreFileObjectType

Valeur	Description
vector_store.file

status Enum : VectorStoreFileObjectStatus

Valeur	Description
in_progress
Terminé
cancelled
a échoué

otherChunkingStrategyResponseParam

Cette méthode est renvoyée lorsque la stratégie de chunking est inconnue. En général, cela s’explique par le fait que le fichier était indexé avant que le chunking_strategy concept ne soit introduit dans l’API.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	string	Toujours other.	Oui

type Enum : AutreChunkingStrategyResponseParamType

Valeur	Description
other

staticChunkingStrategyResponseParam

Nom	Catégorie	Description	Obligatoire	Par défaut
statique	staticChunkingStrategy		Oui
type	string	Toujours static.	Oui

type Enum : StaticChunkingStrategyResponseParamType

Valeur	Description
statique

staticChunkingStrategy

Nom	Catégorie	Description	Obligatoire	Par défaut
chunk_overlap_tokens	entier	Le nombre de jetons qui se chevauchent entre les chunks. La valeur par défaut est 400. Notez que le chevauchement ne doit pas dépasser la moitié de max_chunk_size_tokens.	Oui
max_chunk_size_tokens	entier	Le nombre maximal de jetons dans chaque bloc. La valeur par défaut est 800. La valeur minimale est 100 et la valeur maximale est 4096.	Oui

autoChunkingStrategyRequestParam

La stratégie par défaut. Cette stratégie utilise actuellement un max_chunk_size_tokens de 800 et chunk_overlap_tokens de 400.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Toujours auto. Valeurs possibles : auto	Oui

staticChunkingStrategyRequestParam

Nom	Catégorie	Description	Obligatoire	Par défaut
statique	staticChunkingStrategy		Oui
type	enum	Toujours static. Valeurs possibles : static	Oui

chunkingStrategyRequestParam

La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie.

Ce composant peut être l’un des suivants :

• autoChunkingStrategyRequestParam
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	chunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie.	Non
identifiant_de_fichier	string	Un identifiant de fichier que le stockage vectoriel devrait utiliser. Utile pour ce file_search genre d’outils qui peuvent accéder aux fichiers.	Oui

listVectorStoreFilesResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau		Oui
premier_identifiant	string		Oui
has_more	booléen		Oui
last_id	string		Oui
Objet	string		Oui

deleteVectorStoreFileResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
supprimé	booléen		Oui
ID	string		Oui
Objet	string		Oui

objet Enum : DeleteVectorStoreFileResponseObject

Valeur	Description
vector_store.file.deleted

vectorStoreFileBatchObject

Un lot de fichiers attachés à un stockage vectoriel.

Nom	Catégorie	Description	Obligatoire	Par défaut
date_de_création	entier	L’horodatage Unix (en secondes) pour la création en lots des fichiers de stockage vectoriel.	Oui
nombre_de_fichiers	Objet		Oui
└' annulé	entier	Le nombre de fichiers qui ont été annulés.	Non
└' terminé	entier	Le nombre de fichiers traités.	Non
Échec	entier	Le nombre de fichiers qui n’ont pas été traités.	Non
└ en_cours	entier	Le nombre de fichiers actuellement en cours de traitement.	Non
└─ Total	entier	Le nombre total de fichiers.	Non
ID	string	L’identifiant, qui peut être référencé dans les points de terminaison de l’API.	Oui
Objet	string	Le type d’objet, qui est toujours vector_store.file_batch.	Oui
statut	string	Le statut des fichiers de stockage vectoriel par lots, qui peut être in_progresssoit , completed, cancelled soit failed.	Oui
vector_store_id	string	L’identifiant du magasin vectoriel auquel le fichier est attaché.	Oui

objet Enum : VectorStoreFileBatchObjectType

Valeur	Description
vector_store.files_batch

Status Enum : VectorStoreFileBatchObjectStatus

Valeur	Description
in_progress
Terminé
cancelled
a échoué

createVectorStoreFileBatchRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
chunking_strategy	chunkingStrategyRequestParam	La stratégie de fragmentation utilisée pour fragmenter le(s) fichier(s). Si ce n’est pas fixé, j’utiliserai la auto stratégie.	Non
identifiants_de_fichiers	tableau	Une liste des identifiants de fichiers que le magasin vectoriel devrait utiliser. Utile pour ce file_search genre d’outils qui peuvent accéder aux fichiers.	Oui

assistantStreamEvent

Représente un événement émis lors du streaming d’une Run.

Chaque événement dans un flux d’événements envoyé par le serveur possède une event propriété et data :

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Nous émettons des événements chaque fois qu’un nouvel objet est créé, transite vers un nouvel état ou est diffusé en parties (deltas). Par exemple, nous émettons thread.run.created quand une nouvelle exécution est créée, thread.run.completed quand une exécution est terminée, et ainsi de suite. Lorsqu’un Assistant choisit de créer un message pendant une course, nous émettons un thread.message.created event, un thread.message.in_progress événement, de nombreux thread.message.delta événements, et enfin un thread.message.completed événement.

Nous pourrions ajouter d’autres événements au fil du temps, donc nous recommandons de gérer les événements inconnus avec grâce dans votre code.

Ce composant peut être l’un des suivants :

• threadStreamEvent
• runStreamEvent
• runStepStreamEvent
• messageStreamEvent
• errorEvent
• doneEvent

threadStreamEvent

Ce composant peut être l’un des suivants :

thread.created

Ça se produit lorsqu’un nouveau thread est créé.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	threadObject	Représente un fil qui contient des messages.	Oui
événement	string		Oui

Données : threadObject

Event Enum : ThreadStreamEventEnum

Valeur	Description
thread.created	L’événement créé par le thread

---

runStreamEvent

Ce composant peut être l’un des suivants :

thread.run.created

Ça se produit lorsqu’une nouvelle partie est créée.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Event Enum : RunStreamEventCreated

Valeur	Description
thread.run.created

---

thread.run.queued

Se produit lorsqu’une série passe à un queued statut.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Event Enum : RunStreamEventQueued

Valeur	Description
thread.run.queued

---

thread.run.in_progress

Ça se produit lorsqu’une série passe à un in_progress statut.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Événement Enum : RunStreamEventInProgress

Valeur	Description
thread.run.in_progress

---

thread.run.requires_action

Se produit lorsqu’une série passe à un requires_action statut.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Event Enum : RunStreamEventRequiresAction

Valeur	Description
thread.run.requires_action

---

thread.run.completed

Se produit lorsqu’une partie est terminée.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Événement Enum : RunStreamEventTerminé

Valeur	Description
thread.run.completed

---

thread.run.failed

Elle se produit lorsqu’une course échoue.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Événement Enum : RunStreamEventFailed

Valeur	Description
thread.run.failed

---

thread.run.cancelling

Se produit lorsqu’une série passe à un cancelling statut.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Événement Enum : RunStreamEventCancelling

Valeur	Description
thread.run.cancelling

---

thread.run.cancelled

Se produit lorsqu’une partie est annulée.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Événement Enum : RunStreamEventAnnulled

Valeur	Description
thread.run.cancelled

---

thread.run.expired

Elle se produit lorsqu’une course expire.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runObject	Représente une exécution sur un thread.	Oui
événement	string		Oui

Données : runObject

Événement Enum : RunStreamEventExpired

Valeur	Description
thread.run.expired

---

runStepStreamEvent

Ce composant peut être l’un des suivants :

thread.run.step.created

Elle se produit lors de la création d’un pas de course.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepObject	Représente une étape dans l’exécution d’une partie.	Oui
événement	string		Oui

Données : runStepObject

Événement Enum : RunStepStreamEventCreated

Valeur	Description
thread.run.step.created

---

thread.run.step.in_progress

Se produit lorsqu’un pas de course passe à un in_progress état.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepObject	Représente une étape dans l’exécution d’une partie.	Oui
événement	string		Oui

Données : runStepObject

Événement Enum : RunStepStreamEventInProgress

Valeur	Description
thread.run.step.in_progress

---

thread.run.step.delta

Elle se produit lorsque des parties d’un pas de course sont en streaming.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepDeltaObject	Représente un delta de run step, c’est-à-dire tous les champs modifiés lors d’un run step pendant le streaming.	Oui
événement	string		Oui

Données : runStepDeltaObject

Événement Enum : RunStepStreamEventDelta

Valeur	Description
thread.run.step.delta

---

thread.run.step.completed

Ça se produit lorsqu’une étape de course est complétée.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepObject	Représente une étape dans l’exécution d’une partie.	Oui
événement	string		Oui

Données : runStepObject

Événement Enum : RunStepStreamEventTerminé

Valeur	Description
thread.run.step.completed

---

thread.run.step.failed

Ça se produit lorsqu’un pas de course échoue.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepObject	Représente une étape dans l’exécution d’une partie.	Oui
événement	string		Oui

Données : runStepObject

Événement Enum : RunStepStreamEventFailed

Valeur	Description
thread.run.step.failed

---

thread.run.step.cancelled

Se produit lorsqu’un pas de course est annulé.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepObject	Représente une étape dans l’exécution d’une partie.	Oui
événement	string		Oui

Données : runStepObject

Événement Enum : RunStepStreamEventAnnulled

Valeur	Description
thread.run.step.cancelled

---

thread.run.step.expired

Elle se produit lorsqu’un pas de course expire.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	runStepObject	Représente une étape dans l’exécution d’une partie.	Oui
événement	string		Oui

Données : runStepObject

Événement Enum : RunStepStreamEventExpired

Valeur	Description
thread.run.step.expired

---

messageStreamEvent

Ce composant peut être l’un des suivants :

thread.message.created

Apparaît lors de la création d’un message.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	messageObject	Représente un message au sein d’un thread.	Oui
événement	string		Oui

Données : messageObject

Événement Enum : MessageStreamEventCreated

Valeur	Description
thread.message.created

---

thread.message.in_progress

Se produit lorsqu’un message passe à un in_progress état.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	messageObject	Représente un message au sein d’un thread.	Oui
événement	string		Oui

Données : messageObject

Événement Enum : MessageStreamEventInProgress

Valeur	Description
thread.message.in_progress

---

thread.message.delta

Cela se produit lorsque des parties d’un message sont diffusées.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	messageDeltaObject	Représente un delta de message, c’est-à-dire tout champ modifié sur un message pendant le streaming.	Oui
événement	string		Oui

Données : messageDeltaObject

Event Enum : MessageStreamEventDelta

Valeur	Description
thread.message.delta

---

thread.message.completed

Apparaît lorsqu’un message est complété.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	messageObject	Représente un message au sein d’un thread.	Oui
événement	string		Oui

Données : messageObject

Événement Enum : MessageStreamÉvénementTerminé

Valeur	Description
thread.message.completed

---

thread.message.incomplete

Apparaît lorsqu’un message se termine avant d’être terminé.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	messageObject	Représente un message au sein d’un thread.	Oui
événement	string		Oui

Données : messageObject

Événement Enum : MessageStreamEventIncomplete

Valeur	Description
thread.message.incomplete

---

Annotation

Ce composant peut être l’un des suivants :

• FileCitation
• UrlCitation
• FilePath

Cliquez sur

Un clic.

Nom	Catégorie	Description	Obligatoire	Par défaut
Bouton	enum	Indique quel bouton de souris a été pressé pendant le clic. L’un des left, right, wheel, back, ou forward. Valeurs possibles : left, right, wheel, back, forward	Oui
type	enum	Spécifie le type d’événement. Pour une action de clic, cette propriété est toujours fixée à click. Valeurs possibles : click	Oui
x	entier	La coordonnée x où le clic a eu lieu.	Oui
y	entier	La coordonnée y où le clic a eu lieu.	Oui

CodeInterpreterFileOutput

La sortie d’un outil d’interprétation de code est un fichier.

Nom	Catégorie	Description	Obligatoire	Par défaut
fichiers	tableau		Oui
type	enum	Le type de sortie du fichier de l’interpréteur de code. Toujours files. Valeurs possibles : files	Oui

CodeInterpreterTextOutput

La sortie d’un outil d’interprétation de code qui est du texte.

Nom	Catégorie	Description	Obligatoire	Par défaut
logs	string	Les journaux de l’outil d’interprétation de code s’appellent.	Oui
type	enum	Le type de l’interprétation de code de la sortie texte. Toujours logs. Valeurs possibles : logs	Oui

CodeInterpreterTool

Un outil qui fait tourner du code.

Nom	Catégorie	Description	Obligatoire	Par défaut
identifiants_de_fichiers	tableau	Les identifiants des fichiers sur lesquels exécuter le code.	Oui
type	enum	Le type de l’outil d’interprétation de code. Toujours code_interpreter. Valeurs possibles : code_interpreter	Oui

CodeInterpreterToolCall

Un appel à l’outil pour exécuter du code.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	string	Le code à exécuter.	Oui
ID	string	L’ID unique de l’outil d’interprétation de code l’appelle.	Oui
results	tableau	Les résultats de l’appel de l’outil d’interprétation de code.	Oui
statut	enum	L’état de l’outil d’interprétation de code est appelé. Valeurs possibles : in_progress, interpreting, completed	Oui
type	enum	Le type d’outil d’interprétation de code appelé Toujours code_interpreter_call. Valeurs possibles : code_interpreter_call	Oui

CodeInterpreterToolOutput

Ce composant peut être l’un des suivants :

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

ComparisonFilter

Un 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	Catégorie	Description	Obligatoire	Par défaut
clé	string	La clé est de comparer avec la valeur.	Oui
type	enum	Spécifie l’opérateur de comparaison : eq, ne, gt, gte, lt, lte. - eq: égal - ne: non égal - gt: plus grand que - gte: supérieur ou égal - lt: moins que - lte: inférieur ou égal Valeurs possibles : eq, ne, gt, gte, lt, lte	Oui
valeur	chaîne ou nombre ou booléen	La valeur à comparer avec la clé d’attributs ; prend en compte les types de chaînes, de nombre ou booléens.	Oui

CompoundFilter

Combinez plusieurs filtres en utilisant and ou or.

Nom	Catégorie	Description	Obligatoire	Par défaut
Filtres	tableau	Un ensemble de filtres à combiner. Les objets peuvent être ComparisonFilter ou CompoundFilter.	Oui
type	enum	Type d’opération : and ou or. Valeurs possibles : and, or	Oui

ComputerAction

Ce composant peut être l’un des suivants :

• Click
• DoubleClick
• Drag
• KeyPress
• Move
• Screenshot
• Scroll
• Type
• Attendre

ComputerScreenshotImage

Une capture d’écran informatique utilisée avec l’outil d’utilisation informatique.

Nom	Catégorie	Description	Obligatoire	Par défaut
identifiant_de_fichier	string	L’identifiant d’un fichier téléchargé contenant la capture d’écran.	Non
image_url	string	L’URL de l’image capture.	Non
type	enum	Spécifie le type d’événement. Pour une capture d’écran informatique, cette propriété est toujours définie à computer_screenshot. Valeurs possibles : computer_screenshot	Oui

ComputerTool

Un outil qui contrôle un ordinateur virtuel.

Nom	Catégorie	Description	Obligatoire	Par défaut
hauteur_affichage	number	La hauteur de l’écran de l’ordinateur.	Oui
largeur d'affichage	number	La largeur de l’écran de l’ordinateur.	Oui
environment	enum	Le type d’environnement informatique à contrôler. Valeurs possibles : mac, windows, ubuntu, browser	Oui
type	enum	Le type d’outil d’utilisation informatique. Toujours computer_use_preview. Valeurs possibles : computer-use-preview	Oui

ComputerToolCall

Un appel à un outil d’utilisation informatique.

Nom	Catégorie	Description	Obligatoire	Par défaut
action	ComputerAction		Oui
call_id	string	Un identifiant utilisé lors de la réponse à l’appel de l’outil avec une sortie.	Oui
ID	string	L’identifiant unique de l’appel informatique.	Oui
pending_safety_checks	tableau	Les contrôles de sécurité en attente pour l’appel informatique.	Oui
statut	enum	Le statut de l’objet. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Oui
type	enum	Le type d’appel informatique. Toujours computer_call. Valeurs possibles : computer_call	Oui

ComputerToolCallOutput

La sortie d’un appel d’outil informatique.

Nom	Catégorie	Description	Obligatoire	Par défaut
acknowledged_safety_checks	tableau	Les contrôles de sécurité rapportés par l’API qui ont été confirmés par le développeur.	Non
call_id	string	L’ID de l’appel de l’outil informatique qui a produit la sortie.	Oui
ID	string	L’ID de l’outil informatique appelle la sortie.	Non
sortie	ComputerScreenshotImage	Une capture d’écran informatique utilisée avec l’outil d’utilisation informatique.	Oui
statut	enum	L’état du message d’entrée. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments d’entrée sont retournés via API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type de sortie de l’appel de l’outil informatique. Toujours computer_call_output. Valeurs possibles : computer_call_output	Oui

ComputerToolCallOutputResource

Nom	Catégorie	Description	Obligatoire	Par défaut
acknowledged_safety_checks	tableau	Les contrôles de sécurité rapportés par l’API qui ont été confirmés par le développeur.	Non
call_id	string	L’ID de l’appel de l’outil informatique qui a produit la sortie.	Oui
ID	string	L’identifiant unique de la sortie de l’outil d’appel informatique.	Oui
sortie	ComputerScreenshotImage	Une capture d’écran informatique utilisée avec l’outil d’utilisation informatique.	Oui
statut	enum	L’état du message d’entrée. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments d’entrée sont retournés via API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type de sortie de l’appel de l’outil informatique. Toujours computer_call_output. Valeurs possibles : computer_call_output	Oui

ComputerToolCallSafetyCheck

Un contrôle de sécurité en attente pour l’appel informatique.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	string	Le type de contrôle de sécurité en attente.	Oui
ID	string	L’identification du contrôle de sécurité en cours.	Oui
message	string	Détails sur le contrôle de sécurité en cours.	Oui

Contenu

Contenus d’entrée et de sortie multimodaux.

Ce composant peut être l’un des suivants :

• InputContent
• OutputContent

Coordinate

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

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

CreateModelResponseProperties

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères.	Non
model	string	Modèle utilisé pour générer les réponses.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider OpenAI à surveiller et détecter les abus. .	Non

createResponse

Nom	Catégorie	Description	Obligatoire	Par défaut
Inclure	tableau	{"$ref » : « #/components/schemas/includable/description"}	Non
entrée	chaîne ou tableau	Texte, image ou fichier dans le modèle, utilisé pour générer une réponse.	Oui
consignes	string	Insère un message système (ou développeur) comme premier élément dans le contexte du modèle. Lorsqu’on utilise avec previous_response_id, les instructions d’une réponse précédente ne seront pas relayées vers la réponse suivante. Cela facilite le remplacement des messages système (ou développeur) par de nouvelles réponses.	Non
max_output_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une réponse, y compris les jetons de sortie visibles et les jetons de raisonnement.	Non
parallel_tool_calls	booléen	Permettre au modèle d’exécuter des appels d’outils en parallèle.	Non	True
previous_response_id	string	L’identifiant unique de la réponse précédente au modèle. Utilisez cela pour créer des conversations sur plusieurs tours.	Non
reasoning	Reasoning	Options de configuration pour les modèles de raisonnement.	Non
boutique	booléen	Savoir s’il faut stocker la réponse du modèle généré pour une récupération ultérieure via API.	Non	True
stream	booléen	Si elle est réglée sur true, les données de réponse du modèle seront diffusées au client au fur et à mesure de leur génération via des événements envoyés par le serveur.	Non	Faux
texte	Objet	Options de configuration pour une réponse texte du modèle. Cela 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	Non
└─ Format	TextResponseFormatConfiguration	Un objet spécifiant le format que le modèle doit produire. La configuration { "type": "json_schema" } permet de créer des sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. Le format par défaut est { "type": "text" } sans 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 préférée pour les modèles qui le supportent.	Non
tool_choice	OptionsDeDeChoix-de-Outils, TypesDeDeChoix-d’Outils, ou FonctionChoixDeChoix-deOutils	Comment le modèle doit choisir quel outil (ou outils) utiliser lors de la génération d’une réponse. Voir le tools paramètre pour voir comment spécifier quels outils le modèle peut appeler.	Non
Outils	tableau	Un ensemble d’outils que le modèle peut appeler lors de la génération d’une réponse. Vous pouvez spécifier quel outil utiliser en définissant le tool_choice paramètre. Les deux catégories d’outils que vous pouvez fournir au modèle sont : - Outils intégrés	Non
truncation	enum	La stratégie de troncature à utiliser pour la réponse du modèle. - auto: Si le contexte de cette réponse et des précédentes dépasse la taille de la fenêtre de contexte du modèle, le modèle tronquera le Réponse pour s’adapter à la fenêtre contextuelle en déposant des éléments d’entrée au milieu de la conversation. - disabled (par défaut) : Si une réponse de modèle dépasse la taille de la fenêtre de contexte pour un modèle, la requête échouera avec une erreur 400. Valeurs possibles : auto, disabled	Non

DoubleClick

Un double clic.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Spécifie le type d’événement. Pour une action de double clic, cette propriété est toujours fixée à double_click. Valeurs possibles : double_click	Oui
x	entier	La coordonnée x où le double-clic a eu lieu.	Oui
y	entier	La coordonnée y où le double-clic a eu lieu.	Oui

Faites glisser

Un mouvement de traînée.

Nom	Catégorie	Description	Obligatoire	Par défaut
path	tableau	Un tableau de coordonnées représentant le chemin de l’action de traînée. Les coordonnées apparaîtront sous forme d’un tableau d’objets, par exemple[{ x: 100, y: 200 }, { x: 200, y: 300 }]	Oui
type	enum	Spécifie le type d’événement. Pour une action de traînée, cette propriété est toujours fixée à drag. Valeurs possibles : drag	Oui

EasyInputMessage

Un message d’entrée dans le modèle avec un rôle indiquant l’instruction suivant la hiérarchie. Les instructions données avec le developer rôle ou system ont la priorité sur les instructions données avec le user rôle. Les messages avec ce assistant rôle sont supposés avoir été générés par le modèle lors d’interactions précédentes.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	chaîne ou InputMessageContentList	Texte d’entrée texte ou audio au modèle, utilisé pour générer une réponse. Peut aussi contenir les réponses des anciens assistants.	Oui
role	enum	Le rôle de l’entrée du message. L’un des user, assistant, system, ou developer. Valeurs possibles : user, assistant, system, developer	Oui
type	enum	Le type de message d’entrée. Toujours message. Valeurs possibles : message	Non

FileCitation

Une citation pour un dossier.

Nom	Catégorie	Description	Obligatoire	Par défaut
identifiant_de_fichier	string	L’ID du dossier.	Oui
index	entier	L’index du fichier dans la liste des fichiers.	Oui
type	enum	Le type de citation du dossier. Toujours file_citation. Valeurs possibles : file_citation	Oui

FilePath

Un chemin vers un fichier.

Nom	Catégorie	Description	Obligatoire	Par défaut
identifiant_de_fichier	string	L’ID du dossier.	Oui
index	entier	L’index du fichier dans la liste des fichiers.	Oui
type	enum	Le type de chemin du fichier. Toujours file_path. Valeurs possibles : file_path	Oui

FileSearchRanker

Le classeur à utiliser pour la recherche de fichiers. Si ce n’est pas spécifié, il utilisera le auto classeur.

Propriété	Valeur
Description	Le classeur à utiliser pour la recherche de fichiers. Si ce n’est pas spécifié, il utilisera le auto classeur.
Type	string
Valeurs	auto default_2024_08_21

FileSearchTool

Un outil qui recherche du contenu pertinent à partir de fichiers téléchargés.

Nom	Catégorie	Description	Obligatoire	Par défaut
Filtres	Filtre de comparaison ou filtre composé	Un filtre à appliquer basé sur les attributs du fichier.	Non
nombre_maximal_de_résultats	entier	Le nombre maximal de résultats à revendre. Ce nombre devrait être compris entre 1 et 50.	Non
options_de_classement	Objet	Options de classement pour la recherche.	Non
└─ classificateur	enum	Le classeur à utiliser pour la recherche de fichiers. Valeurs possibles : auto, default-2024-11-15	Non
└score_threshold	number	Le seuil de score pour la recherche de fichiers, un nombre compris entre 0 et 1. Les chiffres proches de 1 tenteront de ne fournir que les résultats les plus pertinents, mais peuvent en donner moins.	Non	0
type	enum	Le type de l’outil de recherche de fichiers. Toujours file_search. Valeurs possibles : file_search	Oui
vector_store_ids	tableau	Les identifiants du vecteur stockent pour la recherche.	Oui

FileSearchToolCall

Les résultats d’un appel à l’outil de recherche de fichiers.

Nom	Catégorie	Description	Obligatoire	Par défaut
ID	string	L’identifiant unique de l’outil de recherche de fichiers appelé.	Oui
Requêtes	tableau	Les requêtes servaient à rechercher des fichiers.	Oui
results	tableau	Les résultats de l’outil de recherche de fichiers sont appelés.	Non
statut	enum	Le statut de l’outil de recherche de fichiers est appelé. L’un de in_progress, searching, incomplete ou failed, Valeurs possibles : in_progress, searching, completed, incomplete, failed	Oui
type	enum	Le type d’appel de l’outil de recherche de fichiers. Toujours file_search_call. Valeurs possibles : file_search_call	Oui

FunctionTool

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

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	Une description de la fonction. Utilisé par le modèle pour déterminer s’il faut appeler ou non la fonction.	Non
name	string	Le nom de la fonction à appeler.	Oui
parameters	Objet	Un objet schéma JSON décrivant les paramètres de la fonction.	Oui
strict	booléen	S’il faut imposer une validation stricte des paramètres. Par défaut true.	Oui
type	enum	Le type de l’outil de fonction. Toujours function. Valeurs possibles : function	Oui

FunctionToolCall

Un appel à l’outil pour exécuter une fonction.

Nom	Catégorie	Description	Obligatoire	Par défaut
Arguments	string	Une chaîne JSON des arguments à transmettre à la fonction.	Oui
call_id	string	L’identifiant unique de l’appel de l’outil de fonction généré par le modèle.	Oui
ID	string	L’ID unique de l’outil de fonction appelé.	Oui
name	string	Le nom de la fonction à exécuter.	Oui
statut	enum	Le statut de l’objet. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type d’appel de l’outil de fonction. Toujours function_call. Valeurs possibles : function_call	Oui

FunctionToolCallOutput

La sortie d’un appel d’outil de fonction.

Nom	Catégorie	Description	Obligatoire	Par défaut
call_id	string	L’identifiant unique de l’appel de l’outil de fonction généré par le modèle.	Oui
ID	string	L’identifiant unique de l’outil de fonction sortie. Rempli lorsque cet élément est retourné via API.	Non
sortie	string	Une chaîne JSON de la sortie de l’appel de l’outil de fonction.	Oui
statut	enum	Le statut de l’objet. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type de sortie de l’outil de fonction appel. Toujours function_call_output. Valeurs possibles : function_call_output	Oui

FunctionToolCallOutputResource

Nom	Catégorie	Description	Obligatoire	Par défaut
call_id	string	L’identifiant unique de l’appel de l’outil de fonction généré par le modèle.	Oui
ID	string	L’ID unique de la sortie de l’outil d’appel de fonction.	Oui
sortie	string	Une chaîne JSON de la sortie de l’appel de l’outil de fonction.	Oui
statut	enum	Le statut de l’objet. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type de sortie de l’outil de fonction appel. Toujours function_call_output. Valeurs possibles : function_call_output	Oui

includable

Spécifier des données de sortie supplémentaires à inclure dans la réponse du modèle. Les valeurs actuellement prises en charge sont :

• file_search_call.results: Incluez les résultats de recherche de l’outil de recherche de fichiers appelé.
• message.input_image.image_url: Inclure les URL d’image du message d’entrée.
• computer_call_output.output.image_url: Inclure les URL d’image issues de la sortie de l’appel informatique.

Propriété	Valeur
Description	Spécifier des données de sortie supplémentaires à inclure dans la réponse du modèle. Les valeurs actuellement prises en charge sont : - file_search_call.results: Incluez les résultats de recherche de l’outil de recherche de fichiers appelé. - message.input_image.image_url: Inclure les URL d’image du message d’entrée. - computer_call_output.output.image_url: Inclure les URL d’image issues de la sortie de l’appel informatique.
Type	string
Valeurs	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Une entrée audio vers le modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	string	Données audio codées en base64.	Oui
format	enum	Le format des données audio. Les formats actuellement pris en charge sont mp3 et wav. Valeurs possibles : mp3, wav	Oui
type	enum	Le type de l’élément d’entrée. Toujours input_audio. Valeurs possibles : input_audio	Oui

InputContent

Ce composant peut être l’un des suivants :

• InputText
• InputImage
• InputFile

InputFile

Une entrée de fichier dans le modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
file_data	string	Le contenu du fichier à envoyer au modèle.	Non
identifiant_de_fichier	string	L’identifiant du fichier à envoyer au modèle.	Non
filename	string	Le nom du fichier à envoyer au modèle.	Non
type	enum	Le type de l’élément d’entrée. Toujours input_file. Valeurs possibles : input_file	Oui

InputImage

Une entrée image au modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
detail	enum	Le niveau de détail de l’image à envoyer au modèle. L’un des high, low, ou auto. Par défaut, .auto Valeurs possibles : high, low, auto	Oui
identifiant_de_fichier	string	L’identifiant du fichier à envoyer au modèle.	Non
image_url	string	L’URL de l’image à envoyer au modèle. Une URL entièrement qualifiée ou une image encodée base64 dans une URL de données.	Non
type	enum	Le type de l’élément d’entrée. Toujours input_image. Valeurs possibles : input_image	Oui

InputItem

Ce composant peut être l’un des suivants :

• EasyInputMessage
• élément
• ItemReference

Message d'entrée

Un message d’entrée dans le modèle avec un rôle indiquant l’instruction suivant la hiérarchie. Les instructions données avec le developer rôle ou system ont la priorité sur les instructions données avec le user rôle.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	InputMessageContentList	Une liste d’un ou plusieurs éléments d’entrée du modèle, contenant différents contenus types.	Oui
role	enum	Le rôle de l’entrée du message. L’un des user, system, ou developer. Valeurs possibles : user, system, developer	Oui
statut	enum	Le statut de l’article. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type de message d’entrée. Toujours réglé sur message. Valeurs possibles : message	Non

InputMessageContentList

Une liste d’un ou plusieurs éléments d’entrée du modèle, contenant différents types de contenu.

Aucune propriété définie pour ce composant.

InputMessageResource

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	InputMessageContentList	Une liste d’un ou plusieurs éléments d’entrée du modèle, contenant différents contenus types.	Oui
ID	string	L’identifiant unique de l’entrée du message.	Oui
role	enum	Le rôle de l’entrée du message. L’un des user, system, ou developer. Valeurs possibles : user, system, developer	Oui
statut	enum	Le statut de l’article. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type de message d’entrée. Toujours réglé sur message. Valeurs possibles : message	Non

InputText

Une entrée texte pour le modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
texte	string	Le texte d’entrée du modèle.	Oui
type	enum	Le type de l’élément d’entrée. Toujours input_text. Valeurs possibles : input_text	Oui

Élément

Élément de contenu utilisé pour générer une réponse.

Ce composant peut être l’un des suivants :

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• ReasoningItem

ItemReference

Un identifiant interne pour un objet à référencer.

Nom	Catégorie	Description	Obligatoire	Par défaut
ID	string	L’identifiant de l’objet à référencer.	Oui
type	enum	Le type d’objet à référencer. Toujours item_reference. Valeurs possibles : item_reference	Oui

ItemResource

Élément de contenu utilisé pour générer une réponse.

Ce composant peut être l’un des suivants :

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

KeyPress

Une collection de pressions de touche que le modèle souhaite effectuer.

Nom	Catégorie	Description	Obligatoire	Par défaut
clés	tableau	La combinaison de touches que le modèle demande à presser. Il s’agit d’un tableau de chaînes, chacune représentant une tonalité.	Oui
type	enum	Spécifie le type d’événement. Pour une action de pression sur une touche, cette propriété est toujours définie à keypress. Valeurs possibles : keypress	Oui

Métadonnées

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 pour interroger des objets via l’API ou le tableau de bord.

Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères.

Aucune propriété définie pour ce composant.

ModelResponseProperties

Nom	Catégorie	Description	Obligatoire	Par défaut
metadata	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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères.	Non
model	string	Modèle utilisé pour générer les réponses.	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Non	1
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Non	1
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider OpenAI à surveiller et détecter les abus. .	Non

Déplacer

Une action de mouvement de souris.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Spécifie le type d’événement. Pour une action de déplacement, cette propriété est toujours fixée à move. Valeurs possibles : move	Oui
x	entier	La coordonnée x à laquelle se déplacer.	Oui
y	entier	La coordonnée y à laquelle se déplacer.	Oui

OutputAudio

Une sortie audio du modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	string	Données audio encodées en Base64 provenant du modèle.	Oui
Transcription	string	La transcription des données audio du modèle.	Oui
type	enum	Le type de sortie audio. Toujours output_audio. Valeurs possibles : output_audio	Oui

OutputContent

Ce composant peut être l’un des suivants :

• OutputText
• Refusal

OutputItem

Nom	Catégorie	Description	Obligatoire	Par défaut
action	ComputerAction		Oui
Arguments	string	Une chaîne JSON des arguments à transmettre à la fonction.	Oui
call_id	string	Un identifiant utilisé lors de la réponse à l’appel de l’outil avec une sortie.	Oui
contenu	tableau	Contenu du texte de raisonnement.	Oui
ID	string	L’identifiant unique du contenu de raisonnement.	Oui
name	string	Le nom de la fonction à exécuter.	Oui
pending_safety_checks	tableau	Les contrôles de sécurité en attente pour l’appel informatique.	Oui
Requêtes	tableau	Les requêtes servaient à rechercher des fichiers.	Oui
results	tableau	Les résultats de l’outil de recherche de fichiers sont appelés.	Non
role	enum	Le rôle du message de sortie. Toujours assistant. Valeurs possibles : assistant	Oui
statut	enum	Le statut de l’objet. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Oui
type	enum	Le type d’objet. Toujours reasoning. Valeurs possibles : reasoning	Oui

OutputMessage

Un message de sortie du modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	tableau	Le contenu du message de sortie.	Oui
ID	string	L’identifiant unique du message de sortie.	Oui
role	enum	Le rôle du message de sortie. Toujours assistant. Valeurs possibles : assistant	Oui
statut	enum	L’état du message d’entrée. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments d’entrée sont retournés via API. Valeurs possibles : in_progress, completed, incomplete	Oui
type	enum	Le type du message de sortie. Toujours message. Valeurs possibles : message	Oui

OutputText

Une sortie texte du modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
annotations	tableau	Les annotations de la sortie du texte.	Oui
texte	string	Le texte sorti du modèle.	Oui
type	enum	Le type du texte de sortie. Toujours output_text. Valeurs possibles : output_text	Oui

RealtimeSessionCreateRequest

Configuration en temps réel des objets de session.

Nom	Catégorie	Description	Obligatoire	Par défaut
input_audio_format	enum	Le format de l’audio d’entrée. Les options sont pcm16, g711_ulaw, ou g711_alaw. Pour pcm16, l’audio d’entrée doit être PCM 16 bits à un taux d’échantillonnage de 24 kHz, un seul canal (mono) et un ordre d’octets little-endian. Valeurs possibles : pcm16, g711_ulaw, g711_alaw	Non
input_audio_noise_reduction	Objet	Configuration pour la réduction du bruit audio en entrée. Cela peut être configuré pour null désactiver. La réduction de bruit filtre l’audio ajouté au tampon audio d’entrée avant qu’il ne soit envoyé au VAD et au modèle. Le filtrage audio peut améliorer la précision de la détection des VAD et des virages (réduisant les faux positifs) ainsi que la performance du modèle en améliorant la perception de l’audio en entrée.	Non
└─ Type	enum	Un type de réduction du bruit. near_field est pour les microphones à dialogue rapproché comme les casques, far_field pour les microphones à distance comme les ordinateurs portables ou les microphones de salle de conférence. Valeurs possibles : near_field, far_field	Non
input_audio_transcription	Objet	Configuration pour la transcription audio d’entrée, par défaut désactivée et peut être configurée pour null s’éteindre une fois activée. La transcription audio en entrée n’est pas native au modèle, car celui-ci consomme directement l’audio. La transcription s’exécute de manière asynchrone via le point de terminaison Transcriptions et doit être traitée comme une orientation du contenu audio d’entrée plutôt que comme ce que le modèle a entendu précisément. Le client peut optionnellement définir la langue et la demande de transcription, ce qui offre des conseils supplémentaires au service de transcription.	Non
└─ Langue	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 (par exemple en) améliore la précision et la latence.	Non
└─ Modèle	string	Le modèle à utiliser pour la transcription, les options actuelles sont gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, et whisper-1.	Non
└─ invite	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. Pour whisper-1, l’invite est une liste de mots-clés. Pour les gpt-4o-transcribe modèles, la demande est une chaîne de texte libre, par exemple « attendez-vous à des mots liés à la technologie ».	Non
consignes	string	Les instructions système par défaut (c’est-à-dire le message système) précédaient les appels de modèle. Ce champ permet au client de guider le modèle sur les réponses souhaitées. Le modèle peut être instruit sur le contenu et le format des réponses (par exemple « soyez extrêmement concis », « soyez amical », « voici des exemples de bonnes réponses ») et sur le comportement audio (par exemple « parlez vite », « injectez de l’émotion dans votre voix », « riez fréquemment »). Les instructions ne sont pas garanties d’être suivies par le modèle, mais elles fournissent des indications au modèle sur le comportement souhaité. Notez que le serveur définit des instructions par défaut qui seront utilisées si ce champ n’est pas défini et qui sont visibles lors de l’événement session.created au début de la session.	Non
max_response_output_tokens	entier ou chaîne	Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, incluant les appels d’outils. Fournir un entier compris entre 1 et 4096 pour limiter les jetons de sortie, ou inf pour le nombre maximal de jetons disponibles pour un modèle donné. Par défaut, .inf	Non
Modalités		L’ensemble des modalités auxquelles le modèle peut répondre. Pour désactiver l’audio, réglez cela sur [« texte »].	Non
model	string	Le nom du déploiement utilisé pour cette session.	Non
output_audio_format	enum	Le format de l’audio de sortie. Les options sont pcm16, g711_ulaw, ou g711_alaw. Pour pcm16, l’audio de sortie est échantillonné à un débit de 24 kHz. Valeurs possibles : pcm16, g711_ulaw, g711_alaw	Non
Température	number	Température d’échantillonnage pour le modèle, limitée à [0,6, 1,2]. Pour les modèles audio, une température de 0,8 est fortement recommandée pour de meilleures performances.	Non	0.8
tool_choice	string	Comment le modèle choisit les outils. Les options sont auto, none, required, ou spécifier une fonction.	Non	auto
Outils	tableau	Outils (fonctions) disponibles pour le modèle.	Non
turn_detection	Objet	Configuration pour la détection de tour, VAD serveur ether ou VAD sémantique. Cela peut être configuré pour null désactiver, auquel cas le client doit déclencher manuellement la réponse du modèle. Le VAD serveur signifie que le modèle détecte le début et la fin de la parole en fonction du volume audio et répond à la fin de la parole de l’utilisateur. Le VAD sémantique est plus avancé et utilise un modèle de détection de virage (en conjonction avec le VAD) pour estimer sémantiquement si l’utilisateur a terminé de parler, puis fixe dynamiquement un délai d’attente basé sur cette probabilité. Par exemple, si l’audio de l’utilisateur s’éteint avec uhhm, le modèle obtiendra une faible probabilité de fin de tour et attendra plus longtemps que l’utilisateur continue à parler. Cela peut être utile pour des conversations plus naturelles, mais peut avoir une latence plus élevée.	Non
└─create_response	booléen	S’il faut ou non générer automatiquement une réponse lorsqu’un arrêt VAD se produit.	Non	True
└─ enthousiasme	enum	Utilisé uniquement pour le semantic_vad mode. L’empressement du modèle à répondre. low attendra plus longtemps que l’utilisateur continue de parler, high répondra plus rapidement. auto est le par défaut et est équivalent à medium. Valeurs possibles : low, medium, high, auto	Non
└interrupt_response	booléen	S’il faut ou non interrompre automatiquement toute réponse en cours avec une sortie vers la conversation par défaut (c’est-à-dire conversation de auto) lorsqu’un événement de démarrage VAD se produit.	Non	True
prefix_padding_ms	entier	Utilisé uniquement pour le server_vad mode. Quantité d’audio à inclure avant que le VAD ne détecte la parole (en millisecondes). Par défaut, c’est 300 ms.	Non
└durée_du_silence_ms	entier	Utilisé uniquement pour le server_vad mode. Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Par défaut, c’est 500ms. Avec des valeurs plus courtes, le modèle répondra plus rapidement, mais peut intervenir lors de courtes pauses de l’utilisateur.	Non
└─ seuil	number	Utilisé uniquement pour le server_vad mode. Le seuil d’activation pour le VAD (0,0 à 1,0) est par défaut de 0,5. Un seuil plus élevé nécessitera un son plus fort pour activer le modèle, et pourrait donc mieux fonctionner dans des environnements bruyants.	Non
└─ Type	enum	Type de détection de virage. Valeurs possibles : server_vad, semantic_vad	Non
Voix	VoiceIdsShared		Non

RealtimeSessionCreateResponse

Une nouvelle configuration de session en temps réel, avec une clé éphémère. Le TTL par défaut pour les touches est d’une minute.

Nom	Catégorie	Description	Obligatoire	Par défaut
client_secret	Objet	Clé éphémère retournée par l’API.	Oui
expires_at	entier	Heure d’expiration du jeton. Actuellement, tous les jetons expirent après une minute.	Non
└─ valeur	string	Clé éphémère utilisable dans les environnements clients pour authentifier les connexions à l’API Temps Réel. Utilisez-le dans des environnements côté client plutôt qu’un jeton API standard, qui ne devrait être utilisé que côté serveur.	Non
input_audio_format	string	Le format de l’audio d’entrée. Les options sont pcm16, g711_ulaw, ou g711_alaw.	Non
input_audio_transcription	Objet	Configuration pour la transcription audio d’entrée, par défaut désactivée et peut être configurée pour null s’éteindre une fois activée. La transcription audio en entrée n’est pas native au modèle, car celui-ci consomme directement l’audio. La transcription s’exécute de façon asynchrone via Whisper et doit être considérée comme une guidance approximative plutôt que comme la représentation comprise par le modèle.	Non
└─ Modèle	string	Le modèle à utiliser pour la whisper-1 transcription est le seul modèle actuellement pris en charge.	Non
consignes	string	Les instructions système par défaut (c’est-à-dire le message système) précédaient les appels de modèle. Ce champ permet au client de guider le modèle sur les réponses souhaitées. Le modèle peut être instruit sur le contenu et le format des réponses (par exemple « soyez extrêmement concis », « agissez amical », « voici des exemples de bonnes réponses ») et sur le comportement audio (par exemple « parlez vite », « injectez de l’émotion dans votre voix », « riez fréquemment »). Les instructions ne sont pas garanties d’être suivies par le modèle, mais elles fournissent des indications au modèle sur le comportement souhaité. Notez que le serveur définit des instructions par défaut qui seront utilisées si ce champ n’est pas défini et qui sont visibles lors de l’événement session.created au début de la session.	Non
max_response_output_tokens	entier ou chaîne	Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, incluant les appels d’outils. Fournir un entier compris entre 1 et 4096 pour limiter les jetons de sortie, ou inf pour le nombre maximal de jetons disponibles pour un modèle donné. Par défaut, .inf	Non
Modalités		L’ensemble des modalités auxquelles le modèle peut répondre. Pour désactiver l’audio, réglez cela sur [« texte »].	Non
output_audio_format	string	Le format de l’audio de sortie. Les options sont pcm16, g711_ulaw, ou g711_alaw.	Non
Température	number	Température d’échantillonnage pour le modèle, limitée à [0,6, 1,2]. Par défaut à 0,8.	Non
tool_choice	string	Comment le modèle choisit les outils. Les options sont auto, none, required, ou spécifier une fonction.	Non
Outils	tableau	Outils (fonctions) disponibles pour le modèle.	Non
turn_detection	Objet	Configuration pour la détection de virage. On peut configurer pour null désactiver. Le VAD serveur signifie que le modèle détecte le début et la fin de la parole en fonction du volume audio et répond à la fin de la parole de l’utilisateur.	Non
prefix_padding_ms	entier	Quantité d’audio à inclure avant que le VAD ne détecte la parole (en millisecondes). Par défaut, c’est 300 ms.	Non
└durée_du_silence_ms	entier	Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Par défaut, c’est 500ms. Avec des valeurs plus courtes, le modèle répondra plus rapidement, mais peut intervenir lors de courtes pauses de l’utilisateur.	Non
└─ seuil	number	Le seuil d’activation pour le VAD (0,0 à 1,0) est par défaut de 0,5. Un seuil plus élevé nécessitera un son plus fort pour activer le modèle, et pourrait donc mieux fonctionner dans des environnements bruyants.	Non
└─ Type	string	Seul server_vad le type de détection de virage est actuellement pris en charge.	Non
Voix	VoiceIdsShared		Non

RealtimeTranscriptionSessionCreateRequest

Configuration d’objets de session de transcription en temps réel.

Nom	Catégorie	Description	Obligatoire	Par défaut
Inclure	tableau	L’ensemble des éléments à inclure dans la transcription. Les articles actuellement disponibles sont : - item.input_audio_transcription.logprobs	Non
input_audio_format	enum	Le format de l’audio d’entrée. Les options sont pcm16, g711_ulaw, ou g711_alaw. Pour pcm16, l’audio d’entrée doit être PCM 16 bits à un taux d’échantillonnage de 24 kHz, un seul canal (mono) et un ordre d’octets little-endian. Valeurs possibles : pcm16, g711_ulaw, g711_alaw	Non
input_audio_noise_reduction	Objet	Configuration pour la réduction du bruit audio en entrée. Cela peut être configuré pour null désactiver. La réduction de bruit filtre l’audio ajouté au tampon audio d’entrée avant qu’il ne soit envoyé au VAD et au modèle. Le filtrage audio peut améliorer la précision de la détection des VAD et des virages (réduisant les faux positifs) ainsi que la performance du modèle en améliorant la perception de l’audio en entrée.	Non
└─ Type	enum	Un type de réduction du bruit. near_field est pour les microphones à dialogue rapproché comme les casques, far_field pour les microphones à distance comme les ordinateurs portables ou les microphones de salle de conférence. Valeurs possibles : near_field, far_field	Non
input_audio_transcription	Objet	Configuration pour la transcription audio en entrée. Le client peut optionnellement définir la langue et la demande de transcription, ce qui offre des conseils supplémentaires au service de transcription.	Non
└─ Langue	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 (par exemple en) améliore la précision et la latence.	Non
└─ Modèle	enum	Le modèle à utiliser pour la transcription, les options actuelles sont gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, et whisper-1. Valeurs possibles : gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1	Non
└─ invite	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. Pour whisper-1, l’invite est une liste de mots-clés. Pour les gpt-4o-transcribe modèles, la demande est une chaîne de texte libre, par exemple « attendez-vous à des mots liés à la technologie ».	Non
Modalités		L’ensemble des modalités auxquelles le modèle peut répondre. Pour désactiver l’audio, réglez cela sur [« texte »].	Non
turn_detection	Objet	Configuration pour la détection de tour, VAD serveur ether ou VAD sémantique. Cela peut être configuré pour null désactiver, auquel cas le client doit déclencher manuellement la réponse du modèle. Le VAD serveur signifie que le modèle détecte le début et la fin de la parole en fonction du volume audio et répond à la fin de la parole de l’utilisateur. Le VAD sémantique est plus avancé et utilise un modèle de détection de virage (en conjonction avec le VAD) pour estimer sémantiquement si l’utilisateur a terminé de parler, puis fixe dynamiquement un délai d’attente basé sur cette probabilité. Par exemple, si l’audio de l’utilisateur s’éteint avec uhhm, le modèle obtiendra une faible probabilité de fin de tour et attendra plus longtemps que l’utilisateur continue à parler. Cela peut être utile pour des conversations plus naturelles, mais peut avoir une latence plus élevée.	Non
└─create_response	booléen	S’il faut ou non générer automatiquement une réponse lorsqu’un arrêt VAD se produit. Non disponible pour les séances de transcription.	Non	True
└─ enthousiasme	enum	Utilisé uniquement pour le semantic_vad mode. L’empressement du modèle à répondre. low attendra plus longtemps que l’utilisateur continue de parler, high répondra plus rapidement. auto est le par défaut et est équivalent à medium. Valeurs possibles : low, medium, high, auto	Non
└interrupt_response	booléen	S’il faut ou non interrompre automatiquement toute réponse en cours avec une sortie vers la conversation par défaut (c’est-à-dire conversation de auto) lorsqu’un événement de démarrage VAD se produit. Non disponible pour les séances de transcription.	Non	True
prefix_padding_ms	entier	Utilisé uniquement pour le server_vad mode. Quantité d’audio à inclure avant que le VAD ne détecte la parole (en millisecondes). Par défaut, c’est 300 ms.	Non
└durée_du_silence_ms	entier	Utilisé uniquement pour le server_vad mode. Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Par défaut, c’est 500ms. Avec des valeurs plus courtes, le modèle répondra plus rapidement, mais peut intervenir lors de courtes pauses de l’utilisateur.	Non
└─ seuil	number	Utilisé uniquement pour le server_vad mode. Le seuil d’activation pour le VAD (0,0 à 1,0) est par défaut de 0,5. Un seuil plus élevé nécessitera un son plus fort pour activer le modèle, et pourrait donc mieux fonctionner dans des environnements bruyants.	Non
└─ Type	enum	Type de détection de virage. Valeurs possibles : server_vad, semantic_vad	Non

RealtimeTranscriptionSessionCreateResponse

Une nouvelle configuration de session de transcription en temps réel.

Lorsqu’une session est créée sur le serveur via l’API REST, l’objet de session contient également une clé éphémère. Le TTL par défaut pour les touches est d’une minute. Cette propriété n’est pas présente lorsqu’une session est mise à jour via l’API WebSocket.

Nom	Catégorie	Description	Obligatoire	Par défaut
client_secret	Objet	Clé éphémère retournée par l’API. Présent uniquement lorsque la session est créée sur le serveur via l’API REST.	Oui
expires_at	entier	Heure d’expiration du jeton. Actuellement, tous les jetons expirent après une minute.	Non
└─ valeur	string	Clé éphémère utilisable dans les environnements clients pour authentifier les connexions à l’API Temps Réel. Utilisez-le dans des environnements côté client plutôt qu’un jeton API standard, qui ne devrait être utilisé que côté serveur.	Non
input_audio_format	string	Le format de l’audio d’entrée. Les options sont pcm16, g711_ulaw, ou g711_alaw.	Non
input_audio_transcription	Objet	Configuration du modèle de transcription.	Non
└─ Langue	string	La langue de l’audio d’entrée. Fournir le langage d’entrée au format ISO-639-1 (par exemple en) améliore la précision et la latence.	Non
└─ Modèle	enum	Le modèle à utiliser pour la transcription. Peut être gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, ou whisper-1. Valeurs possibles : gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1	Non
└─ invite	string	Un texte optionnel pour guider le style du modèle ou poursuivre un segment audio précédent. La consigne doit correspondre au langage audio.	Non
Modalités		L’ensemble des modalités auxquelles le modèle peut répondre. Pour désactiver l’audio, réglez cela sur [« texte »].	Non
turn_detection	Objet	Configuration pour la détection de virage. On peut configurer pour null désactiver. Le VAD serveur signifie que le modèle détecte le début et la fin de la parole en fonction du volume audio et répond à la fin de la parole de l’utilisateur.	Non
prefix_padding_ms	entier	Quantité d’audio à inclure avant que le VAD ne détecte la parole (en millisecondes). Par défaut, c’est 300 ms.	Non
└durée_du_silence_ms	entier	Durée du silence pour détecter l’arrêt de la parole (en millisecondes). Par défaut, c’est 500ms. Avec des valeurs plus courtes, le modèle répondra plus rapidement, mais peut intervenir lors de courtes pauses de l’utilisateur.	Non
└─ seuil	number	Le seuil d’activation pour le VAD (0,0 à 1,0) est par défaut de 0,5. Un seuil plus élevé nécessitera un son plus fort pour activer le modèle, et pourrait donc mieux fonctionner dans des environnements bruyants.	Non
└─ Type	string	Seul server_vad le type de détection de virage est actuellement pris en charge.	Non

Reasoning

Options de configuration pour les modèles de raisonnement.

Nom	Catégorie	Description	Obligatoire	Par défaut
effort	ReasoningEffort	Limite l’effort de raisonnement pour les modèles de raisonnement. Les valeurs actuellement prises en charge sont low, medium, et high. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés pour raisonner dans une réponse.	Oui	moyenne
summary	enum	Un résumé du raisonnement réalisé par le modèle. Cela peut être utile pour déboguer et comprendre le processus de raisonnement du modèle. L’un des concise ou detailed. Valeurs possibles : concise, detailed	Non

ReasoningItem

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

Nom	Catégorie	Description	Obligatoire	Par défaut
contenu	tableau	Contenu du texte de raisonnement.	Oui
ID	string	L’identifiant unique du contenu de raisonnement.	Oui
statut	enum	Le statut de l’objet. L’un des in_progress, completed, ou incomplete. Rempli lorsque les éléments sont retournés via l’API. Valeurs possibles : in_progress, completed, incomplete	Non
type	enum	Le type d’objet. Toujours reasoning. Valeurs possibles : reasoning	Oui

Refusal

Un refus de la part du mannequin.

Nom	Catégorie	Description	Obligatoire	Par défaut
refusal	string	L’explication du refus du modèle.	Oui
type	enum	Le type de refus. Toujours refusal. Valeurs possibles : refusal	Oui

response

Nom	Catégorie	Description	Obligatoire	Par défaut
date_de_création	number	Horodatage Unix (en quelques secondes) de la création de cette Réponse.	Oui
erreur	ResponseError	Un objet d’erreur retourné lorsque le modèle ne génère pas de Réponse.	Oui
ID	string	Identifiant unique pour cette réponse.	Oui
incomplete_details	Objet	Détails sur les raisons pour lesquelles la réponse est incomplète.	Oui
└─ raison	enum	La raison pour laquelle la réponse est incomplète. Valeurs possibles : max_output_tokens, content_filter	Non
consignes	string	Insère un message système (ou développeur) comme premier élément dans le contexte du modèle. Lorsqu’on utilise avec previous_response_id, les instructions d’une réponse précédente ne seront pas relayées vers la réponse suivante. Cela facilite le remplacement des messages système (ou développeur) par de nouvelles réponses.	Oui
max_output_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une réponse, y compris les jetons de sortie visibles et l’état de la conversation.	Non
metadata	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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères.	Oui
model	string	Modèle utilisé pour générer les réponses.	Oui
Objet	enum	Le type d’objet de cette ressource - toujours défini à response. Valeurs possibles : response	Oui
sortie	tableau	Un ensemble 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 de la réponse du modèle. - Plutôt que d’accéder au premier élément du output tableau et de supposer qu’il s’agit d’un assistant message contenant le contenu généré par le modèle, vous pourriez envisager d’utiliser la output_text propriété prise en charge dans les SDK.	Oui
output_text	string	Propriété de commodité uniquement SDK qui contient le texte agrégé sorti de tous output_text les éléments du output tableau, s’il y en a un. Pris en charge dans les SDK Python et JavaScript.	Non
parallel_tool_calls	booléen	Permettre au modèle d’exécuter des appels d’outils en parallèle.	Oui	True
previous_response_id	string	L’identifiant unique de la réponse précédente au modèle. Utilisez cela pour créer des conversations sur plusieurs tours.	Non
reasoning	Reasoning	Options de configuration pour les modèles de raisonnement.	Non
statut	enum	L’état de la génération de la réponse. L’un des completed, failed, in_progress, ou incomplete. Valeurs possibles : completed, failed, in_progress, incomplete	Non
Température	number	Quelle température d’échantillonnage utiliser, entre 0 et 2. Des valeurs plus élevées comme 0,8 rendent la sortie plus aléatoire, tandis que des valeurs plus basses comme 0,2 la rendent plus ciblée et déterministe. Nous recommandons généralement de modifier cela, ou top_p pas les deux.	Oui	1
texte	Objet	Options de configuration pour une réponse texte du modèle. Cela 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	Non
└─ Format	TextResponseFormatConfiguration	Un objet spécifiant le format que le modèle doit produire. La configuration { "type": "json_schema" } permet de créer des sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. Le format par défaut est { "type": "text" } sans 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 préférée pour les modèles qui le supportent.	Non
tool_choice	OptionsDeDeChoix-de-Outils, TypesDeDeChoix-d’Outils, ou FonctionChoixDeChoix-deOutils	Comment le modèle doit choisir quel outil (ou outils) utiliser lors de la génération d’une réponse. Voir le tools paramètre pour voir comment spécifier quels outils le modèle peut appeler.	Oui
Outils	tableau	Un ensemble d’outils que le modèle peut appeler lors de la génération d’une réponse. Vous pouvez spécifier quel outil utiliser en définissant le tool_choice paramètre. Les deux catégories d’outils que vous pouvez fournir au modèle sont : - Outils intégrés	Oui
top_p	number	Une alternative à l’échantillonnage par température, appelée échantillonnage de noyau, où le modèle considère les résultats des jetons avec top_p masse de probabilité. Ainsi, 0,1 signifie que seuls les jetons composant la 10e première masse de probabilité% sont pris en compte. Nous recommandons généralement de modifier cela, ou temperature pas les deux.	Oui	1
truncation	enum	La stratégie de troncature à utiliser pour la réponse du modèle. - auto: Si le contexte de cette réponse et des précédentes dépasse la taille de la fenêtre contextuelle du modèle, le modèle tronquera la réponse pour s’adapter à la fenêtre de contexte en supprimant des éléments d’entrée au milieu de la conversation. - disabled (par défaut) : Si une réponse de modèle dépasse la taille de la fenêtre de contexte pour un modèle, la requête échouera avec une erreur 400. Valeurs possibles : auto, disabled	Non
utilisation	ResponseUsage	Représente les détails d’utilisation des jetons, y compris les jetons d’entrée, de sortie, une répartition des jetons de sortie et le total des jetons utilisés.	Non
utilisateur	string	Un identifiant unique représentant votre utilisateur final, qui peut aider OpenAI à surveiller et détecter les abus. .	Non

ResponseAudioDeltaEvent

Émis lorsqu’il y a une réponse audio partielle.

Nom	Catégorie	Description	Obligatoire	Par défaut
delta	string	Un morceau d’octets audio de réponse codée en Base64.	Oui
type	enum	Le type d’événement. Toujours response.audio.delta. Valeurs possibles : response.audio.delta	Oui

ResponseAudioDoneEvent

Émis lorsque la réponse audio est terminée.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Le type d’événement. Toujours response.audio.done. Valeurs possibles : response.audio.done	Oui

ResponseAudioTranscriptDeltaEvent

Émis lorsqu’il y a une transcription partielle de l’audio.

Nom	Catégorie	Description	Obligatoire	Par défaut
delta	string	La transcription partielle de la réponse audio.	Oui
type	enum	Le type d’événement. Toujours response.audio.transcript.delta. Valeurs possibles : response.audio.transcript.delta	Oui

ResponseAudioTranscriptDoneEvent

Émis lorsque la transcription audio complète est terminée.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Le type d’événement. Toujours response.audio.transcript.done. Valeurs possibles : response.audio.transcript.done	Oui

ResponseCodeInterpreterCallCodeDeltaEvent

Émis lorsqu’un extrait de code partiel est ajouté par l’interpréteur de code.

Nom	Catégorie	Description	Obligatoire	Par défaut
delta	string	Le fragment partiel de code ajouté par l’interpréteur de code.	Oui
output_index	entier	L’index de l’élément de sortie appelé par l’interpréteur de code est en cours.	Oui
type	enum	Le type d’événement. Toujours response.code_interpreter_call.code.delta. Valeurs possibles : response.code_interpreter_call.code.delta	Oui

ResponseCodeInterpreterCallCodeDoneEvent

Émis lorsque la sortie du extrait de code est finalisée par l’interpréteur de code.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	string	Le dernier extrait de code produit par l’interpréteur de code.	Oui
output_index	entier	L’index de l’élément de sortie appelé par l’interpréteur de code est en cours.	Oui
type	enum	Le type d’événement. Toujours response.code_interpreter_call.code.done. Valeurs possibles : response.code_interpreter_call.code.done	Oui

ResponseCodeInterpreterCallCompletedEvent

Émis lorsque l’appel de l’interpréteur de code est terminé.

Nom	Catégorie	Description	Obligatoire	Par défaut
code_interpreter_call	CodeInterpreterToolCall	Un appel à l’outil pour exécuter du code.	Oui
output_index	entier	L’index de l’élément de sortie appelé par l’interpréteur de code est en cours.	Oui
type	enum	Le type d’événement. Toujours response.code_interpreter_call.completed. Valeurs possibles : response.code_interpreter_call.completed	Oui

ResponseCodeInterpreterCallInProgressEvent

Émis lorsqu’un appel d’interpréteur de code est en cours.

Nom	Catégorie	Description	Obligatoire	Par défaut
code_interpreter_call	CodeInterpreterToolCall	Un appel à l’outil pour exécuter du code.	Oui
output_index	entier	L’index de l’élément de sortie appelé par l’interpréteur de code est en cours.	Oui
type	enum	Le type d’événement. Toujours response.code_interpreter_call.in_progress. Valeurs possibles : response.code_interpreter_call.in_progress	Oui

ResponseCodeInterpreterCallInterpretingEvent

Émis lorsque l’interpréteur de code interprète activement le fragment de code.

Nom	Catégorie	Description	Obligatoire	Par défaut
code_interpreter_call	CodeInterpreterToolCall	Un appel à l’outil pour exécuter du code.	Oui
output_index	entier	L’index de l’élément de sortie appelé par l’interpréteur de code est en cours.	Oui
type	enum	Le type d’événement. Toujours response.code_interpreter_call.interpreting. Valeurs possibles : response.code_interpreter_call.interpreting	Oui

ResponseCompletedEvent

Émis lorsque la réponse du modèle est terminée.

Nom	Catégorie	Description	Obligatoire	Par défaut
response	response		Oui
type	enum	Le type d’événement. Toujours response.completed. Valeurs possibles : response.completed	Oui

ResponseContentPartAddedEvent

Émis lorsqu’une nouvelle partie de contenu est ajoutée.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_index	entier	L’index de la partie contenu ajoutée.	Oui
item_id	string	L’identifiant de l’élément de sortie auquel la partie contenu a été ajoutée.	Oui
output_index	entier	L’indice de l’élément de sortie auquel la partie contenu a été ajoutée.	Oui
part	OutputContent		Oui
type	enum	Le type d’événement. Toujours response.content_part.added. Valeurs possibles : response.content_part.added	Oui

ResponseContentPartDoneEvent

Émis lorsqu’une partie de contenu est terminée.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_index	entier	L’index du contenu qui est réalisé.	Oui
item_id	string	L’identifiant de l’élément de sortie auquel la partie contenu a été ajoutée.	Oui
output_index	entier	L’indice de l’élément de sortie auquel la partie contenu a été ajoutée.	Oui
part	OutputContent		Oui
type	enum	Le type d’événement. Toujours response.content_part.done. Valeurs possibles : response.content_part.done	Oui

ResponseCreatedEvent

Un événement émis lors de la création d’une réponse.

Nom	Catégorie	Description	Obligatoire	Par défaut
response	response		Oui
type	enum	Le type d’événement. Toujours response.created. Valeurs possibles : response.created	Oui

ResponseError

Un objet d’erreur retourné lorsque le modèle ne génère pas de Réponse.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	ResponseErrorCode	Le code d’erreur de la réponse.	Oui
message	string	Une description lisible par l’homme de l’erreur.	Oui

ResponseErrorCode

Le code d’erreur de la réponse.

Propriété	Valeur
Description	Le code d’erreur de la réponse.
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

ResponseErrorEvent

Émis lorsqu’une erreur survient.

Nom	Catégorie	Description	Obligatoire	Par défaut
code	string	Le code d’erreur.	Oui
message	string	Le message d’erreur.	Oui
param	string	Le paramètre d’erreur.	Oui
type	enum	Le type d’événement. Toujours error. Valeurs possibles : error	Oui

ResponseFailedEvent

Un événement émis lorsqu’une réponse échoue.

Nom	Catégorie	Description	Obligatoire	Par défaut
response	response		Oui
type	enum	Le type d’événement. Toujours response.failed. Valeurs possibles : response.failed	Oui

ResponseFileSearchCallCompletedEvent

Émis lorsqu’un appel de recherche de fichier est terminé (résultats trouvés).

Nom	Catégorie	Description	Obligatoire	Par défaut
item_id	string	L’identifiant de l’élément de sortie que l’appel de recherche de fichier est initié.	Oui
output_index	entier	L’index de l’élément de sortie que la recherche de fichier appelle est lancé.	Oui
type	enum	Le type d’événement. Toujours response.file_search_call.completed. Valeurs possibles : response.file_search_call.completed	Oui

ResponseFileSearchCallInProgressEvent

Émis lors de l’initiation d’un appel de recherche de fichiers.

Nom	Catégorie	Description	Obligatoire	Par défaut
item_id	string	L’identifiant de l’élément de sortie que l’appel de recherche de fichier est initié.	Oui
output_index	entier	L’index de l’élément de sortie que la recherche de fichier appelle est lancé.	Oui
type	enum	Le type d’événement. Toujours response.file_search_call.in_progress. Valeurs possibles : response.file_search_call.in_progress	Oui

ResponseFileSearchCallSearchingEvent

Émis lorsqu’une recherche de fichier est en cours de recherche.

Nom	Catégorie	Description	Obligatoire	Par défaut
item_id	string	L’identifiant de l’élément de sortie que l’appel de recherche de fichier est initié.	Oui
output_index	entier	L’index de l’élément de sortie que la recherche de fichier appelle en recherche.	Oui
type	enum	Le type d’événement. Toujours response.file_search_call.searching. Valeurs possibles : response.file_search_call.searching	Oui

ResponseFunctionCallArgumentsDeltaEvent

Émis lorsqu’il existe un delta partiel d’arguments d’appel de fonction.

Nom	Catégorie	Description	Obligatoire	Par défaut
delta	string	Les arguments d’appel de fonction delta qui sont ajoutés.	Oui
item_id	string	L’ID de l’élément de sortie auquel s’ajoute le delta des arguments d’appel de fonction.	Oui
output_index	entier	L’indice de l’élément de sortie auquel les arguments d’appel de fonction sont ajoutés.	Oui
type	enum	Le type d’événement. Toujours response.function_call_arguments.delta. Valeurs possibles : response.function_call_arguments.delta	Oui

ResponseFunctionCallArgumentsDoneEvent

Émis lorsque les arguments d’appel de fonction sont finalisés.

Nom	Catégorie	Description	Obligatoire	Par défaut
Arguments	string	Les arguments de l’appel de fonction.	Oui
item_id	string	L’identité de l’objet.	Oui
output_index	entier	L’indice de l’élément sorti.	Oui
type	enum	Valeurs possibles : response.function_call_arguments.done	Oui

ResponseInProgressEvent

Émis lorsque la réponse est en cours.

Nom	Catégorie	Description	Obligatoire	Par défaut
response	response		Oui
type	enum	Le type d’événement. Toujours response.in_progress. Valeurs possibles : response.in_progress	Oui

ResponseIncompleteEvent

Un événement émis lorsqu’une réponse se termine comme incomplète.

Nom	Catégorie	Description	Obligatoire	Par défaut
response	response		Oui
type	enum	Le type d’événement. Toujours response.incomplete. Valeurs possibles : response.incomplete	Oui

responseItemList

Une liste des éléments de réponse.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau	Une liste des éléments utilisés pour générer cette réponse.	Oui
premier_identifiant	string	L’identifiant du premier élément de la liste.	Oui
has_more	booléen	S’il y a d’autres articles disponibles.	Oui
last_id	string	L’ID du dernier élément de la liste.	Oui
Objet	enum	Le type d’objet retourné doit être list. Valeurs possibles : list	Oui

ResponseModalities

Types de sortie que vous souhaitez que le modèle génère. La plupart des modèles sont capables de générer du texte, ce qui est le principe par défaut :

["text"]

Le gpt-4o-audio-preview modèle peut également être utilisé pour générer de l’audio. Pour demander à ce modèle de générer à la fois des réponses textuelles et audio, vous pouvez utiliser :

["text", "audio"]

Aucune propriété définie pour ce composant.

ResponseModalitiesTextOnly

Types de sortie que vous souhaitez que le modèle génère. La plupart des modèles sont capables de générer du texte, ce qui est le principe par défaut :

["text"]

Cette API prendra bientôt en charge d’autres modalités de sortie, y compris l’audio et les images.

Aucune propriété définie pour ce composant.

ResponseOutputItemAddedEvent

Émis lorsqu’un nouvel élément de sortie est ajouté.

Nom	Catégorie	Description	Obligatoire	Par défaut
item	OutputItem		Oui
output_index	entier	L’indice de l’élément de sortie ajouté.	Oui
type	enum	Le type d’événement. Toujours response.output_item.added. Valeurs possibles : response.output_item.added	Oui

ResponseOutputItemDoneEvent

Émis lorsqu’un élément de sortie est marqué comme terminé.

Nom	Catégorie	Description	Obligatoire	Par défaut
item	OutputItem		Oui
output_index	entier	L’index de l’élément de sortie marqué comme terminé.	Oui
type	enum	Le type d’événement. Toujours response.output_item.done. Valeurs possibles : response.output_item.done	Oui

ResponseProperties

Nom	Catégorie	Description	Obligatoire	Par défaut
consignes	string	Insère un message système (ou développeur) comme premier élément dans le contexte du modèle. Lorsqu’on utilise avec previous_response_id, les instructions d’une réponse précédente ne seront pas relayées vers la réponse suivante. Cela facilite le remplacement des messages système (ou développeur) par de nouvelles réponses.	Non
max_output_tokens	entier	Une borne supérieure pour le nombre de jetons pouvant être générés pour une réponse, y compris les jetons de sortie visibles et l’état de la conversation.	Non
previous_response_id	string	L’identifiant unique de la réponse précédente au modèle. Utilisez cela pour créer des conversations sur plusieurs tours.	Non
reasoning	Reasoning	Options de configuration pour les modèles de raisonnement.	Non
texte	Objet	Options de configuration pour une réponse texte du modèle. Cela 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	Non
└─ Format	TextResponseFormatConfiguration	Un objet spécifiant le format que le modèle doit produire. La configuration { "type": "json_schema" } permet de créer des sorties structurées, ce qui garantit que le modèle correspond à votre schéma JSON fourni. Le format par défaut est { "type": "text" } sans 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 préférée pour les modèles qui le supportent.	Non
tool_choice	OptionsDeDeChoix-de-Outils, TypesDeDeChoix-d’Outils, ou FonctionChoixDeChoix-deOutils	Comment le modèle doit choisir quel outil (ou outils) utiliser lors de la génération d’une réponse. Voir le tools paramètre pour voir comment spécifier quels outils le modèle peut appeler.	Non
Outils	tableau	Un ensemble d’outils que le modèle peut appeler lors de la génération d’une réponse. Vous pouvez spécifier quel outil utiliser en définissant le tool_choice paramètre. Les deux catégories d’outils que vous pouvez fournir au modèle sont : - Outils intégrés	Non
truncation	enum	La stratégie de troncature à utiliser pour la réponse du modèle. - auto: Si le contexte de cette réponse et des précédentes dépasse la taille de la fenêtre contextuelle du modèle, le modèle tronquera la réponse pour s’adapter à la fenêtre de contexte en supprimant des éléments d’entrée au milieu de la conversation. - disabled (par défaut) : Si une réponse de modèle dépasse la taille de la fenêtre de contexte pour un modèle, la requête échouera avec une erreur 400. Valeurs possibles : auto, disabled	Non

ResponseRefusalDeltaEvent

Émis lorsqu’il y a un texte de refus partiel.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_index	entier	L’index de la partie de contenu à laquelle le texte de refus est ajouté.	Oui
delta	string	Le texte de refus qui est ajouté.	Oui
item_id	string	L’identifiant de l’élément de sortie auquel le texte de refus est ajouté.	Oui
output_index	entier	L’index de l’élément de sortie auquel le texte de refus est ajouté.	Oui
type	enum	Le type d’événement. Toujours response.refusal.delta. Valeurs possibles : response.refusal.delta	Oui

ResponseRefusalDoneEvent

Émis lorsque le texte de refus est finalisé.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_index	entier	L’index du contenu indique que le texte de refus est finalisé.	Oui
item_id	string	L’identifiant de l’élément de sortie indiquant que 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	Le texte de refus qui est finalisé.	Oui
type	enum	Le type d’événement. Toujours response.refusal.done. Valeurs possibles : response.refusal.done	Oui

responseStreamEvent

Nom	Catégorie	Description	Obligatoire	Par défaut
annotation	Annotation		Oui
annotation_index	entier	L’index de l’annotation ajoutée.	Oui
Arguments	string	Les arguments de l’appel de fonction.	Oui
code	string	Le code d’erreur.	Oui
code_interpreter_call	CodeInterpreterToolCall	Un appel à l’outil pour exécuter du code.	Oui
content_index	entier	L’index du contenu où le texte est finalisé.	Oui
delta	string	Le texte delta qui a été ajouté.	Oui
item	OutputItem	L’élément de sortie marqué comme terminé.	Oui
item_id	string	L’identifiant de l’élément de sortie où le contenu du texte est finalisé.	Oui
message	string	Le message d’erreur.	Oui
output_index	entier	L’index de l’élément de sortie où le contenu du texte est finalisé.	Oui
param	string	Le paramètre d’erreur.	Oui
part	OutputContent	La partie contenu qui est terminée.	Oui
refusal	string	Le texte de refus qui est finalisé.	Oui
response	response	La réponse était incomplète.	Oui
texte	string	Le contenu textuel qui est finalisé.	Oui
type	enum	Le type d’événement. Toujours response.output_text.done. Valeurs possibles : response.output_text.done	Oui

ResponseTextAnnotationDeltaEvent

Émis lorsqu’une annotation de texte est ajoutée.

Nom	Catégorie	Description	Obligatoire	Par défaut
annotation	Annotation		Oui
annotation_index	entier	L’index de l’annotation ajoutée.	Oui
content_index	entier	L’index de la partie de contenu à laquelle l’annotation de texte a été ajoutée.	Oui
item_id	string	L’identifiant de l’élément de sortie auquel l’annotation de texte a été ajoutée.	Oui
output_index	entier	L’index de l’élément de sortie auquel l’annotation de texte a été ajoutée.	Oui
type	enum	Le type d’événement. Toujours response.output_text.annotation.added. Valeurs possibles : response.output_text.annotation.added	Oui

ResponseTextDeltaEvent

Émis lorsqu’il y a un delta de texte supplémentaire.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_index	entier	L’index de la partie contenu à laquelle le delta de texte a été ajouté.	Oui
delta	string	Le texte delta qui a été ajouté.	Oui
item_id	string	L’identifiant de l’élément de sortie auquel le delta de texte a été ajouté.	Oui
output_index	entier	L’index de l’élément de sortie auquel le delta de texte a été ajouté.	Oui
type	enum	Le type d’événement. Toujours response.output_text.delta. Valeurs possibles : response.output_text.delta	Oui

ResponseTextDoneEvent

Émis lorsque le contenu textuel est finalisé.

Nom	Catégorie	Description	Obligatoire	Par défaut
content_index	entier	L’index du contenu où le texte est finalisé.	Oui
item_id	string	L’identifiant de l’élément de sortie où le contenu du texte est finalisé.	Oui
output_index	entier	L’index de l’élément de sortie où le contenu du texte est finalisé.	Oui
texte	string	Le contenu textuel qui est finalisé.	Oui
type	enum	Le type d’événement. Toujours response.output_text.done. Valeurs possibles : response.output_text.done	Oui

ResponseUsage

Représente les détails d’utilisation des jetons, y compris les jetons d’entrée, de sortie, une répartition des jetons de sortie et le total des jetons utilisés.

Nom	Catégorie	Description	Obligatoire	Par défaut
input_tokens	entier	Le nombre de jetons d’entrée.	Oui
output_tokens	entier	Le nombre de jetons de sortie.	Oui
output_tokens_details	Objet	Une analyse détaillée des jetons de sortie.	Oui
└─ jetons_de_raisonnement	entier	Le nombre de jetons de raisonnement.	Non
total_tokens	entier	Le nombre total de jetons utilisés.	Oui

Capture d'écran

Une action de capture d’écran.

Nom	Catégorie	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

Scroll

Une action de défilement.

Nom	Catégorie	Description	Obligatoire	Par défaut
scroll_x	entier	La distance de défilement horizontal.	Oui
scroll_y	entier	La distance de défilement vertical.	Oui
type	enum	Spécifie le type d’événement. Pour une action de défilement, cette propriété est toujours fixée à scroll. Valeurs possibles : scroll	Oui
x	entier	La coordonnée x où le défilement s’est produit.	Oui
y	entier	La coordonnée y où le défilement a eu lieu.	Oui

StopConfiguration

Jusqu’à 4 séquences où l’API cesse de générer d’autres jetons. Le texte retourné ne contiendra pas la séquence d’arrêt.

Ce composant peut être l’un des suivants :

TextResponseFormatConfiguration

Un objet spécifiant le format que le modèle doit produire.

La configuration { "type": "json_schema" } permet des sorties structurées, qui garantissent que le modèle correspond à votre schéma JSON fourni.

Le format par défaut est { "type": "text" } sans 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 préférée pour les modèles qui le supportent.

Ce composant peut être l’un des suivants :

• ResponseFormatText
• TextResponseFormatJsonSchema
• ResponseFormatJsonObject

TextResponseFormatJsonSchema

Format de réponse de schéma JSON. Utilisé pour générer des réponses JSON structurées. En savoir plus sur les sorties structurées.

Nom	Catégorie	Description	Obligatoire	Par défaut
description	string	Une description du format de réponse, utilisée par le modèle pour déterminer comment répondre dans ce format.	Non
name	string	Le nom du format de la réponse. Doit être de A à Z, de A à Z, de 0 à 9, ou contenir des sous-traits et des titres, avec une longueur maximale de 64.	Non
schema	ResponseFormatJsonSchemaSchema	Le schéma pour le format de réponse est décrit comme un objet de schéma JSON.	Oui
strict	booléen	S’il faut activer une stricte adhésion au schéma lors de la génération de la sortie. Si le modèle est réglé sur vrai, le modèle suivra toujours exactement le schéma défini sur le schema terrain. Seul un sous-ensemble de JSON Schema est pris en charge lorsque strict est true.	Non	Faux
type	enum	Le type de format de réponse défini. Toujours json_schema. Valeurs possibles : json_schema	Oui

Outil

Ce composant peut être l’un des suivants :

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

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

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

ToolChoiceOptions

Contrôle quel outil (le cas échéant) est appelé par le modèle.

none signifie que le modèle n’appellera aucun outil et générera 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
Description	Contrôle quel outil (le cas échéant) est appelé par le modèle. none signifie que le modèle n’appellera aucun outil et générera 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.
Type	string
Valeurs	none auto required

ToolChoiceTypes

Indique que le modèle doit utiliser un outil intégré pour générer une réponse.

Nom	Catégorie	Description	Obligatoire	Par défaut
type	enum	Le type d’outil hébergé que le modèle doit utiliser. Les valeurs autorisées sont : - file_search - computer_use_preview Valeurs possibles : file_search, computer_use_preview	Oui

Catégorie

Une action pour taper un texte.

Nom	Catégorie	Description	Obligatoire	Par défaut
texte	string	Le texte à taper.	Oui
type	enum	Spécifie le type d’événement. Pour une action de type, cette propriété est toujours fixée à type. Valeurs possibles : type	Oui

UpdateVectorStoreFileAttributesRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
attributes	VectorStoreFileAttributes	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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères, des booléens ou des nombres.	Oui

UrlCitation

Une citation pour une ressource web utilisée pour générer une réponse modèle.

Nom	Catégorie	Description	Obligatoire	Par défaut
end_index	entier	L’index du dernier caractère de la citation de l’URL dans le message.	Oui
start_index	entier	L’index du premier caractère de la citation de l’URL dans le message.	Oui
title	string	Le titre de la ressource web.	Oui
type	enum	Le type de la citation de l’URL. Toujours url_citation. Valeurs possibles : url_citation	Oui
url	string	L’URL de la ressource web.	Oui

VectorStoreFileAttributes

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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères, des booléens ou des nombres.

Aucune propriété définie pour ce composant.

VectorStoreFileContentResponse

Représente le contenu analysé d’un fichier de stockage vectoriel.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau	Contenu analysé du fichier.	Oui
has_more	booléen	Indique s’il y a plus de pages de contenu à récupérer.	Oui
next_page	string	Le jeton pour la page suivante, s’il y en a.	Oui
Objet	enum	Le type d’objet, qui est toujours vector_store.file_content.page Valeurs possibles : vector_store.file_content.page	Oui

VectorStoreSearchRequest

Nom	Catégorie	Description	Obligatoire	Par défaut
Filtres	Filtre de comparaison ou filtre composé	Un filtre à appliquer basé sur les attributs du fichier.	Non
nombre_maximal_de_résultats	entier	Le nombre maximal de résultats à revendre. Ce nombre devrait être compris entre 1 et 50.	Non	10
Requête	chaîne ou tableau	Une chaîne de requête pour une recherche	Oui
options_de_classement	Objet	Options de classement pour la recherche.	Non
└─ classificateur	enum	Valeurs possibles : auto, default-2024-11-15	Non
└score_threshold	number		Non	0
rewrite_query	booléen	S’il faut réécrire la requête en langage naturel pour la recherche vectorielle.	Non	Faux

VectorStoreSearchResultContentObject

Nom	Catégorie	Description	Obligatoire	Par défaut
texte	string	Le contenu du texte est revenu de la recherche.	Oui
type	enum	Le type de contenu. Valeurs possibles : text	Oui

VectorStoreSearchResultItem

Nom	Catégorie	Description	Obligatoire	Par défaut
attributes	VectorStoreFileAttributes	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 pour interroger des objets via l’API ou le tableau de bord. Les clés sont des chaînes d’une longueur maximale de 64 caractères. Les valeurs sont des chaînes d’une longueur maximale de 512 caractères, des booléens ou des nombres.	Oui
contenu	tableau	Des morceaux de contenu du fichier.	Oui
identifiant_de_fichier	string	L’identifiant du fichier de stockage vectoriel.	Oui
filename	string	Le nom du fichier de stockage vectoriel.	Oui
Résultat	number	Le score de similarité pour le résultat.	Oui

VectorStoreSearchResultsPage

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	tableau	La liste des éléments de résultats de recherche.	Oui
has_more	booléen	Indique s’il y a d’autres résultats à obtenir.	Oui
next_page	string	Le jeton pour la page suivante, s’il y en a.	Oui
Objet	enum	Le type d’objet, qui est toujours vector_store.search_results.page Valeurs possibles : vector_store.search_results.page	Oui
search_query	tableau		Oui

VoiceIdsShared

Aucune propriété définie pour ce composant.

Wait

Une action d’attente.

Nom	Catégorie	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 à wait. Valeurs possibles : wait	Oui

ReasoningEffort

Limite l’effort de raisonnement pour les modèles de raisonnement. Les valeurs actuellement prises en charge sont low, medium, et high. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés pour raisonner dans une réponse.

Propriété	Valeur
Description	Limite l’effort de raisonnement pour les modèles de raisonnement. Les valeurs actuellement prises en charge sont low, medium, et high. Réduire l’effort de raisonnement peut entraîner des réponses plus rapides et moins de jetons utilisés pour raisonner dans une réponse.
Type	string
Par défaut	moyenne
Valeurs	low medium high

errorEvent

Apparaît lorsqu’une erreur survient. Cela peut arriver à cause d’une erreur interne du serveur ou d’un délai d’attente.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	error		Oui
événement	string		Oui

événement Enum : ErrorEventEnum

Valeur	Description
erreur

doneEvent

Ça se produit lorsqu’un flux se termine.

Nom	Catégorie	Description	Obligatoire	Par défaut
Données	string		Oui
événement	string		Oui

événement Enum : DoneEventEnum

Valeur	Description
Terminé

data Enum : DoneEventDataEnum

Valeur	Description
[TERMINÉ]

Étapes suivantes

Apprenez-en plus sur les modèles et l’ajustement fin avec l’API REST. En savoir plus sur les modèles sous-jacents qui alimentent Azure OpenAI.