Créer une réponse

Générez la sortie du modèle avec l'API Responses compatible avec OpenAI.

Utilisez la forme de l'API Responses pour l'entrée de modèle textuelle ou structurée et un objet de sortie unifié.

POST/openai/v1/responses

Corps de la requête

ChampTypeRequisDescription
modelstringOuiIdentifiant du modèle acheminé par AnyInt.
inputstring ou tableauOuiÉléments d'entrée textuels ou structurés.
streambooleanNonRetourner les événements envoyés par le serveur lorsqu'ils sont pris en charge.
reasoning.effortstringNonEffort dépendant du modèle, transmis sans réduction silencieuse.
toolstableauNonDéclarations d'outils, y compris les outils personnalisés.

Réponse

Une requête terminée renvoie un objet de réponse avec un identifiant, un statut et la sortie générée.

Historique des outils et validation

Les appels d'outils personnalisés et les sorties d'outils en plusieurs parties conservent leur ordre et leur texte Unicode. Des tableaux vides annotations et logprobs sont fournis pour les parties output_text de l'assistant lorsqu'ils sont omis ou nuls, afin qu'un relais ne puisse pas les reconstruire en métadonnées nulles invalides. Les messages de maintien en vie du fournisseur sont exclus de l'historique des conversations.

La prise en charge de l'effort de raisonnement dépend du modèle sélectionné et du fournisseur en amont. Un rejet structuré identifie le champ, par exemple error.code: "invalid_value" et error.param: "reasoning.effort". Les rejets de format non localisables ou générés par le relais renvoient une erreur en amont au lieu d'identifier l'historique valide du client comme étant malformé.

Streaming et récupération

Les flux réussis se terminent par response.completed ; les limites de sortie peuvent se terminer par response.incomplete. Un échec en amont, un délai d'attente ou un EOF prématuré produit response.failed. Les flux ayant échoué ne reçoivent pas de marqueur de fin réussi fabriqué ou de marqueur hérité [DONE]. Vérifiez l'événement terminal même lorsque le statut HTTP est 200. Un échec de flux terminal n'autorise pas le rejeu automatique du travail envoyé.

Les signaux de pulsation utilisent des commentaires SSE. Les événements response.metadata du fournisseur et les éléments de contrôle SSE-Keep-Alive sont filtrés. Les valeurs sequence_number augmentent de manière monotone.

Les en-têtes facultatifs x-client-message-id et x-resume-message-id permettent la récupération par décalage d'événement. x-anyint-resume-offset-unit: sse-event décrit ce décalage ; x-anyint-stream-replayed: true identifie un rejeu. Les clients qui n'activent pas cette fonctionnalité peuvent ignorer ces en-têtes d'extension.

Alias de compatibilité

Les clients existants peuvent continuer à utiliser /v1/responses. Les nouvelles intégrations doivent utiliser /openai/v1/responses.