Kueri dengan API Respons OpenAI

Penting

API OpenAI Responses yang dijelaskan dalam artikel ini adalah passthrough native untuk model fondasi OpenAI bayar per token dan model eksternal, serta mendukung rangkaian lengkap parameter dan alat OpenAI Responses. Untuk API Respons terpadu di seluruh model terbuka yang dihosting Anthropic Claude, Google Gemini, dan Databricks, lihat Mengkueri model dengan OPEN Responses API. API Penyelesaian Obrolan juga tersedia di semua penyedia.

OPENAI Responses API adalah alternatif untuk API Penyelesaian Obrolan yang menyediakan fitur tambahan untuk model OpenAI, termasuk alat kustom dan alur kerja multi-langkah.

Persyaratan

Contoh kueri

Contoh di bagian ini menunjukkan cara mengkueri endpoint "pay-per-token" API Model Dasar menggunakan OpenAI Responses API.

Python

Untuk menggunakan OpenAI Responses API, tentukan nama titik akhir model sebagai input model. Contoh berikut mengasumsikan Anda memiliki token API Azure Databricks dan openai yang terinstal pada komputasi Anda. Anda juga memerlukan instans ruang kerja Azure Databricks untuk menghubungkan klien OpenAI ke Azure Databricks.

import os
import openai
from openai import OpenAI

client = OpenAI(
    api_key="dapi-your-databricks-token",
    base_url="https://example.staging.cloud.databricks.com/serving-endpoints"
)

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
)

REST API

curl \
-u token:$DATABRICKS_TOKEN \
-X POST \
-H "Content-Type: application/json" \
-d '{
  "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
}' \
https://<workspace_host>.databricks.com/serving-endpoints/responses

Alat kustom

Alat kustom memungkinkan model mengembalikan output string arbitrer alih-alih argumen fungsi berformat JSON. Ini berguna untuk pembuatan kode, menerapkan patch, atau kasus penggunaan lainnya di mana JSON terstruktur tidak diperlukan.

Nota

Alat kustom hanya didukung dengan model seri GPT-5 (databricks-gpt-5, , databricks-gpt-5-1, databricks-gpt-5-2databricks-gpt-5-4, databricks-gpt-5-5, databricks-gpt-5-5-pro) melalui API Respons.

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
)

Perangkat bawaan

Alat bawaan memungkinkan model untuk memanggil kemampuan yang disediakan platform tanpa mengharuskan Anda untuk mengimplementasikan backend alat sendiri. Alat-alat ini mengembalikan output terstruktur dan dikelola sepenuhnya oleh platform.

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)

Model yang didukung

Model eksternal

  • Penyedia model OpenAI
  • Penyedia model Azure OpenAI

Jenis input yang didukung

Model OpenAI GPT pada Azure Databricks menerima input teks dan gambar. Lihat Model pengenalan kueri untuk format gambar dan persyaratan ukuran. Untuk jenis input per model, lihat Model fondasi yang dihosting Databricks yang tersedia di API Model Foundation.

Keterbatasan

Batasan berikut hanya berlaku untuk model fondasi bayar per token . Model eksternal mendukung semua parameter dan alat API Respons.

Parameter berikut tidak didukung dan mengembalikan kesalahan 400 jika ditentukan:

  • background — Pemrosesan latar belakang tidak didukung.
  • store — Respons tersimpan tidak didukung.
  • previous_response_id — Respons tersimpan tidak didukung.

Parameter service_tier menerima "priority" untuk memilih permintaan ke mode prioritas. Lihat Prioritas bayar per token untuk API Model Foundation untuk model dan wilayah yang didukung. Atur service_tier ke "default" untuk secara eksplisit menggunakan produk bayar per token default. Menghilangkan service_tier setara dengan meneruskan "default". Nilai apa pun service_tier selain "default" atau "priority" mengembalikan kesalahan.

Jenis alat berikut didukung untuk model fondasi bayar per token:

  • function — Pemanggilan fungsi terstruktur tradisional
  • custom — Alat kustom yang ditentukan pengguna
  • apply_patch — Operasi patching kode
  • shell — Eksekusi perintah Shell
  • image_generation — Pembuatan gambar
  • mcp — Alat Protokol Konteks Model
  • web_search — Pencarian web

Sumber daya tambahan

  • Last updated on