Pular para o conteúdo principal
Última atualização em

Consultar com a API de Respostas da OpenAI

importante

A API de Respostas do OpenAI descrita neste artigo é um pass-through nativo para modelos base de pagamento por token do OpenAI e modelos externos, e suporta o conjunto completo de parâmetros e ferramentas de Respostas do OpenAI. Para uma API de Respostas unificada em todos os modelos abertos do Anthropic Claude, Google Gemini e hospedados pelo Databricks, consulte Consultar um modelo com a API de Respostas Abertas. A API de Conclusão do Chat também está disponível em todos os provedores.

A API OpenAI Responses é uma alternativa à API Chat Completions que fornece recursos adicionais para os modelos OpenAI , incluindo ferramentas personalizadas e fluxo de trabalho em várias etapas.

Requisitos​

Exemplos de consulta​

Os exemplos nesta seção mostram como consultar um endpoint de pagamento por token API do Foundation Model usando a API de Respostas OpenAI .

Para usar a API OpenAI Responses, especifique o nome endpoint do modelo de serviço como a entrada model .

Python
from databricks_openai import DatabricksOpenAI

client = DatabricksOpenAI()

response = client.responses.create(
    model="databricks-gpt-5",
    input=[
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "What is a mixture of experts model?",
      }
    ],
    max_output_tokens=256
)

Ferramentas personalizadas​

Ferramentas personalizadas permitem que o modelo retorne strings arbitrárias em vez de argumentos de função formatados em JSON . Isso é útil para geração de código, aplicação de correções ou outros casos de uso em que JSON estruturado não é necessário.

nota

As ferramentas personalizadas são suportadas apenas com modelos da série GPT-5 (databricks-gpt-5, databricks-gpt-5-1, databricks-gpt-5-2, databricks-gpt-5-4, databricks-gpt-5-5, databricks-gpt-5-5-pro) através da API de Respostas.

Python
from databricks_openai import DatabricksOpenAI

client = DatabricksOpenAI()

response = client.responses.create(
    model="databricks-gpt-5",
    input=[{"role": "user", "content": "Write a Python function to calculate factorial"}],
    tools=[
        {
            "type": "custom",
            "name": "code_exec",
            "description": "Executes arbitrary Python code. Return only valid Python code."
        }
    ],
    max_output_tokens=1024
)

ferramentas integradas​

As ferramentas integradas permitem que o modelo invoque funcionalidades fornecidas pela plataforma sem exigir que você implemente o backend da ferramenta por conta própria. Essas ferramentas retornam resultados estruturados e são totalmente controladas pela plataforma.

Python
from databricks_openai import DatabricksOpenAI

client = DatabricksOpenAI()

response = client.responses.create(
    model="databricks-gpt-5",
    input=[{
        "role": "user",
        "content": "Add input validation to the factorial function in main.py."
    }],
    tools=[
        {
            "type": "apply_patch"
        }
    ],
    max_output_tokens=1024
)

print(response.output_text)

Modelos suportados​

modelos de fundação hospedados no Databricks​

  • databricks-gpt-6-1-sol
  • databricks-gpt-6-sol
  • databricks-gpt-6-luna
  • databricks-gpt-6-astra
  • databricks-gpt-5-6-sol
  • databricks-gpt-5-6-terra
  • databricks-gpt-5-6-luna
  • databricks-gpt-5-5-pro
  • databricks-gpt-5-5
  • databricks-gpt-5-4
  • databricks-gpt-5-4-mini
  • databricks-gpt-5-4-nano
  • databricks-gpt-5-3-codex
  • databricks-gpt-5-2
  • databricks-gpt-5-1
  • databricks-gpt-5
  • databricks-gpt-5-mini
  • databricks-gpt-5-nano

Modelos externos​

  • provedor de modelos da OpenAI
  • provedor de modelos do Azure OpenAI

Tipos de entrada suportados​

Os modelos OpenAI GPT no Databricks aceitam entradas de texto e imagem. Consulte Consultar modelos de visão para ver os requisitos de formato e tamanho de imagem. Para ver os tipos de entrada por modelo, consulte Lista detalhada de modelos compatíveis com as APIs do Foundation Model do Databricks.

Limitações​

As seguintes limitações aplicam-se apenas aos modelos de fundação com pagamento por token . Os modelos externos são compatíveis com todos os parâmetros e ferramentas da API de Respostas.

Os seguintes parâmetros não são suportados e retornam um erro 400 se especificados:

  • background — O processamento em segundo plano não é suportado.
  • store — Respostas armazenadas não são suportadas.
  • previous_response_id — Respostas armazenadas não são suportadas.

O parâmetro service_tier aceita "priority" para incluir uma solicitação no modo de prioridade. Consulte Prioridade de pagamento por tokens para APIs do Foundation Model para ver os modelos e regiões compatíveis. Defina service_tier como "default" para usar explicitamente o produto default de pagamento por token. Omitir service_tier é equivalente a passar "default". Qualquer valor de service_tier diferente de "default" ou "priority" retorna um erro.

Os seguintes tipos de ferramentas são suportados para modelos de fundação de pagamento por tokens:

  • function — Chamada de função estruturada tradicional
  • custom — Ferramentas personalizadas definidas pelo usuário
  • apply_patch — Operações de correção de código
  • shell — execução de comandos do shell
  • image_generation — Geração de imagens
  • mcp — Ferramentas do Protocolo de Contexto do Modelo
  • web_search — Pesquisa na Web

Recursos adicionais​

Nesta página