Criar uma Resposta
Gere saída de modelo com a API de Respostas compatível com OpenAI.
Use o formato da API de Respostas para entrada de modelo de texto ou estruturada e um objeto de saída unificado.
/openai/v1/responsesCorpo da Requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
model | string | Sim | Identificador do modelo roteado por AnyInt. |
input | string ou array | Sim | Texto ou itens de entrada estruturados. |
stream | boolean | Não | Retorna eventos enviados pelo servidor quando suportado. |
reasoning.effort | string | Não | Esforço dependente do modelo, encaminhado sem redução silenciosa. |
tools | array | Não | Declarações de ferramentas, incluindo ferramentas personalizadas. |
Resposta
Uma requisição concluída retorna um objeto de resposta com um identificador, status e saída gerada.
Histórico e Validação de Ferramentas
Chamadas de ferramentas personalizadas e saídas de ferramentas multipartes mantêm sua ordenação e texto Unicode. Matrizes vazias annotations e logprobs são fornecidas para partes de output_text do assistente quando omitidas ou nulas, para que uma retransmissão não possa reconstruí-las como metadados nulos inválidos. Mensagens de keep-alive do provedor são excluídas do histórico da conversa.
O suporte ao esforço de raciocínio depende do modelo selecionado e do provedor upstream. Uma rejeição estruturada identifica o campo, por exemplo error.code: "invalid_value" e error.param: "reasoning.effort". Rejeições de formato não localizáveis ou geradas por retransmissão retornam um erro upstream em vez de identificar o histórico válido do cliente como malformado.
Transmissão e Recuperação
Transmissões bem-sucedidas terminam com response.completed; limites de saída podem terminar com response.incomplete. Uma falha upstream, tempo limite esgotado ou EOF antecipado produz response.failed. Transmissões com falha não recebem um terminal de sucesso fabricado ou um marcador legado [DONE]. Verifique o evento terminal mesmo quando o status HTTP for 200. Uma falha terminal de transmissão não autoriza a reprodução automática do trabalho despachado.
Sinais de heartbeat usam comentários SSE. Eventos de response.metadata do provedor e itens de saída SSE-Keep-Alive são filtrados. Os valores de sequence_number dos eventos aumentam monotonicamente.
Os cabeçalhos opcionais x-client-message-id e x-resume-message-id aceitam a recuperação por deslocamento de eventos. x-anyint-resume-offset-unit: sse-event descreve esse deslocamento; x-anyint-stream-replayed: true identifica uma repetição. Clientes que não optarem por isso podem ignorar esses cabeçalhos de extensão.
Alias de Compatibilidade
Clientes existentes podem continuar a usar /v1/responses. Novas integrações devem usar /openai/v1/responses.