Skip to main content
Respons yang Kompatibel dengan OpenAI

Mengambil respons

Ambil respons model yang telah selesai berdasarkan ID Respons-nya.

Ganti {WorkspaceId} dengan workspace ID Anda yang sebenarnya.
  • China (Beijing)
base_url untuk panggilan SDK adalah: https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1URL permintaan HTTP: GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/responses/{response_id}

Path parameters

response_idstring(wajib)ID Respons yang akan diambil. Formatnya adalah resp_xxx. Anda dapat memperolehnya dari respons API Create response. Hanya ID Respons yang dikembalikan ketika parameter store=true ditetapkan dalam permintaan pembuatan awal yang dapat diambil.
Python
import os
from openai import OpenAI

client = OpenAI(
    # Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    base_url="https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1",
)

response = client.responses.retrieve("resp_xxx")
print(response)

Response

Mengembalikan objek Response yang sama seperti pada API Create response. Bidang-bidang tersebut dijelaskan di bawah ini:id stringIdentifier unik untuk respons ini, dengan format resp_xxx.object stringJenis objek. Selalu response.status stringStatus respons. Nilai yang mungkin: completed, failed, in_progress, cancelled, queued, incomplete.created_at integerTimestamp Unix (dalam detik) saat respons dibuat.completed_at integerTimestamp Unix (dalam detik) saat respons selesai dihasilkan. null jika respons belum selesai.error objectObjek error yang dikembalikan ketika model gagal menghasilkan respons. null jika berhasil.model stringID model yang digunakan untuk menghasilkan respons.output arrayItem output yang dihasilkan oleh model. Jenis dan urutan elemen tergantung pada respons model.
type stringJenis item output. Nilai yang mungkin:
  • message: Pesan yang berisi balasan akhir dari model.
  • reasoning: Output reasoning. Dikembalikan ketika reasoning.effort diatur ke nilai selain none atau ketika mode thinking diaktifkan. Token reasoning dihitung dalam output_tokens_details.reasoning_tokens dan ditagih sesuai.
  • function_call: Output pemanggilan fungsi. Dikembalikan ketika menggunakan tool function kustom. Anda harus menangani pemanggilan fungsi tersebut dan mengembalikan hasilnya.
  • web_search_call: Output pemanggilan pencarian web. Dikembalikan ketika menggunakan tool web_search.
  • code_interpreter_call: Output eksekusi kode. Dikembalikan ketika menggunakan tool code_interpreter.
  • web_extractor_call: Output ekstraksi web. Dikembalikan ketika menggunakan tool web_extractor. Harus digunakan bersama dengan tool web_search.
  • web_search_image_call: Output pemanggilan pencarian gambar berbasis teks. Dikembalikan ketika menggunakan tool web_search_image. Berisi daftar gambar yang ditemukan.
  • image_search_call: Output pemanggilan pencarian gambar berbasis gambar. Dikembalikan ketika menggunakan tool image_search. Berisi daftar gambar serupa yang ditemukan.
  • mcp_call: Output pemanggilan MCP. Dikembalikan ketika menggunakan tool mcp. Berisi hasil dari layanan MCP.
  • file_search_call: Output pemanggilan pencarian basis pengetahuan. Dikembalikan ketika menggunakan tool file_search. Berisi kueri pengambilan dan hasil dari basis pengetahuan.
id stringIdentifier unik untuk item output. Ada pada semua jenis output.role stringPeran pesan. Selalu assistant. Hanya ada ketika type bernilai message.status stringStatus item output. Nilai yang mungkin: completed, in_progress. Ada ketika type bukan reasoning.name stringNama tool atau fungsi. Ada ketika type bernilai function_call, web_search_image_call, image_search_call, atau mcp_call.Untuk web_search_image_call dan image_search_call, nilainya tetap sebagai "web_search_image" dan "image_search", berturut-turut.Untuk mcp_call, nilainya adalah nama fungsi spesifik yang dipanggil dalam layanan MCP (misalnya, amap-maps-maps_geo).arguments stringArgumen pemanggilan tool, diformat sebagai string JSON. Ada ketika type bernilai function_call, web_search_image_call, image_search_call, atau mcp_call. Uraikan menggunakan JSON.parse() sebelum digunakan. Isinya bervariasi tergantung jenis tool:
  • web_search_image_call: {"queries": ["kata kunci pencarian 1", "kata kunci pencarian 2"]}. Bidang queries berisi daftar kata kunci pencarian yang secara otomatis dihasilkan oleh model berdasarkan input pengguna.
  • image_search_call: {"img_idx": 0, "bbox": [0, 0, 1000, 1000]}. Bidang img_idx adalah indeks gambar input (dimulai dari 0). Bidang bbox berisi koordinat kotak pembatas [x1, y1, x2, y2] area pencarian, dengan nilai berkisar antara 0 hingga 1000.
  • function_call: Objek argumen yang dihasilkan sesuai skema parameter fungsi yang ditentukan pengguna.
  • mcp_call: Objek argumen untuk fungsi yang dipanggil dalam layanan MCP.
call_id stringIdentifier unik untuk pemanggilan fungsi. Hanya ada ketika type bernilai function_call. Gunakan ID ini untuk mengaitkan permintaan dengan respons saat mengembalikan hasil pemanggilan fungsi.content arrayArray konten pesan. Hanya ada ketika type bernilai message.
type stringJenis konten. Selalu output_text.text stringKonten teks yang dihasilkan oleh model.annotations arrayAnotasi teks. Biasanya berupa array kosong.
summary arrayRangkuman reasoning. Hanya ada ketika type bernilai reasoning. Setiap elemen berisi bidang type (nilainya summary_text) dan bidang text (teks rangkuman).action objectInformasi aksi pencarian. Hanya ada ketika type bernilai web_search_call.
query stringKata kunci kueri pencarian.type stringJenis pencarian. Selalu search.sources arraySumber pencarian. Setiap elemen berisi bidang type dan bidang url.
code stringKode yang dihasilkan dan dieksekusi oleh model. Hanya ada ketika type bernilai code_interpreter_call.outputs arrayOutput eksekusi kode. Hanya ada ketika type bernilai code_interpreter_call. Setiap elemen berisi bidang type (nilainya logs) dan bidang logs (log eksekusi kode).container_id stringIdentifier kontainer code interpreter. Hanya ada ketika type bernilai code_interpreter_call. Gunakan untuk mengaitkan beberapa eksekusi kode dalam sesi yang sama.goal stringDeskripsi tujuan ekstraksi, yang menentukan informasi apa yang harus diekstraksi dari halaman web. Hanya ada ketika type bernilai web_extractor_call.output stringHasil output pemanggilan tool, diformat sebagai string.
  • Ketika type bernilai web_extractor_call, bidang ini berisi ringkasan konten halaman web yang diekstraksi.
  • Ketika type bernilai web_search_image_call atau image_search_call, bidang ini adalah string JSON yang berisi array hasil pencarian gambar. Setiap hasil mencakup bidang title (judul gambar), url (URL gambar), dan index (nomor urut).
  • Ketika type bernilai mcp_call, bidang ini adalah string JSON hasil yang dikembalikan oleh layanan MCP.
urls arrayURL halaman web yang diekstraksi. Hanya ada ketika type bernilai web_extractor_call.server_label stringLabel layanan MCP. Hanya ada ketika type bernilai mcp_call. Mengidentifikasi layanan MCP yang digunakan untuk pemanggilan ini.queries arrayKueri yang digunakan untuk pengambilan basis pengetahuan. Hanya ada ketika type bernilai file_search_call. Setiap elemen adalah kueri pencarian yang dihasilkan oleh model.results arrayHasil pengambilan basis pengetahuan. Hanya ada ketika type bernilai file_search_call.
file_id stringID file dokumen yang cocok.filename stringNama file dokumen yang cocok.score floatSkor relevansi, berkisar antara 0 hingga 1. Nilai yang lebih tinggi menunjukkan relevansi yang lebih besar.text stringCuplikan konten dokumen yang cocok.
usage objectInformasi penggunaan token untuk permintaan ini.
input_tokens integerJumlah token input.output_tokens integerJumlah token output yang dihasilkan oleh model.total_tokens integerTotal token yang digunakan (input_tokens + output_tokens).input_tokens_details objectRincian token input.
cached_tokens integerJumlah token yang di-cache.
output_tokens_details objectRincian token output.
reasoning_tokens integerJumlah token reasoning.
x_details arrayRincian penagihan.
input_tokens integerToken input untuk jenis penagihan ini.output_tokens integerToken output untuk jenis penagihan ini.total_tokens integerTotal token untuk jenis penagihan ini.x_billing_type stringSelalu response_api.prompt_tokens_details objectDikembalikan ketika caching sesi diaktifkan. Berisi bidang cached_tokens (jumlah token yang di-cache).
x_tools objectStatistik penggunaan tool. Ketika tool bawaan digunakan, bidang ini berisi jumlah pemanggilan untuk setiap tool. Contoh: {"web_search": {"count": 1}}
tools arrayMencerminkan parameter tools dari permintaan pembuatan. Strukturnya sesuai dengan parameter tools dalam badan permintaan. Array kosong [] jika tidak ada tool yang digunakan.tool_choice stringMencerminkan parameter tool_choice dari permintaan pembuatan. Nilai yang mungkin: auto, none, required.parallel_tool_calls booleanMencerminkan parameter parallel_tool_calls dari permintaan pembuatan. Menunjukkan apakah model dapat memanggil beberapa tool secara paralel.temperature floatMencerminkan parameter temperature dari permintaan pembuatan. Mengontrol keragaman output model. Rentang valid: [0, 2). Mengembalikan nilai default model jika tidak diatur.top_p floatMencerminkan parameter top_p dari permintaan pembuatan. Ambang batas probabilitas sampling nucleus. Rentang valid: (0, 1.0]. Mengembalikan nilai default model jika tidak diatur.frequency_penalty floatMencerminkan parameter frequency_penalty dari permintaan pembuatan. Nilai positif mengurangi kemungkinan pengulangan kata.presence_penalty floatMencerminkan parameter presence_penalty dari permintaan pembuatan. Nilai positif meningkatkan kemungkinan pengenalan topik baru.top_logprobs integerMencerminkan parameter top_logprobs dari permintaan pembuatan. Jumlah token paling mungkin yang dikembalikan pada setiap posisi. 0 jika tidak diaktifkan.store booleanMencerminkan parameter store dari permintaan pembuatan. true berarti respons disimpan dan dapat dirujuk oleh previous_response_id. false berarti tidak disimpan.service_tier stringTingkat layanan. Selalu default.background booleanApakah respons dieksekusi secara asinkron. Model Studio saat ini hanya mendukung panggilan sinkron, sehingga nilai ini selalu false.metadata objectMencerminkan parameter metadata dari permintaan pembuatan. Pasangan kunci-nilai kustom yang dilampirkan pada respons. Objek kosong {} jika tidak diatur.
{
    "background": false,
    "completed_at": 1778676420,
    "created_at": 1778676418,
    "frequency_penalty": 0.0,
    "id": "resp_801bc2c4-93d9-910f-b35d-5274f5a737c1",
    "metadata": {},
    "model": "qwen-plus",
    "object": "response",
    "output": [
        {
            "content": [
                {
                    "annotations": [],
                    "text": "Hello! Nice to meet you. How can I help you?",
                    "type": "output_text"
                }
            ],
            "id": "msg_8c54756c-9b65-4a95-81d7-4276d91406db",
            "role": "assistant",
            "status": "completed",
            "type": "message"
        }
    ],
    "parallel_tool_calls": true,
    "presence_penalty": 0.0,
    "service_tier": "default",
    "status": "completed",
    "store": true,
    "temperature": 1.0,
    "tool_choice": "auto",
    "tools": [],
    "top_logprobs": 0,
    "top_p": 1.0,
    "usage": {
        "input_tokens": 45,
        "input_tokens_details": {
            "cached_tokens": 0
        },
        "output_tokens": 63,
        "output_tokens_details": {
            "reasoning_tokens": 0
        },
        "total_tokens": 108,
        "x_details": [
            {
                "input_tokens": 45,
                "output_tokens": 63,
                "prompt_tokens_details": {
                    "cached_tokens": 0
                },
                "total_tokens": 108,
                "x_billing_type": "response_api"
            }
        ]
    }
}

Error response

Dikembalikan ketika ID Respons yang ditentukan tidak ada: 
{
    "error": {
        "message": "Response with id 'resp_xxx' not found.",
        "type": "InvalidParameter"
    }
}
Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
  • Pembuatan audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model