Note
.NETの OpenAI 応答エンドポイントのセルフホスティング ヘルパーは近日公開予定です。
Note
OpenAI 応答エンドポイントのセルフホスティング ヘルパーは、現在 Go では使用できません。
agent-framework-hosting-responsesを使用して、アプリケーションが所有するエンドポイントで OpenAI 応答形式の要求と応答を変換します。 サーバーは、Web フレームワーク、ルート、認証、承認、要求オプション、およびセッション ストレージを選択します。
pip install --pre agent-framework agent-framework-foundry agent-framework-hosting agent-framework-hosting-responses azure-identity
FastAPI サンプルは 1 つの実装です。 同じヘルパーは、Django、Flask、Starlette、Azure Functions、またはその他のフレームワークで動作します。
エージェント エンドポイントをホストする
このサンプルでは、要求を Agent Framework の実行値に変換し、アプリケーション定義のオプション許可リストを適用し、新しく作成された応答 ID の下に更新されたセッションを保持します。
app = FastAPI()
state = AgentState(create_agent)
ALLOWED_REQUEST_OPTIONS = frozenset({"max_tokens", "reasoning"})
@app.post("/responses", response_model=None)
async def responses(body: dict[str, Any] = Body(...)) -> JSONResponse | StreamingResponse: # noqa: B008
"""Handle one OpenAI Responses-shaped request."""
try:
run = responses_to_run(body)
except ValueError as exc:
raise HTTPException(status_code=400, detail=str(exc)) from exc
session_id, is_conversation_id = responses_session_id(body)
conversation_id = session_id if is_conversation_id else None
response_id = create_response_id()
# App-specific policy: allow only the request options this route is willing
# to honor. This denies tools, tool_choice, deployment/persistence fields,
# and all other caller-supplied options by default. Your app decides which
# options are allowed, altered, or denied.
options = {key: value for key, value in run["options"].items() if key in ALLOWED_REQUEST_OPTIONS}
options["reasoning"] = {"effort": "medium", "summary": "auto"}
options_for_run = cast(Any, options)
target = await state.get_target()
lookup_id = session_id or response_id
# An unknown `conversation_id` becomes a new session here. Production apps
# can choose to require a separate "create conversation" API instead.
session = await state.get_or_create_session(lookup_id)
if run["stream"]:
stream = target.run(
run["messages"],
stream=True,
session=session,
options=options_for_run,
)
if not isinstance(stream, ResponseStream):
raise HTTPException(status_code=500, detail="agent did not return a response stream")
async def stream_events() -> AsyncIterator[str]:
async for event in responses_from_streaming_run(
stream,
response_id=response_id,
conversation_id=conversation_id,
):
yield event
# `agent.run(..., stream=True)` updates the session while the stream
# is consumed/finalized. Persist the selected continuation only
# after finalization.
if conversation_id is not None:
# A stable conversation id is a mutable head. Apps must ensure
# only one caller advances it at a time; AgentState does not
# serialize concurrent runs for the same id.
await state.set_session(conversation_id, session)
else:
await state.set_session(response_id, session)
return StreamingResponse(
stream_events(),
media_type="text/event-stream",
)
result = await target.run(
run["messages"],
session=session,
options=options_for_run,
)
# `agent.run(...)` updates the session. Persist the selected continuation
# only after the run completes.
if conversation_id is not None:
# Preserve sequential conversation continuity. Production apps must
# provide their own per-conversation single-writer coordination.
AgentState はターゲットを解決し、セッションを読み込むか作成します。 実行によってセッションが更新されるため、実行後、またはストリーミング実行の完了後にセッションを保存してください。
エージェント定義や要求オプションの許可リストなど、完全なアプリケーションについては、 ローカル応答のサンプルを参照してください。
ワークフロー エンドポイントをホストする
WorkflowState はワークフローを解決しますが、アプリケーションはチェックポイント ストレージと応答 ID からチェックポイントへのマッピングを所有しています。 このサンプルでは、承認された previous_response_idによって選択されたチェックポイントを復元し、次の応答のためにカーソルを保存します。
app = FastAPI()
state = WorkflowState(workflow_builder, cache_target=False)
@app.post("/responses", response_model=None)
async def responses(body: dict[str, Any] = Body(...)) -> JSONResponse: # noqa: B008
"""Handle one OpenAI Responses-shaped request for the workflow."""
try:
run = responses_to_run(body)
except ValueError as exc:
raise HTTPException(status_code=400, detail=str(exc)) from exc
# This sample demonstrates only Responses `previous_response_id`
# continuation, so reject `conversation_id` instead of treating it as a
# checkpoint cursor.
previous_response_id, is_conversation_id = responses_session_id(body)
if is_conversation_id:
raise HTTPException(
status_code=400,
detail="This server supports previous_response_id continuation only; conversation_id is not implemented.",
)
response_id = create_response_id()
target = await state.get_target()
if previous_response_id and (checkpoint_cursor := checkpoint_cursor_store.get(previous_response_id)) is not None:
# Restore first. Workflow.run does not allow `message` and
# `checkpoint_id` in the same call.
await target.run(
checkpoint_id=checkpoint_cursor["checkpoint_id"],
checkpoint_storage=checkpoint_storage_for(checkpoint_cursor["storage_id"]),
)
storage_id = response_id
checkpoint_storage = checkpoint_storage_for(storage_id)
result = await target.run(
message=workflow_prompt_from_messages(run["messages"]),
checkpoint_storage=checkpoint_storage,
)
latest = await checkpoint_storage.get_latest(workflow_name=target.name)
if latest is not None:
# Responses `previous_response_id` can point to any response id. Store
# the current response id as the cursor for this workflow continuation.
cursor = CheckpointCursor(checkpoint_id=latest.checkpoint_id, storage_id=storage_id)
checkpoint_cursor_store.set_many({response_id: cursor})
return JSONResponse(
responses_from_run(
response_from_workflow_result(result),
response_id=response_id,
)
)
サンプルのファイルベースのストレージは、ローカル開発用です。 レプリカを再起動またはスケールアウトできる場合は、永続ストレージを使用します。
Important
previous_response_idとconversation_idを信頼されていない入力として扱います。 ID を使用してセッションまたはチェックポイントを読み込んだり保存したりする前に、呼び出し元を認証して承認します。
より広範なワイヤ形式については、「 OpenAI と互換性のあるエンドポイント」を参照してください。
次のステップ
より深く進む: