Skip to content

Commit

Permalink
docs: v0.5 migration guide (#531)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yonom authored Jul 17, 2024
1 parent 5c41459 commit df011cb
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
4 changes: 4 additions & 0 deletions apps/docs/content/docs/docs/migrations/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Migrations",
"pages": ["v0-5", "v0-4", "v0-3"]
}
18 changes: 18 additions & 0 deletions apps/docs/content/docs/docs/migrations/v0-5.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Migration to v0.5
---

## Assistant Message Status / Content Part Status

The previous `AssistantMessage.status` field has been reworked:

- `in_progress` is now `{ type: "running" }`
- `error` is now `{ type: "incomplete", reason: "error", error: unknown }`

The previous value `done` now maps to one of the following values:

- `{ type: "requires-action", reason: "tool-calls" }`
- `{ type: "complete", reason: "stop" | "unknown" }`
- `{ type: "incomplete", reason: "cancelled" | "tool-calls" | "length" | "content-filter" | "other" }`

The same applies to `ContentPart` status fields.

0 comments on commit df011cb

Please sign in to comment.