機能の概要
複数ラウンドの対話をサーバーに送信し、モデルが価値のある記憶（人物、出来事、好みなど）を自動的に抽出して指定された記憶空間に書き込みます。今回の書き込みにおける add/update/skip の統計を返します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/memory/spaces/{spaceId}/memories/extract
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
| X-OB-Project-ID | はい | your-project-id | プロジェクトID |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| spaceId | string | はい | space-123 | 記憶空間ID。 |
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| userId | string | はい | user-001 | 業務ユーザーID。 |
| agentId | string | はい | agent-001 | 業務Agent ID。 |
| sessionId | string | はい | session-abc123 | 業務セッションID。 |
| messages | array |
はい | [{"role":"user","content":"こんにちは"}] | 対話メッセージリスト。 |
| messages[].role | string | はい | user | メッセージの役割。user、assistant、systemのいずれか。 |
| messages[].content | string | はい | こんにちは | メッセージの内容。 |
実行結果
実行パラメータ
プロパティ |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します。 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータ |
dataフィールドの説明
プロパティ |
型 |
説明 |
|---|---|---|
| add | integer | 新規追加されたメモリ数 |
| update | integer | 更新されたメモリ数 |
| skip | integer | スキップされたメモリ数 |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/memory/spaces/space-123/memories/extract' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: your-project-id' \
--header 'Content-Type: application/json' \
--data '{
"userId": "user-001",
"agentId": "agent-001",
"sessionId": "session-abc123",
"messages": [
{"role": "user", "content": "私は辛い火鍋が好きです。"},
{"role": "assistant", "content": "了解しました。お好みを記録しました。"}
]
}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"add": 2,
"update": 1,
"skip": 0
}
}