Dream は非同期のメモリ整理タスクです。作成後、一覧または取得 API で実行状態と結果を確認できます。
Dream は非同期のメモリ整理タスクです。作成後、一覧または取得 API で実行状態と結果を確認できます。
作成、一覧、取得、キャンセル、アーカイブ API は、次の Dream オブジェクトを使用します。
作成時に、指定した Identity と Template の現在の Default Memory を解決して記録します。完了後、出力 Memory Store が同じ Identity と Template の新しい Default Memory になります。
実行中に別の操作で Default Memory が置き換えられた場合、新しいマウント関係は上書きしません。Dream を
Dream が完了すると、
Dream オブジェクト
作成、一覧、取得、キャンセル、アーカイブ API は、次の Dream オブジェクトを使用します。
| フィールド | 型 | 説明 |
|---|---|---|
id | string | drm_ プレフィックスを持つ Dream ID。 |
type | string | 常に dream。 |
status | string | 実行状態。Dream の状態を参照してください。 |
inputs | object[] | タスク作成時の入力。identity_template 入力は元の形式で返され、内部で解決された Memory Store ID に展開されません。 |
outputs | object[] | 整理結果。完了前、失敗時、キャンセル時には空の配列を返します。 |
model | object | このタスクで使用したモデル設定。 |
model.id | string | モデルのティア。auto、lite、ultimate のいずれか。 |
instructions | string | 作成時に指定した整理指示。未指定の場合は空文字列。 |
usage | object | トークン使用量。Dream usage を参照してください。使用量が発生するまではすべてのフィールドが 0 です。 |
error | object/null | タスク失敗時のエラー詳細。Dream error を参照してください。他の状態では null。 |
created_at | string | 作成日時。UTC RFC 3339 形式。 |
ended_at | string/null | 終端状態になった日時。UTC RFC 3339 形式。終了前は null。 |
archived_at | string/null | アーカイブ日時。UTC RFC 3339 形式。未アーカイブの場合は null。 |
Dream の状態
| 値 | 説明 |
|---|---|
pending | 作成済みで実行待ちです。 |
running | メモリを整理中です。 |
completed | 整理が完了しました。outputs に結果の Memory Store が含まれます。 |
failed | 実行または結果の適用に失敗しました。詳細は error を参照してください。 |
canceled | タスクはキャンセルされました。 |
completed、failed、canceled は終端状態です。
Dream input
inputs には主要入力を必ず 1 つだけ含めます。Session 入力を追加できます。
type | フィールド | 説明 |
|---|---|---|
memory_store | memory_store_id | 呼び出し元がアクセスできる Memory Store を直接整理します。 |
identity_template | identity_id、template_id | 指定した Identity と Template に現在マウントされている Default Memory を整理します。 |
sessions | session_ids | 重点的に見直す Session ID の配列。省略可能です。すべての sessions 入力を合わせて最大 100 個の ID を指定できます。 |
memory_store と identity_template は排他的で、同じリクエストには指定できません。各入力には、その型で定義されたフィールドのみ指定できます。
memory_store の処理
memory_store_id で指定した Memory Store を直接入力として使用します。完了時の出力は新しい Memory Store です。元の入力 Store は上書きされず、Identity と Template のマウント関係も自動変更されません。
identity_template の処理
作成時に、指定した Identity と Template の現在の Default Memory を解決して記録します。完了後、出力 Memory Store が同じ Identity と Template の新しい Default Memory になります。
実行中に別の操作で Default Memory が置き換えられた場合、新しいマウント関係は上書きしません。Dream を failed にし、エラーコード memory_changed_during_dream を返します。
Dream output
Dream が完了すると、outputs に 1 つの要素が含まれます。
| フィールド | 型 | 説明 |
|---|---|---|
type | string | 常に memory_store。 |
memory_store_id | string | 整理によって生成された Memory Store の ID。 |
files_touched | string[] | 整理中に作成、変更、削除されたメモリファイルのパス。詳細がない場合は省略されます。 |
Dream usage
| フィールド | 型 | 説明 |
|---|---|---|
input_tokens | integer | 入力トークン数。 |
output_tokens | integer | 出力トークン数。 |
cache_creation_input_tokens | integer | キャッシュ作成に使用した入力トークン数。 |
cache_read_input_tokens | integer | キャッシュから読み取った入力トークン数。 |
Dream error
| フィールド | 型 | 説明 |
|---|---|---|
type | string | エラーの型。例：no_output、internal_error。 |
code | string | 省略可能な安定したエラーコード。コードがない場合、このフィールドは返されません。 |
message | string | トラブルシューティング用のエラー説明。プログラムの判定には使用しないでください。 |