Skip to content

Commit da12413

Browse files
committed
docs: #2625 clarify the difference between sessions and chatkit store
1 parent d23d85a commit da12413

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/sessions/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ Use this table to pick a starting point before reading the detailed examples bel
214214

215215
Some implementations have dedicated pages with additional details; those are linked inline in their subsections.
216216

217+
If you are implementing a Python server for ChatKit, use a `chatkit.store.Store` implementation for ChatKit's thread and item persistence. Agents SDK sessions such as `SQLAlchemySession` manage SDK-side conversation history, but they are not a drop-in replacement for ChatKit's store. See the [`chatkit-python` guide on implementing your ChatKit data store](https://github.com/openai/chatkit-python/blob/main/docs/guides/respond-to-user-message.md#implement-your-chatkit-data-store).
218+
217219
### OpenAI Conversations API sessions
218220

219221
Use [OpenAI's Conversations API](https://platform.openai.com/docs/api-reference/conversations) through `OpenAIConversationsSession`.
@@ -360,7 +362,7 @@ result = await Runner.run(agent, "Hello", session=session)
360362

361363
### SQLAlchemy sessions
362364

363-
Production-ready sessions using any SQLAlchemy-supported database:
365+
Production-ready Agents SDK session persistence using any SQLAlchemy-supported database:
364366

365367
```python
366368
from agents.extensions.memory import SQLAlchemySession

0 commit comments

Comments
 (0)