Responses API (推奨)
モデル応答を作成します。テキストと画像の入力をサポートし、テキストまたはJSON出力を生成します。Function Calling（ツールコール）、ストリーミングレスポンス、マルチターン対話に対応しています。
新規プロジェクトにはResponses APIを推奨します。 これはOpenAIが提供する新世代APIで、Chat Completionsと比較して以下の利点があります：
- ネイティブPrompt Caching —
instructionsとinputが分離されており、システム指示が自動的にキャッシュプレフィックスとなります。マルチターン対話で変化しないプレフィックス部分はキャッシュヒット率が高く、最大50%の入力トークン費用を節約しながらレイテンシも低減できます - 構造化されたitemモデル — 入出力フォーマットが明確で、ツールコールフローをネイティブにサポート
- より豊富なストリーミングイベント — 細粒度のSSEイベントタイプにより、リアルタイムUIレンダリングが容易
エンドポイント
POST https://api.ofox.io/v1/responsesリクエストパラメータ
Input形式
inputは2つの形式をサポートします：
1. 単純な文字列 — テキストを直接渡す
{
"input": "こんにちは、自己紹介をお願いします"
}2. 構造化メッセージ配列 — マルチターン対話とマルチモーダル入力
interface InputItem {
type: 'message'
role: 'user' | 'assistant'
content: ContentPart[]
id?: string // assistantメッセージでは必須
status?: 'completed' // assistantメッセージでは必須
}
type ContentPart =
| { type: 'input_text'; text: string } // ユーザーのテキスト入力
| { type: 'input_image'; image_url: string } // 画像入力
| { type: 'output_text'; text: string; annotations?: any[] } // アシスタントのテキスト出力マルチターン対話でassistantロールのメッセージを含める場合、idとstatusフィールドは必須です。
Responses APIはステートレス設計であり、各リクエストで完全な対話履歴を渡す必要があります。
リクエスト例
cURL
Terminal
curl https://api.ofox.io/v1/responses \
-H "Authorization: Bearer $OFOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "openai/gpt-6.1-sol",
"input": "API Gatewayとは何か説明してください",
"instructions": "あなたは親切な技術アシスタントです。日本語で回答してください。",
"max_output_tokens": 1024
}'レスポンス形式
{
"id": "resp_abc123",
"object": "response",
"created_at": 1703123456,
"model": "openai/gpt-6.1-sol",
"status": "completed",
"output": [
{
"type": "message",
"id": "msg_def456",
"status": "completed",
"role": "assistant",
"content": [
{
"type": "output_text",
"text": "API Gateway（APIゲートウェイ）とは...",
"annotations": []
}
]
}
],
"usage": {
"input_tokens": 25,
"output_tokens": 150,
"total_tokens": 175
}
}レスポンスフィールド説明
構造化メッセージ入力
構造化メッセージ配列を使用してマルチターン対話を実装します：
Python
multi_turn.py
response = client.responses.create(
model="openai/gpt-6.1-sol",
input=[
{
"type": "message",
"role": "user",
"content": [
{"type": "input_text", "text": "フランスの首都はどこですか？"}
]
},
{
"type": "message",
"role": "assistant",
"id": "msg_abc123",
"status": "completed",
"content": [
{"type": "output_text", "text": "フランスの首都はパリです。", "annotations": []}
]
},
{
"type": "message",
"role": "user",
"content": [
{"type": "input_text", "text": "そこには何人住んでいますか？"}
]
}
]
)
print(response.output_text)ストリーミングレスポンス
stream: true を設定してSSEストリーミングレスポンスを有効にします：
Python
stream.py
stream = client.responses.create(
model="openai/gpt-6.1-sol",
input="プログラミングに関するジョークを教えてください",
stream=True
)
for event in stream:
if event.type == "response.output_text.delta":
print(event.delta, end="", flush=True)ストリーミングイベントタイプ
ストリーミングレスポンスはSSE経由で以下のイベントを送信します：
data: {"type":"response.created","response":{"id":"resp_abc123","object":"response","status":"in_progress"}}
data: {"type":"response.output_item.added","output_index":0,"item":{"type":"message","id":"msg_def456","role":"assistant","status":"in_progress","content":[]}}
data: {"type":"response.content_part.added","output_index":0,"content_index":0,"part":{"type":"output_text","text":""}}
data: {"type":"response.output_text.delta","output_index":0,"content_index":0,"delta":"こん"}
data: {"type":"response.output_text.delta","output_index":0,"content_index":0,"delta":"にちは"}
data: {"type":"response.output_item.done","output_index":0,"item":{"type":"message","id":"msg_def456","role":"assistant","status":"completed","content":[{"type":"output_text","text":"こんにちは..."}]}}
data: {"type":"response.completed","response":{"id":"resp_abc123","object":"response","status":"completed","usage":{"input_tokens":12,"output_tokens":45,"total_tokens":57}}}
data: [DONE]Function Calling
Responses APIはツールコールをネイティブにサポートします：
Python
tools.py
response = client.responses.create(
model="openai/gpt-6.1-sol",
input="東京の今日の天気はどうですか？",
tools=[
{
"type": "function",
"name": "get_weather",
"description": "指定された都市の現在の天気を取得する",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "都市名（例：東京）"
},
"unit": {
"type": "string",
"enum": ["celsius", "fahrenheit"]
}
},
"required": ["location"]
}
}
],
tool_choice="auto"
)
# ツールコールを処理
for item in response.output:
if item.type == "function_call":
print(f"関数呼び出し: {item.name}")
print(f"引数: {item.arguments}")ツールコールのレスポンス形式
モデルがツールを呼び出すと、outputにfunction_callタイプのitemが含まれます：
{
"id": "resp_abc123",
"object": "response",
"status": "completed",
"output": [
{
"type": "function_call",
"id": "fc_abc123",
"call_id": "call_xyz789",
"name": "get_weather",
"arguments": "{\"location\":\"東京\",\"unit\":\"celsius\"}"
}
],
"usage": {
"input_tokens": 45,
"output_tokens": 25,
"total_tokens": 70
}
}ツール実行結果の送信
ツールの実行結果をモデルに返す際は、inputに完全な呼び出しチェーンを含めます：
# 2回目のリクエスト：ツール実行結果を送信
response = client.responses.create(
model="openai/gpt-6.1-sol",
input=[
{
"type": "message",
"role": "user",
"content": [{"type": "input_text", "text": "東京の今日の天気はどうですか？"}]
},
{
"type": "function_call",
"id": "fc_abc123",
"call_id": "call_xyz789",
"name": "get_weather",
"arguments": "{\"location\":\"東京\",\"unit\":\"celsius\"}"
},
{
"type": "function_call_output",
"id": "fco_abc123",
"call_id": "call_xyz789",
"output": "{\"temperature\":\"22°C\",\"condition\":\"晴れ\"}"
}
]
)
print(response.output_text)
# => "東京の今日は晴れで、気温は22°Cです。屋外活動に最適です。"Tool Choiceオプション
Chat Completionsとの比較
両APIとも本番環境で利用可能です。既にChat Completionsで構築済みの場合、移行する必要はありません。 新規プロジェクトにはResponses APIを推奨します。特に複雑なツールコールフローが必要な場合や、高頻度の呼び出し（キャッシュを十分活用してコスト削減が可能）が想定される場合に有利です。 詳細はファンクションコーリングガイドをご覧ください。
最終更新日