OCIレスポンスAPI

レスポンスAPIを、OCI生成AIの次のエージェント構築コンポーネントとともに使用します。

必要に応じて、レスポンスAPIで低レベルの基本構成要素を使用できます。

レスポンスAPIを使用して、次のことを行います。

• サポートされるホスト・モデルおよびインポートされたモデルをコールします。
• テキストおよびイメージ入力を送信し、テキスト出力を受信します。
• テキストまたは構造化された出力を生成します。
• シングルステップ・プロンプトまたはマルチステップ・ワークフローを実行します。
• リクエストにサポートされているツールを追加します。
• クライアントへのレスポンスをストリーミングします。
• 会話APIを介してOCI管理の会話状態を使用します。
• 会話履歴または以前の出力を後のリクエストのコンテキストとして再利用します。
• 関数呼び出しとMCP呼び出しを使用して、モデルを外部システムおよびデータに接続します。
• 必要に応じて、モデル・リクエストをファイル、ベクトル・ストアまたはコンテナと組み合せます。

これにより、単純なプロンプトから開始して、別のAPIに切り替えることなく、より高度なワークフローに拡張できます。

ほとんどの新しいアプリケーションでは、Responses APIから開始します。

次の場合に使用します。

• モデル・インタラクションおよびエージェント機能に1つのAPIを使用します。
• サポートされているツールをモデル・リクエストに追加します。
• OCI管理の会話履歴を使用します。
• 構造化出力を生成します。
• 必要に応じてファイル、ベクトル・ストアまたはコンテナを使用できるワークフローを構築します。

${region}を、us-chicago-1などのサポートされているOCIリージョンに置き換えます。

リクエスト形式はOpenAIと互換性がありますが、認証ではOCI資格証明が使用され、リクエストはOCI生成AI推論エンドポイントを介してルーティングされ、リソースと実行はOCIに残ります。

OCI OpenAI互換エンドポイントには、次の2つの方法でアクセスできます。

• OCI生成AI APIキー
• OCI IAMベースの認証

テストおよび早期開発にAPIキーを使用します。本番ワークロードおよびOCI管理環境には、IAMベースの認証を使用します。

Responses APIをコールする前に:

• OCI生成AIプロジェクトを作成します。OCI OpenAI互換APIコールにはプロジェクトが必要です。
• OCI OpenAI互換のベースURLを使用してクライアントを設定します。
• 認証を設定します。
• サポートされているリージョンで、サポートされているモデルを使用します。

設定ステップは、「クイックスタート」、「認証」および「サポートされているモデルとリージョン」を参照してください。

コードからレスポンスAPIをコールするには、OpenAI SDKを使用することをお薦めします。QuickStartを参照してください。

次の例では、OCI OpenAI互換エンドポイント、OCI Generative AI APIキーおよびプロジェクトOCIDとともにOpenAI SDKを使用します。

from openai import OpenAI

client = OpenAI(
    base_url="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1",
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    project="ocid1.generativeaiproject.oc1.us-chicago-1.xxxxxxxx",
)

response = client.responses.create(
    model="<supported-model-id>",
    input="Write a one-sentence explanation of what a database is."
)

print(response.output_text)

この例では、以下のようになります。

• base_urlは、OCI OpenAI互換エンドポイントを指します。
• client.responses.create(...)は、OCIレスポンスAPIをコールします。
• projectは、リクエストのOCI生成AIプロジェクトを識別します。

OCIでマルチターンの会話履歴を管理するには、まず会話を作成します:

conversation = client.conversations.create()

次に、Responses APIリクエストに会話IDを含めます。

response = client.responses.create(
  model="<supported-model-id>",
  input=[
        {
            "role": "user",
            "content": "Recommend a restaurant based on the food I like."
        }
    ],
    conversation=conversation.id,
)

このパターンは、OCIでリクエスト間の会話状態を管理する場合に使用します。

メモリー機能の詳細は、Conversations API、Short-Term Memory、Long-Term Memory、および Short-Term Memory Compactionを参照してください。

レスポンスAPIでは、toolsプロパティを介してツール対応のワークフローがサポートされます。多くのユース・ケースでは、リクエストでツールを宣言し、OCI Generative AIでモデルの実行とツールの使用を調整できます。

ツール・サポートは、APIでのみ使用可能です。

次の例では、リクエスト内のMCPツールを定義します。

response = client.responses.create(
    model="openai.gpt-oss-120b",
    tools=[
        {
            "type": "mcp",
            "server_url": "https://example.com/mcp",
        }
    ],
    input="What events are scheduled for 2026-04-02?"
)

この例では、Responses APIがモデルを起動し、MCPツール定義を同じリクエストの一部として渡します。個別のMCP固有のAPIは必要ありません。

ワークフローでファイル、ベクトル・ストアまたはコンテナを直接制御する必要がある場合は、レスポンスAPIで低レベルの基礎エージェント・ビルディング・ブロックを使用できます。

よくある例は次のとおりです。

• モデル要求を送信する前のファイルのアップロード
• ベクトル・ストアの内容を直接管理する
• 複数のリクエストにわたるファイルまたはリソースの再利用
• より広範なワークフローの一部としてサンドボックス・コンテナを操作する

次のAPIは、レスポンスAPIで一般的に使用されます。

file_response = client.files.create(
    file=open("example-document.pdf", "rb"),
    purpose="assistants"
)

file_id = file_response.id

response = client.responses.create(
    model="<model-id>",
    input=[
        {
            "role": "user",
            "content": [
                { "type": "input_file", "file_id": file_id },
                { "type": "input_text", "text": "List all the cities mentioned in this document." }
            ]
        }
    ]
)

OCIレスポンスAPIは、OpenAI SDKとともに使用できます。また、互換性のあるクライアント側エージェント・フレームワークとともに使用することもできます。

OpenAI SDKは、次の言語をサポートしています。

• Python
• Java
• TypeScript
• 移動
• .NET

コミュニティ・ライブラリを通じて、より多くの言語サポートを利用できます。

互換性のあるエージェント・フレームワークは次のとおりです。

• OpenAI Agents SDK(推奨)
• OpenAI Codex SDK
• Microsoft Agentフレームワーク
• ラングチェーン
• ランググラフ
• クルーイ
• 自動作成
• ログイン
• ピダンティック

• 会話API
• レスポンスAPIツール
  • ファイル検索
  • コードインタプリタ
  • 関数呼び出し
  • MCPコール
• ファイルAPI
• ベクトル・ストアAPI
• コンテナAPI
• 認証
  • OCI生成AI APIキー
  • OCI IAMベースの認証
• サポートされているモデルおよびリージョン
• クイック・スタート