mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-23 09:35:13 +00:00
33f544c71d
* Apply permission handler requirements across Copilot SDK docs Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Polish permission update formatting in SDK examples Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Fix review comments on SDK permission handling PR Address 5 review comments from PR #1103: 1. Fix invalid object literal syntax (stray comma) in resumeSession example in copilot-sdk-nodejs.instructions.md 2. Replace unused PermissionHandler import with actual usage in cookbook/copilot-sdk/python/recipe/ralph_loop.py (was using inline lambda instead) 3. Replace unused approveAll import with actual usage in cookbook/copilot-sdk/nodejs/recipe/ralph-loop.ts (was using inline handler instead) 4. Add missing PermissionHandler import to 4 Python code snippets in skills/copilot-sdk/SKILL.md that reference it without importing 5. Add missing approveAll import to 3 TypeScript code snippets in skills/copilot-sdk/SKILL.md that reference it without importing * Refactor session creation to improve code formatting and consistency across SDK examples * Fix formatting: split multi-property lines and put closing braces on own lines Address review comments on PR #1107: - Split OnPermissionRequest + Model onto separate lines in Go, C#, TypeScript - Put closing }); on its own line consistently across all examples - Fix indentation in SKILL.md Quick Start, CLI URL, Error Handling sections - Fix cookbook Go multiple-sessions and error-handling formatting - Fix ralph-loop.md TypeScript indentation --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com>
89 lines
2.2 KiB
Markdown
89 lines
2.2 KiB
Markdown
# Session Persistence and Resumption
|
|
|
|
Save and restore conversation sessions across application restarts.
|
|
|
|
## Example scenario
|
|
|
|
You want users to be able to continue a conversation even after closing and reopening your application.
|
|
|
|
> **Runnable example:** [recipe/persisting_sessions.py](recipe/persisting_sessions.py)
|
|
>
|
|
> ```bash
|
|
> cd recipe && pip install -r requirements.txt
|
|
> python persisting_sessions.py
|
|
> ```
|
|
|
|
### Creating a session with a custom ID
|
|
|
|
```python
|
|
import asyncio
|
|
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
|
|
|
async def main():
|
|
client = CopilotClient()
|
|
await client.start()
|
|
|
|
# Create session with a memorable ID
|
|
session = await client.create_session(SessionConfig(
|
|
session_id="user-123-conversation",
|
|
model="gpt-5",
|
|
on_permission_request=PermissionHandler.approve_all))
|
|
|
|
await session.send_and_wait(MessageOptions(prompt="Let's discuss TypeScript generics"))
|
|
|
|
# Session ID is preserved
|
|
print(session.session_id) # "user-123-conversation"
|
|
|
|
# Destroy session but keep data on disk
|
|
await session.destroy()
|
|
await client.stop()
|
|
|
|
if __name__ == "__main__":
|
|
asyncio.run(main())
|
|
```
|
|
|
|
### Resuming a session
|
|
|
|
```python
|
|
client = CopilotClient()
|
|
await client.start()
|
|
|
|
# Resume the previous session
|
|
session = await client.resume_session("user-123-conversation", on_permission_request=PermissionHandler.approve_all)
|
|
|
|
# Previous context is restored
|
|
await session.send_and_wait(MessageOptions(prompt="What were we discussing?"))
|
|
|
|
await session.destroy()
|
|
await client.stop()
|
|
```
|
|
|
|
### Listing available sessions
|
|
|
|
```python
|
|
sessions = await client.list_sessions()
|
|
for s in sessions:
|
|
print("Session:", s.session_id)
|
|
```
|
|
|
|
### Deleting a session permanently
|
|
|
|
```python
|
|
# Remove session and all its data from disk
|
|
await client.delete_session("user-123-conversation")
|
|
```
|
|
|
|
### Getting session history
|
|
|
|
```python
|
|
messages = await session.get_messages()
|
|
for msg in messages:
|
|
print(f"[{msg.type}] {msg.data.content}")
|
|
```
|
|
|
|
## Best practices
|
|
|
|
1. **Use meaningful session IDs**: Include user ID or context in the session ID
|
|
2. **Handle missing sessions**: Check if a session exists before resuming
|
|
3. **Clean up old sessions**: Periodically delete sessions that are no longer needed
|