セッション
Agents SDK には、複数回のエージェント実行にわたって会話履歴を自動的に維持する組み込みのセッションメモリが用意されているため、ターン間で .to_input_list() を手動で処理する必要がありません。
セッションは特定のセッションの会話履歴を保存し、明示的な手動メモリ管理を必要とせずに、エージェントがコンテキストを維持できるようにします。これは、エージェントに以前のやり取りを記憶させたいチャットアプリケーションや複数ターンの会話を構築する場合に特に便利です。
SDK にクライアント側のメモリを管理させたい場合は、セッションを使用してください。同じ実行内で、セッションを conversation_id、previous_response_id、または auto_previous_response_id と組み合わせることはできません。代わりに OpenAI サーバーが管理する継続機能を使用する場合は、セッションと重ねて使用せず、これらのメカニズムのいずれかを選択してください。
クイックスタート
from agents import Agent, Runner, SQLiteSession
# Create agent
agent = Agent(
name="Assistant",
instructions="Reply very concisely.",
)
# Create a session instance with a session ID
session = SQLiteSession("conversation_123")
# First turn
result = await Runner.run(
agent,
"What city is the Golden Gate Bridge in?",
session=session
)
print(result.final_output) # "San Francisco"
# Second turn - agent automatically remembers previous context
result = await Runner.run(
agent,
"What state is it in?",
session=session
)
print(result.final_output) # "California"
# Also works with synchronous runner
result = Runner.run_sync(
agent,
"What's the population?",
session=session
)
print(result.final_output) # "Approximately 39 million"
同じセッションによる中断された実行の再開
承認待ちで実行が一時停止した場合は、再開されたターンが同じ保存済み会話履歴を継続できるように、同じセッションインスタンス、または同じバッキングストアを指す別のセッションインスタンスを使用して再開してください。
result = await Runner.run(agent, "Delete temporary files that are no longer needed.", session=session)
if result.interruptions:
state = result.to_state()
for interruption in result.interruptions:
state.approve(interruption)
result = await Runner.run(agent, state, session=session)
セッションの基本動作
セッションメモリが有効な場合、次のように動作します。
- 各実行の前: Runner はセッションの会話履歴を自動的に取得し、入力項目の先頭に追加します。
- 各実行の後: 実行中に生成されたすべての新しい項目(ユーザー入力、アシスタントの応答、ツール呼び出しなど)が、セッションに自動的に保存されます。
- コンテキストの保持: 同じセッションを使用する後続の各実行には完全な会話履歴が含まれるため、エージェントはコンテキストを維持できます。
これにより、.to_input_list() を手動で呼び出し、実行間の会話状態を管理する必要がなくなります。
履歴と新規入力のマージ制御
セッションを渡すと、Runner は通常、モデル入力を次の順序で準備します。
- セッション履歴(
session.get_items(...)から取得) - 新しいターンの入力
モデルを呼び出す前のこのマージ処理をカスタマイズするには、RunConfig.session_input_callback を使用します。コールバックは次の 2 つのリストを受け取ります。
history: 取得したセッション履歴(入力項目形式に正規化済み)new_input: 現在のターンの新しい入力項目
モデルに送信する最終的な入力項目のリストを返してください。
コールバックは両方のリストのコピーを受け取るため、安全に変更できます。返されたリストはそのターンのモデル入力を制御しますが、SDK が永続化するのは新しいターンに属する項目のみです。そのため、古い履歴を並べ替えたりフィルタリングしたりしても、古いセッション項目が新しい入力として再度保存されることはありません。
from agents import Agent, RunConfig, Runner, SQLiteSession
def keep_recent_history(history, new_input):
# Keep only the last 10 history items, then append the new turn.
return history[-10:] + new_input
agent = Agent(name="Assistant")
session = SQLiteSession("conversation_123")
result = await Runner.run(
agent,
"Continue from the latest updates only.",
session=session,
run_config=RunConfig(session_input_callback=keep_recent_history),
)
セッションが項目を保存する方法を変更せずに、履歴の独自の枝刈り、並べ替え、または選択的な追加が必要な場合に使用します。モデル呼び出しの直前に最終処理が必要な場合は、エージェント実行ガイドの call_model_input_filter を使用してください。
取得する履歴の制限
各実行前に取得する履歴の量を制御するには、SessionSettings を使用します。
SessionSettings(limit=None)(デフォルト): 利用可能なすべてのセッション項目を取得しますSessionSettings(limit=N): 最新のN項目のみを取得します
これは、RunConfig.session_settings を使用して実行ごとに適用できます。
from agents import Agent, RunConfig, Runner, SessionSettings, SQLiteSession
agent = Agent(name="Assistant")
session = SQLiteSession("conversation_123")
result = await Runner.run(
agent,
"Summarize our recent discussion.",
session=session,
run_config=RunConfig(session_settings=SessionSettings(limit=50)),
)
セッション実装がデフォルトのセッション設定を公開している場合、RunConfig.session_settings はその実行について、None 以外の値を上書きします。これは、セッションのデフォルト動作を変更せずに取得件数を制限したい長い会話で役立ちます。
メモリ操作
基本操作
セッションでは、会話履歴を管理するための複数の操作を使用できます。
from agents import SQLiteSession
session = SQLiteSession("user_123", "conversations.db")
# Get all items in a session
items = await session.get_items()
# Add new items to a session
new_items = [
{"role": "user", "content": "Hello"},
{"role": "assistant", "content": "Hi there!"}
]
await session.add_items(new_items)
# Remove and return the most recent item
last_item = await session.pop_item()
print(last_item) # {"role": "assistant", "content": "Hi there!"}
# Clear all items from a session
await session.clear_session()
修正での pop_item の使用
pop_item メソッドは、会話の最後の項目を取り消したり変更したりする場合に特に便利です。
from agents import Agent, Runner, SQLiteSession
agent = Agent(name="Assistant")
session = SQLiteSession("correction_example")
# Initial conversation
result = await Runner.run(
agent,
"What's 2 + 2?",
session=session
)
print(f"Agent: {result.final_output}")
# User wants to correct their question
assistant_item = await session.pop_item() # Remove agent's response
user_item = await session.pop_item() # Remove user's question
# Ask a corrected question
result = await Runner.run(
agent,
"What's 2 + 3?",
session=session
)
print(f"Agent: {result.final_output}")
組み込みセッション実装
SDK には、さまざまなユースケースに対応する複数のセッション実装が用意されています。
組み込みセッション実装の選択
以下の詳細な例を読む前に、この表を使用して開始点を選択してください。
| セッションタイプ | 最適な用途 | 備考 |
|---|---|---|
SQLiteSession |
ローカル開発とシンプルなアプリ | 組み込みで軽量、ファイルベースまたはインメモリ |
AsyncSQLiteSession |
aiosqlite を使用する非同期 SQLite |
非同期ドライバーをサポートする拡張バックエンド |
RedisSession |
ワーカーやサービス間での共有メモリ | 低レイテンシーの分散デプロイに適しています |
SQLAlchemySession |
既存のデータベースを使用する本番アプリ | SQLAlchemy がサポートするデータベースで動作します |
MongoDBSession |
MongoDB をすでに使用しているアプリ、またはマルチプロセスストレージが必要なアプリ | 非同期 pymongo。順序付け用のアトミックなシーケンスカウンター |
DaprSession |
Dapr サイドカーを使用するクラウドネイティブなデプロイ | 複数のステートストアに加え、TTL と整合性制御をサポートします |
OpenAIConversationsSession |
OpenAI でのサーバー管理ストレージ | OpenAI Conversations API を利用した履歴 |
OpenAIResponsesCompactionSession |
自動コンパクションを使用する長い会話 | 別のセッションバックエンドをラップします |
AdvancedSQLiteSession |
SQLite に加えて分岐や分析が必要な場合 | より多機能です。専用ページを参照してください |
EncryptedSession |
別のセッションに暗号化と TTL を追加する場合 | ラッパーです。まず基盤となるバックエンドを選択してください |
一部の実装には追加の詳細を説明する専用ページがあり、それぞれのサブセクション内にリンクがあります。
ChatKit 用の Python サーバーを実装する場合は、ChatKit のスレッドと項目の永続化に chatkit.store.Store 実装を使用してください。SQLAlchemySession などの Agents SDK セッションは SDK 側の会話履歴を管理しますが、ChatKit のストアをそのまま置き換えることはできません。ChatKit データストアの実装に関する chatkit-python ガイドを参照してください。
OpenAI Conversations API セッション
OpenAIConversationsSession を通じて、OpenAI の Conversations APIを使用します。
from agents import Agent, Runner, OpenAIConversationsSession
# Create agent
agent = Agent(
name="Assistant",
instructions="Reply very concisely.",
)
# Create a new conversation
session = OpenAIConversationsSession()
# Optionally resume a previous conversation by passing a conversation ID
# session = OpenAIConversationsSession(conversation_id="conv_123")
# Start conversation
result = await Runner.run(
agent,
"What city is the Golden Gate Bridge in?",
session=session
)
print(result.final_output) # "San Francisco"
# Continue the conversation
result = await Runner.run(
agent,
"What state is it in?",
session=session
)
print(result.final_output) # "California"
OpenAI Responses コンパクションセッション
Responses API(responses.compact)を使用して保存済みの会話履歴を圧縮するには、OpenAIResponsesCompactionSession を使用します。これは基盤となるセッションをラップし、should_trigger_compaction に基づいて各ターンの後に自動的にコンパクションを実行できます。OpenAIConversationsSession をこれでラップしないでください。この 2 つの機能は異なる方法で履歴を管理します。
一般的な使用方法(自動コンパクション)
from agents import Agent, Runner, SQLiteSession
from agents.memory import OpenAIResponsesCompactionSession
underlying = SQLiteSession("conversation_123")
session = OpenAIResponsesCompactionSession(
session_id="conversation_123",
underlying_session=underlying,
)
agent = Agent(name="Assistant")
result = await Runner.run(agent, "Hello", session=session)
print(result.final_output)
デフォルトでは、候補のしきい値に達すると、各ターンの後にコンパクションが実行されます。
Responses API のレスポンス ID を使用してターンをすでに連結している場合は、compaction_mode="previous_response_id" が最適です。一方、compaction_mode="input" は、現在のセッション項目からコンパクションリクエストを再構築します。これは、レスポンスチェーンを利用できない場合や、セッション内容を信頼できる唯一の情報源にしたい場合に便利です。デフォルトの "auto" は、利用可能な最も安全なオプションを選択します。
エージェントが ModelSettings(store=False) で実行される場合、Responses API は後で参照できるように最後のレスポンスを保持しません。このステートレスな構成では、デフォルトの "auto" モードは previous_response_id に依存せず、入力ベースのコンパクションにフォールバックします。完全な例については、examples/memory/compaction_session_stateless_example.pyを参照してください。
自動コンパクションによるストリーミングのブロック
コンパクションではセッション履歴がクリアされて書き換えられるため、SDK はコンパクションが完了するまで実行を完了と見なしません。ストリーミングモードでは、コンパクションの処理が重い場合、最後の出力トークンの後も run.stream_events() が数秒間開いたままになることがあります。
低レイテンシーのストリーミングやターンの迅速な切り替えが必要な場合は、自動コンパクションを無効にし、ターン間またはアイドル時間中に run_compaction() を自分で呼び出してください。独自の基準に基づいて、コンパクションを強制するタイミングを決定できます。
from agents import Agent, Runner, SQLiteSession
from agents.memory import OpenAIResponsesCompactionSession
underlying = SQLiteSession("conversation_123")
session = OpenAIResponsesCompactionSession(
session_id="conversation_123",
underlying_session=underlying,
# Disable triggering the auto compaction
should_trigger_compaction=lambda _: False,
)
agent = Agent(name="Assistant")
result = await Runner.run(agent, "Hello", session=session)
# Decide when to compact (e.g., on idle, every N turns, or size thresholds).
await session.run_compaction({"force": True})
SQLite セッション
SQLite を使用するデフォルトの軽量セッション実装です。
from agents import SQLiteSession
# In-memory database (lost when process ends)
session = SQLiteSession("user_123")
# Persistent file-based database
session = SQLiteSession("user_123", "conversations.db")
# Use the session
result = await Runner.run(
agent,
"Hello",
session=session
)
非同期 SQLite セッション
aiosqlite を基盤とする SQLite 永続化が必要な場合は、AsyncSQLiteSession を使用します。
from agents import Agent, Runner
from agents.extensions.memory import AsyncSQLiteSession
agent = Agent(name="Assistant")
session = AsyncSQLiteSession("user_123", db_path="conversations.db")
result = await Runner.run(agent, "Hello", session=session)
Redis セッション
複数のワーカーまたはサービス間でセッションメモリを共有するには、RedisSession を使用します。
from agents import Agent, Runner
from agents.extensions.memory import RedisSession
agent = Agent(name="Assistant")
session = RedisSession.from_url(
"user_123",
url="redis://localhost:6379/0",
)
result = await Runner.run(agent, "Hello", session=session)
await session.close()
from_url(...) は Redis クライアントを作成して所有します。close() の後、セッションは終了状態になり、それ以降のセッション操作では RuntimeError が発生します。close() を繰り返し、または同時に呼び出しても安全です。アプリケーションがすでに Redis クライアントを管理している場合は、redis_client=... を指定して RedisSession(...) を直接構築してください。その場合、close() は何も行わず、呼び出し元がクライアントの所有権とセッションの利用可能性の両方を維持します。
SQLAlchemy セッション
SQLAlchemy がサポートする任意のデータベースを使用した、本番環境向けの Agents SDK セッション永続化です。
from agents.extensions.memory import SQLAlchemySession
# Using database URL
session = SQLAlchemySession.from_url(
"user_123",
url="postgresql+asyncpg://user:pass@localhost/db",
create_tables=True
)
# Using existing engine
from sqlalchemy.ext.asyncio import create_async_engine
engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db")
session = SQLAlchemySession("user_123", engine=engine, create_tables=True)
詳細なドキュメントについては、SQLAlchemy セッションを参照してください。
Dapr セッション
Dapr サイドカーをすでに実行している場合、またはエージェントコードを変更せずに異なるステートストアバックエンド間で移行できるセッションストレージが必要な場合は、DaprSession を使用します。
from agents import Agent, Runner
from agents.extensions.memory import DaprSession
agent = Agent(name="Assistant")
async with DaprSession.from_address(
"user_123",
state_store_name="statestore",
dapr_address="localhost:50001",
) as session:
result = await Runner.run(agent, "Hello", session=session)
print(result.final_output)
注意事項:
from_address(...)は Dapr クライアントを作成して所有します。アプリがすでにクライアントを管理している場合は、dapr_client=...を指定してDaprSession(...)を直接構築してください。- コンテキストを終了するか
close()を呼び出すと、所有クライアントを使用するセッションは終了状態になります。それ以降のセッション操作ではRuntimeErrorが発生しますが、close()を繰り返し、または同時に呼び出しても安全です。注入されたクライアントを使用する場合、close()は何も行わず、セッションは引き続き使用できます。 - バッキングステートストアが TTL をサポートしている場合、古いセッションデータを自動的に期限切れにするには
ttl=...を渡します。 - 書き込み後の読み取りについて、より強い保証が必要な場合は
consistency=DAPR_CONSISTENCY_STRONGを渡します。 - Dapr Python SDK は HTTP サイドカーエンドポイントも確認します。ローカル開発では、
dapr_addressで使用する gRPC ポートに加えて、--dapr-http-port 3500を指定して Dapr を起動してください。 - ローカルコンポーネントやトラブルシューティングを含む完全なセットアップ手順については、
examples/memory/dapr_session_example.pyを参照してください。
MongoDB セッション
MongoDB をすでに使用しているアプリケーション、または水平スケーリング可能なマルチプロセスのセッションストレージが必要なアプリケーションでは、MongoDBSession を使用します。
from agents import Agent, Runner
from agents.extensions.memory import MongoDBSession
agent = Agent(name="Assistant")
# Create from URI — owns the client and closes it when session.close() is called
session = MongoDBSession.from_uri(
"user-123",
uri="mongodb://localhost:27017",
database="agents",
)
result = await Runner.run(agent, "Hello", session=session)
print(result.final_output)
await session.close()
注意事項:
from_uri(...)はAsyncMongoClientを作成して所有し、session.close()で閉じます。アプリケーションがすでにクライアントを管理している場合は、client=...を指定してMongoDBSession(...)を直接構築してください。その場合、session.close()は何も行わず、ライフサイクルの管理は呼び出し元が引き続き行います。mongodb+srv://user:password@cluster.example.mongodb.netURI をfrom_uri(...)に渡すことで、ほかに変更を加えずに MongoDB Atlas に接続できます。- 2 つのコレクションが使用され、どちらの名前も
sessions_collection=(デフォルトはagent_sessions)とmessages_collection=(デフォルトはagent_messages)で設定できます。インデックスは初回使用時に自動的に作成されます。各メッセージドキュメントには単調増加するseqカウンターが含まれ、同時に書き込む複数のライターやプロセス間でも順序が保持されます。 - 最初の実行前に接続を確認するには、
await session.ping()を使用します。
高度な SQLite セッション
会話の分岐、使用状況分析、構造化クエリを備えた拡張 SQLite セッションです。
from agents.extensions.memory import AdvancedSQLiteSession
# Create with advanced features
session = AdvancedSQLiteSession(
session_id="user_123",
db_path="conversations.db",
create_tables=True
)
# Automatic usage tracking
result = await Runner.run(agent, "Hello", session=session)
await session.store_run_usage(result) # Track token usage
# Conversation branching
await session.create_branch_from_turn(2) # Branch from turn 2
詳細なドキュメントについては、高度な SQLite セッションを参照してください。
暗号化セッション
任意のセッション実装に対する透過的な暗号化ラッパーです。
from agents.extensions.memory import EncryptedSession, SQLAlchemySession
# Create underlying session
underlying_session = SQLAlchemySession.from_url(
"user_123",
url="sqlite+aiosqlite:///conversations.db",
create_tables=True
)
# Wrap with encryption and TTL
session = EncryptedSession(
session_id="user_123",
underlying_session=underlying_session,
encryption_key="your-secret-key",
ttl=600 # 10 minutes
)
result = await Runner.run(agent, "Hello", session=session)
詳細なドキュメントについては、暗号化セッションを参照してください。
その他のセッションタイプ
ほかにもいくつかの組み込みオプションがあります。examples/memory/ および extensions/memory/ 配下のソースコードを参照してください。
運用パターン
セッション ID の命名
会話の整理に役立つ、意味のあるセッション ID を使用してください。
- ユーザーベース:
"user_12345" - スレッドベース:
"thread_abc123" - コンテキストベース:
"support_ticket_456"
メモリの永続化
- 一時的な会話には、インメモリ SQLite(
SQLiteSession("session_id"))を使用します - 永続的な会話には、ファイルベースの SQLite(
SQLiteSession("session_id", "path/to/db.sqlite"))を使用します aiosqliteベースの実装が必要な場合は、非同期 SQLite(AsyncSQLiteSession("session_id", db_path="..."))を使用します- 共有された低レイテンシーのセッションメモリには、Redis ベースのセッション(
RedisSession.from_url("session_id", url="redis://..."))を使用します - SQLAlchemy がサポートする既存のデータベースを使用する本番システムには、SQLAlchemy ベースのセッション(
SQLAlchemySession("session_id", engine=engine, create_tables=True))を使用します - MongoDB をすでに使用しているアプリケーション、または水平スケーリング可能なマルチプロセスのセッションストレージが必要なアプリケーションには、MongoDB セッション(
MongoDBSession.from_uri("session_id", uri="mongodb://localhost:27017"))を使用します - 組み込みのテレメトリー、トレーシング、データ分離を備え、30 種類以上のデータベースバックエンドをサポートする本番環境のクラウドネイティブなデプロイには、Dapr ステートストアセッション(
DaprSession.from_address("session_id", state_store_name="statestore", dapr_address="localhost:50001"))を使用します - OpenAI Conversations API に履歴を保存したい場合は、OpenAI がホストするストレージ(
OpenAIConversationsSession())を使用します - 任意のセッションを透過的な暗号化と TTL ベースの有効期限でラップするには、暗号化セッション(
EncryptedSession(session_id, underlying_session, encryption_key))を使用します - より高度なユースケースでは、ほかの本番システム(Django など)向けのカスタムセッションバックエンドの実装を検討してください
複数のセッション
from agents import Agent, Runner, SQLiteSession
agent = Agent(name="Assistant")
# Different sessions maintain separate conversation histories
session_1 = SQLiteSession("user_123", "conversations.db")
session_2 = SQLiteSession("user_456", "conversations.db")
result1 = await Runner.run(
agent,
"Help me with my account",
session=session_1
)
result2 = await Runner.run(
agent,
"What are my charges?",
session=session_2
)
セッションの共有
# Different agents can share the same session
support_agent = Agent(name="Support")
billing_agent = Agent(name="Billing")
session = SQLiteSession("user_123")
# Both agents will see the same conversation history
result1 = await Runner.run(
support_agent,
"Help me with my account",
session=session
)
result2 = await Runner.run(
billing_agent,
"What are my charges?",
session=session
)
完全な例
セッションメモリの動作を示す完全な例を以下に示します。
import asyncio
from agents import Agent, Runner, SQLiteSession
async def main():
# Create an agent
agent = Agent(
name="Assistant",
instructions="Reply very concisely.",
)
# Create a session instance that will persist across runs
session = SQLiteSession("conversation_123", "conversation_history.db")
print("=== Sessions Example ===")
print("The agent will remember previous messages automatically.\n")
# First turn
print("First turn:")
print("User: What city is the Golden Gate Bridge in?")
result = await Runner.run(
agent,
"What city is the Golden Gate Bridge in?",
session=session
)
print(f"Assistant: {result.final_output}")
print()
# Second turn - the agent will remember the previous conversation
print("Second turn:")
print("User: What state is it in?")
result = await Runner.run(
agent,
"What state is it in?",
session=session
)
print(f"Assistant: {result.final_output}")
print()
# Third turn - continuing the conversation
print("Third turn:")
print("User: What's the population of that state?")
result = await Runner.run(
agent,
"What's the population of that state?",
session=session
)
print(f"Assistant: {result.final_output}")
print()
print("=== Conversation Complete ===")
print("Notice how the agent remembered the context from previous turns!")
print("Sessions automatically handles conversation history.")
if __name__ == "__main__":
asyncio.run(main())
カスタムセッション実装
Session プロトコルに準拠するクラスを作成することで、独自のセッションメモリを実装できます。
from agents.memory.session import SessionABC
from agents.items import TResponseInputItem
from typing import List
class MyCustomSession(SessionABC):
"""Custom session implementation following the Session protocol."""
def __init__(self, session_id: str):
self.session_id = session_id
# Your initialization here
async def get_items(self, limit: int | None = None) -> List[TResponseInputItem]:
"""Retrieve conversation history for this session."""
# Your implementation here
pass
async def add_items(self, items: List[TResponseInputItem]) -> None:
"""Store new items for this session."""
# Your implementation here
pass
async def pop_item(self) -> TResponseInputItem | None:
"""Remove and return the most recent item from this session."""
# Your implementation here
pass
async def clear_session(self) -> None:
"""Clear all items for this session."""
# Your implementation here
pass
# Use your custom session
agent = Agent(name="Assistant")
result = await Runner.run(
agent,
"Hello",
session=MyCustomSession("my_session")
)
コミュニティによるセッション実装
コミュニティによって、追加のセッション実装が開発されています。
| パッケージ | 説明 |
|---|---|
| openai-django-sessions | Django がサポートする任意のデータベース(PostgreSQL、MySQL、SQLite など)向けの Django ORM ベースのセッション |
セッション実装を構築した場合は、ここに追加するためのドキュメント PR をぜひ送信してください。
API リファレンス
詳細な API ドキュメントについては、以下を参照してください。
Session- プロトコルインターフェースOpenAIConversationsSession- OpenAI Conversations API 実装OpenAIResponsesCompactionSession- Responses API コンパクションラッパーSQLiteSession- 基本的な SQLite 実装AsyncSQLiteSession-aiosqliteベースの非同期 SQLite 実装RedisSession- Redis ベースのセッション実装SQLAlchemySession- SQLAlchemy ベースの実装MongoDBSession- MongoDB ベースのセッション実装DaprSession- Dapr ステートストア実装AdvancedSQLiteSession- 分岐と分析機能を備えた拡張 SQLiteEncryptedSession- 任意のセッション向けの暗号化ラッパー