機能の概要
現在のプロジェクトに新しいスペースを作成します。これは、メモや経験を論理的に分離する単位です。作成後、spaceIdが返されます。その後のすべてのメモ/経験関連のAPIで、{spaceId}パスパラメータとしてこの値を使用します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/memory/spaces
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
| X-OB-Project-ID | はい | your-project-id | プロジェクトID |
リクエストパラメータ
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| spaceName | string | はい | my-space | スペース名。最大長は128文字です。 |
| description | string | いいえ | A space for storing memories. | スペースの説明。最大長は512文字です。 |
| dims | integer | いいえ | 1536 | ベクトル次元。指定しない場合、サーバー側がproviderのデフォルト値に基づいて決定します。 |
| providerType | string | いいえ | openai | LLMプロバイダーの種類。embedderには影響しません（常にqwen）。 |
| providerBaseUrl | string | いいえ | https://api.openai.com | LLMサービスのBase URL。 |
| providerApiKey | string | いいえ | sk-... | LLMサービスAPIキー。 |
| providerLlmModel | string | いいえ | gpt-4 | LLMモデル名。 |
| providerEmbeddingModel | string | いいえ | text-embedding-ada-002 | ベクトルモデル名。 |
実行結果
実行パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻りコード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータ |
dataフィールドの説明
作成が成功した場合、data フィールドには作成されたSpaceの情報が含まれます。具体的な構造はサーバー側で定義されます。
リクエスト例
curl --request POST '{BASE_URL}/api/v1/memory/spaces' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: your-project-id' \
--header 'Content-Type: application/json' \
--data '{
"spaceName": "my-space",
"description": "A space for storing memories.",
"dims": 1024,
"providerType": "openai",
"providerBaseUrl": "https://api.openai.com",
"providerApiKey": "sk-...",
"providerLlmModel": "gpt-4",
"providerEmbeddingModel": "text-embedding-ada-002"
}'
レスポンス例
{
"success": true,
"code": "201",
"message": "Created",
"data": {
"spaceId": "spc-1234567890abcdef"
}
}