For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal

Migre de objetos de prompt

Transfira o uso de objetos de prompt gerenciados para o código da aplicação.

A OpenAI está descontinuando os objetos de prompt reutilizáveis na API. A criação de prompts passará a ter menos destaque a partir de 3 de junho de 2026, e a desativação de v1/prompts está prevista para 30 de novembro de 2026. Consulte a página de descontinuações para ver o cronograma atual.

Para deixar de usar Prompts na Plataforma de API da OpenAI, transfira o conteúdo do objeto prompt gerenciado para o código da sua aplicação. Isso dá a você mais controle sobre revisão, testes, implantação e versionamento.

Antes: usando um objeto de prompt

Use um objeto de prompt
import OpenAI from "openai";

const client = new OpenAI();

const response = await client.responses.create({
  prompt: {
    id: "pmpt_123",
    version: "1",
    variables: {
      customer_name: "Acme",
      issue: "billing question",
    },
  },
});

Depois: inclua o prompt diretamente no código

Inclua o prompt diretamente no código
import OpenAI from "openai";

const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: [
    {
      role: "system",
      content:
        "You are a helpful support assistant. Be concise, accurate, and friendly.",
    },
    {
      role: "user",
      content:
        "Customer name: Acme. Issue: billing question. Write a response to the customer.",
    },
  ],
});

console.log(response.output_text);

Use o Codex para migrar

Use o plug-in OpenAI Developers e a habilidade OpenAI Docs para automatizar sua migração e acelerar o desenvolvimento com a API da OpenAI.

$openai-docs update this project to store prompts in code instead of using a prompts object

O que muda

Em vez de referenciar um objeto de prompt salvo em uma requisição à API, armazene o texto do prompt na sua base de código e passe as mensagens geradas diretamente como input na chamada à Responses API.

  • Transfira o conteúdo dos prompts para o código-fonte para que as alterações nos prompts passem pelo mesmo processo de revisão e lançamento que a lógica do produto.
  • Substitua as variáveis dos prompts por argumentos de função para que os valores dinâmicos sejam explícitos e tipados na sua aplicação.
  • Passe as mensagens por meio de input na chamada à Responses API em vez de usar o objeto prompt.
  • Transfira o versionamento para seu repositório usando commits do git, revisão de PRs e testes ou avaliações.
  • Mantenha o conteúdo estático no início e o dinâmico depois para preservar os benefícios do cache de prompts, já que os acertos de cache dependem de correspondências exatas de prefixo.

Exemplo

Crie prompts com uma função auxiliar
import OpenAI from "openai";

const client = new OpenAI();

function buildSupportPrompt({ customerName, issue }) {
  return [
    {
      role: "system",
      content:
        "You are a helpful support assistant. Be concise, accurate, and friendly. Do not invent policy details.",
    },
    {
      role: "user",
      content: `Customer name: ${customerName}. Issue: ${issue}. Write a response to the customer.`,
    },
  ];
}

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: buildSupportPrompt({
    customerName: "Acme",
    issue: "billing question",
  }),
});

O que você ganha

Você ganha mais controle de engenharia: os prompts ficam junto ao código do produto, as alterações passam por PRs, testes e avaliações podem ser executados na CI, e a liberação ou a experimentação podem ser gerenciadas por meio das suas próprias configurações ou sinalizadores de recursos.

Não espalhe prompts diretamente pela base de código. Crie um pequeno módulo prompts/, mantenha cada prompt em uma função de construção nomeada e adicione conjuntos simples de dados para avaliação, para que as alterações nos prompts sejam revisadas como a lógica do produto.