Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

feat: use a default dir ~/.openviking to store configuration, fix win… (#120)

MaojiaShenga4b346c73636
diff --git a/README.md b/README.md
index 65936b2f4..4a9c1771f 100644
--- a/README.md
+++ b/README.md
@@ -173,13 +173,13 @@ On Windows, use one of the following:
PowerShell:
```powershell
-$env:OPENVIKING_CONFIG_FILE = "~/.openviking/ov.conf"
+$env:OPENVIKING_CONFIG_FILE = "$HOME/.openviking/ov.conf"
```
Command Prompt (cmd.exe):
```bat
-set OPENVIKING_CONFIG_FILE=~/.openviking/ov.conf
+set "OPENVIKING_CONFIG_FILE=%USERPROFILE%\.openviking\ov.conf"
```
> 💡 **Tip**: You can also place the configuration file in other locations, just specify the correct path in the environment variable.
diff --git a/README_CN.md b/README_CN.md
index b4c45c863..0cceb79b2 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -172,13 +172,13 @@ Windows 下可使用以下方式之一:
PowerShell:
```powershell
-$env:OPENVIKING_CONFIG_FILE = "~/.openviking/ov.conf"
+$env:OPENVIKING_CONFIG_FILE = "$HOME/.openviking/ov.conf"
```
命令提示符(cmd.exe):
```bat
-set OPENVIKING_CONFIG_FILE=~/.openviking/ov.conf
+set "OPENVIKING_CONFIG_FILE=%USERPROFILE%\.openviking\ov.conf"
```
> 💡 **提示**:你也可以将配置文件放在其他位置,只需在环境变量中指定正确的路径即可。
diff --git a/docs/design/server_client/server-cli-design.md b/docs/design/server_client/server-cli-design.md
index cef3425ee..630c0f202 100644
--- a/docs/design/server_client/server-cli-design.md
+++ b/docs/design/server_client/server-cli-design.md
@@ -296,12 +296,19 @@ OpenViking 提供三种接口,面向不同使用场景:
### 3.3 身份与隔离
-支持多租户场景,通过 `user` 和 `agent` 实现数据隔离:
+支持多租户场景,首先通过 account_id 区分不同的应用租户,然后允许通过 `user` 和 `agent` 实现租户内的身份隔离:
+
+用户或智能体身份标识详见 `from openviking.session.user_id import UserIdentifier`
+
+| 参数 | 说明 | 默认值 |
+|------|------|------|
+| `account_id` | 租户账号标识,区分不同的租户,租户内 user 和 agent id 空间隔离,也就是保证租户之间数据隔离 | `default` |
+| `user_id` | 用户身份标识,用户在租户内的唯一标识符 | `default` |
+| `agent_id` | 智能体身份标识,智能体或应用在租户内的唯一标识符 | `default` |
+
+> 举例说明,如果一个团队部署一个 OpenViking 上下文数据库,让团队成员共享一部分上下文资料,但各自保留独立的记忆数据,团队使用统一的 account_id,每个成员使用不同的 user_id 来区分,成员使用不同的应用(如 OpenCode, OpenClaw 等)则使用不同的 agent_id 来区分。
+> 一般情况下,`account_id` 不会出现在 viking:// uri 中,因为每个租户的用户数据都是隔离的,不需要在 uri 中指定租户。
-| 参数 | 说明 | 作用域 |
-|------|------|--------|
-| `user` | 用户标识 | `viking://user/{user}/memories/` |
-| `agent` | Agent 标识 | `viking://agent/{agent}/memories/` |
### 3.4 配置管理
@@ -1021,7 +1028,7 @@ all_sessions = client.sessions()
```python
class Session:
"""Session 对象,封装会话操作"""
- def __init__(self, client, session_id: str, user: str):
+ def __init__(self, client, session_id: str, user: UserIdentifier):
self._client = client
self.id = session_id
self.user = user
@@ -1044,17 +1051,16 @@ class OpenViking:
path: Optional[str] = None,
url: Optional[str] = None,
api_key: Optional[str] = None,
- user: Optional[str] = None,
- agent: Optional[str] = None,
+ user: Optional[UserIdentifier] = None
):
if url:
self._backend = HTTPBackend(url, api_key)
else:
self._backend = LocalBackend(path)
self._user = user
- self._agent_id = agent
- def session(self, user: str = None) -> Session:
+
+ def session(self, user: UserIdentifier = None) -> Session:
"""创建或获取 Session 对象"""
...
diff --git a/docs/en/concepts/04-viking-uri.md b/docs/en/concepts/04-viking-uri.md
index a4d2e2c54..77beaa7be 100644
--- a/docs/en/concepts/04-viking-uri.md
+++ b/docs/en/concepts/04-viking-uri.md
@@ -107,27 +107,28 @@ viking://session/{session_id}/history/ # Archived history
```
viking://
-├── resources/ # Independent resources
+├── resources/ # Independent resources
│ └── {project}/
│ ├── .abstract.md
│ ├── .overview.md
│ └── {files...}
│
-├── user/
-│ ├── profile.md # User basic info
+├── user/{user_id}/
+│ ├── profile.md # User basic info
│ └── memories/
│ ├── preferences/ # By topic
│ ├── entities/ # Each independent
│ └── events/ # Each independent
│
-├── agent/
+├── agent/{unique_space_name}/
│ ├── skills/ # Skill definitions
│ ├── memories/
│ │ ├── cases/
│ │ └── patterns/
+│ ├── workspaces/
│ └── instructions/
│
-└── session/{session_id}/
+└── session/{unique_space_name}/{session_id}/
├── messages/
├── tools/
└── history/
diff --git a/examples/memex/client.py b/examples/memex/client.py
index c51ebcc09..241cc279d 100644
--- a/examples/memex/client.py
+++ b/examples/memex/client.py
@@ -4,10 +4,11 @@ Memex Client - OpenViking client wrapper for Memex.
from typing import Any, Optional
-import openviking as ov
-
from config import MemexConfig
+import openviking as ov
+from openviking.session.user_id import UserIdentifier
+
class MemexClient:
"""OpenViking client wrapper for Memex."""
@@ -32,10 +33,13 @@ class MemexClient:
def initialize(self) -> None:
"""Initialize the OpenViking client."""
ov_config = self.config.get_openviking_config()
+ user = UserIdentifier(
+ ov_config.default_account, ov_config.default_user, ov_config.default_agent
+ )
self._client = ov.SyncOpenViking(
path=self.config.data_path,
config=ov_config,
- user=self.config.user,
+ user=user,
)
self._client.initialize()
diff --git a/examples/memex/commands/stats.py b/examples/memex/commands/stats.py
index 9e4843db1..ff747fc6e 100644
--- a/examples/memex/commands/stats.py
+++ b/examples/memex/commands/stats.py
@@ -2,11 +2,10 @@
Stats commands for Memex - knowledge base statistics.
"""
+from client import MemexClient
from rich.console import Console
-from rich.table import Table
from rich.panel import Panel
-
-from client import MemexClient
+from rich.table import Table
class StatsCommands:
@@ -65,7 +64,7 @@ class StatsCommands:
info_text = f"""[cyan]Data Path:[/cyan] {config.data_path}
[cyan]Config Path:[/cyan] {config.config_path}
-[cyan]User:[/cyan] {config.user}
+[cyan]User:[/cyan] {config.default_user}
[cyan]LLM Backend:[/cyan] {llm_backend}
[cyan]LLM Model:[/cyan] {llm_model}
[cyan]Search Top-K:[/cyan] {config.search_top_k}
diff --git a/openviking/__init__.py b/openviking/__init__.py
index 4c2e1ffc0..f9c7d73c8 100644
--- a/openviking/__init__.py
+++ b/openviking/__init__.py
@@ -8,6 +8,7 @@ Data in, Context out.
from openviking.async_client import AsyncOpenViking
from openviking.session import Session
+from openviking.session.user_id import UserIdentifier
from openviking.sync_client import SyncOpenViking
OpenViking = SyncOpenViking
@@ -21,9 +22,11 @@ except ImportError:
__version__ = version("openviking")
except ImportError:
__version__ = "0.0.0+unknown"
+
__all__ = [
"OpenViking",
"SyncOpenViking",
"AsyncOpenViking",
"Session",
+ "UserIdentifier",
]
diff --git a/openviking/async_client.py b/openviking/async_client.py
index 7de898a05..89d0c93d6 100644
--- a/openviking/async_client.py
+++ b/openviking/async_client.py
@@ -13,6 +13,7 @@ from typing import Any, Dict, List, Optional, Union
from openviking.client import HTTPClient, LocalClient, Session
from openviking.client.base import BaseClient
from openviking.service.debug_service import SystemStatus
+from openviking.session.user_id import UserIdentifier
from openviking.utils import get_logger
from openviking.utils.config import OpenVikingConfig
@@ -99,7 +100,7 @@ class AsyncOpenViking:
api_key: Optional[str] = None,
vectordb_url: Optional[str] = None,
agfs_url: Optional[str] = None,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
config: Optional[OpenVikingConfig] = None,
**kwargs,
):
@@ -112,7 +113,7 @@ class AsyncOpenViking:
api_key: API key for HTTP mode authentication.
vectordb_url: Remote VectorDB service URL for service mode.
agfs_url: Remote AGFS service URL for service mode.
- user: Username for session management.
+ user: UserIdentifier object for session management.
config: OpenVikingConfig object for advanced configuration.
**kwargs: Additional configuration parameters.
"""
@@ -120,7 +121,9 @@ class AsyncOpenViking:
if hasattr(self, "_singleton_initialized") and self._singleton_initialized:
return
- self.user = user or "default"
+ if isinstance(user, str):
+ user = UserIdentifier.the_default_user(user)
+ self.user = user or UserIdentifier.the_default_user()
self._initialized = False
self._singleton_initialized = True
@@ -131,18 +134,16 @@ class AsyncOpenViking:
# Create the appropriate client - only _client, no _service
if url:
# HTTP mode
- self._client: BaseClient = HTTPClient(url=url, api_key=api_key, user=user)
+ self._client: BaseClient = HTTPClient(url=url, api_key=api_key, user=self.user)
else:
# Local/Service mode - LocalClient creates and owns the OpenVikingService
self._client: BaseClient = LocalClient(
path=path,
vectordb_url=vectordb_url,
agfs_url=agfs_url,
- user=user,
+ user=self.user,
config=config,
)
- # Get user from the client's service
- self.user = self._client._user
# ============= Lifecycle methods =============
diff --git a/openviking/client/http.py b/openviking/client/http.py
index baa075963..f483a8255 100644
--- a/openviking/client/http.py
+++ b/openviking/client/http.py
@@ -11,8 +11,6 @@ from typing import Any, Dict, List, Optional, Union
import httpx
from openviking.client.base import BaseClient
-from openviking.retrieve.types import FindResult
-from openviking.utils import run_async
from openviking.exceptions import (
AlreadyExistsError,
DeadlineExceededError,
@@ -30,6 +28,9 @@ from openviking.exceptions import (
UnavailableError,
VLMFailedError,
)
+from openviking.retrieve.types import FindResult
+from openviking.session.user_id import UserIdentifier
+from openviking.utils import run_async
# Error code to exception class mapping
ERROR_CODE_TO_EXCEPTION = {
@@ -112,7 +113,7 @@ class HTTPClient(BaseClient):
self,
url: str,
api_key: Optional[str] = None,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
):
"""Initialize HTTPClient.
@@ -123,7 +124,7 @@ class HTTPClient(BaseClient):
"""
self._url = url.rstrip("/")
self._api_key = api_key or os.environ.get("OPENVIKING_API_KEY")
- self._user = user or "default"
+ self._user = user or UserIdentifier.the_default_user()
self._http: Optional[httpx.AsyncClient] = None
self._observer: Optional[_HTTPObserver] = None
@@ -247,9 +248,7 @@ class HTTPClient(BaseClient):
# ============= File System =============
- async def ls(
- self, uri: str, simple: bool = False, recursive: bool = False
- ) -> List[Any]:
+ async def ls(self, uri: str, simple: bool = False, recursive: bool = False) -> List[Any]:
"""List directory contents."""
response = await self._http.get(
"/api/v1/fs/ls",
@@ -370,9 +369,7 @@ class HTTPClient(BaseClient):
)
return FindResult.from_dict(self._handle_response(response))
- async def grep(
- self, uri: str, pattern: str, case_insensitive: bool = False
- ) -> Dict[str, Any]:
+ async def grep(self, uri: str, pattern: str, case_insensitive: bool = False) -> Dict[str, Any]:
"""Content search with pattern."""
response = await self._http.post(
"/api/v1/search/grep",
@@ -402,9 +399,7 @@ class HTTPClient(BaseClient):
)
return self._handle_response(response)
- async def link(
- self, from_uri: str, to_uris: Union[str, List[str]], reason: str = ""
- ) -> None:
+ async def link(self, from_uri: str, to_uris: Union[str, List[str]], reason: str = "") -> None:
"""Create link between resources."""
response = await self._http.post(
"/api/v1/relations/link",
@@ -427,7 +422,7 @@ class HTTPClient(BaseClient):
"""Create a new session."""
response = await self._http.post(
"/api/v1/sessions",
- json={"user": user or self._user},
+ json={"user": user or self._user.to_dict()},
)
return self._handle_response(response)
@@ -456,9 +451,7 @@ class HTTPClient(BaseClient):
response = await self._http.post(f"/api/v1/sessions/{session_id}/extract")
return self._handle_response(response)
- async def add_message(
- self, session_id: str, role: str, content: str
- ) -> Dict[str, Any]:
+ async def add_message(self, session_id: str, role: str, content: str) -> Dict[str, Any]:
"""Add a message to a session."""
response = await self._http.post(
f"/api/v1/sessions/{session_id}/messages",
@@ -542,6 +535,7 @@ class HTTPClient(BaseClient):
Session object
"""
from openviking.client.session import Session
+
if not session_id:
result = run_async(self.create_session())
session_id = result.get("session_id", "")
@@ -566,4 +560,4 @@ class HTTPClient(BaseClient):
@property
def observer(self) -> _HTTPObserver:
"""Get observer service for component status."""
- return self._observer
\ No newline at end of file
+ return self._observer
diff --git a/openviking/client/local.py b/openviking/client/local.py
index 743290428..f1983b441 100644
--- a/openviking/client/local.py
+++ b/openviking/client/local.py
@@ -9,6 +9,7 @@ from typing import Any, Dict, List, Optional, Union
from openviking.client.base import BaseClient
from openviking.service import OpenVikingService
+from openviking.session.user_id import UserIdentifier
from openviking.utils.config import OpenVikingConfig
@@ -23,7 +24,7 @@ class LocalClient(BaseClient):
path: Optional[str] = None,
vectordb_url: Optional[str] = None,
agfs_url: Optional[str] = None,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
config: Optional[OpenVikingConfig] = None,
):
"""Initialize LocalClient.
@@ -39,7 +40,7 @@ class LocalClient(BaseClient):
path=path,
vectordb_url=vectordb_url,
agfs_url=agfs_url,
- user=user,
+ user=user or UserIdentifier.the_default_user(),
config=config,
)
self._user = self._service.user
@@ -99,9 +100,7 @@ class LocalClient(BaseClient):
# ============= File System =============
- async def ls(
- self, uri: str, simple: bool = False, recursive: bool = False
- ) -> List[Any]:
+ async def ls(self, uri: str, simple: bool = False, recursive: bool = False) -> List[Any]:
"""List directory contents."""
return await self._service.fs.ls(uri, simple=simple, recursive=recursive)
@@ -181,9 +180,7 @@ class LocalClient(BaseClient):
filter=filter,
)
- async def grep(
- self, uri: str, pattern: str, case_insensitive: bool = False
- ) -> Dict[str, Any]:
+ async def grep(self, uri: str, pattern: str, case_insensitive: bool = False) -> Dict[str, Any]:
"""Content search with pattern."""
return await self._service.fs.grep(uri, pattern, case_insensitive=case_insensitive)
@@ -197,9 +194,7 @@ class LocalClient(BaseClient):
"""Get relations for a resource."""
return await self._service.relations.relations(uri)
- async def link(
- self, from_uri: str, to_uris: Union[str, List[str]], reason: str = ""
- ) -> None:
+ async def link(self, from_uri: str, to_uris: Union[str, List[str]], reason: str = "") -> None:
"""Create link between resources."""
await self._service.relations.link(from_uri, to_uris, reason)
@@ -214,7 +209,7 @@ class LocalClient(BaseClient):
session = self._service.sessions.session()
return {
"session_id": session.session_id,
- "user": session.user,
+ "user": session.user.to_dict(),
}
async def list_sessions(self) -> List[Any]:
@@ -227,7 +222,7 @@ class LocalClient(BaseClient):
session.load()
return {
"session_id": session.session_id,
- "user": session.user,
+ "user": session.user.to_dict(),
"message_count": len(session.messages),
}
@@ -243,9 +238,7 @@ class LocalClient(BaseClient):
"""Extract memories from a session."""
return await self._service.sessions.extract(session_id)
- async def add_message(
- self, session_id: str, role: str, content: str
- ) -> Dict[str, Any]:
+ async def add_message(self, session_id: str, role: str, content: str) -> Dict[str, Any]:
"""Add a message to a session."""
session = self._service.sessions.session(session_id)
session.load()
@@ -289,6 +282,7 @@ class LocalClient(BaseClient):
Session object
"""
from openviking.session import Session
+
return Session(
viking_fs=self._service.viking_fs,
vikingdb_manager=self._service.vikingdb_manager,
@@ -316,4 +310,4 @@ class LocalClient(BaseClient):
@property
def observer(self) -> Any:
"""Get observer service for component status."""
- return self._service.debug.observer
\ No newline at end of file
+ return self._service.debug.observer
diff --git a/openviking/client/session.py b/openviking/client/session.py
index 31f308c21..bb99b6439 100644
--- a/openviking/client/session.py
+++ b/openviking/client/session.py
@@ -7,6 +7,8 @@ Session delegates all operations to the underlying Client (LocalClient or HTTPCl
from typing import TYPE_CHECKING, Any, Dict, List
+from openviking.session.user_id import UserIdentifier
+
if TYPE_CHECKING:
from openviking.client.base import BaseClient
@@ -18,7 +20,7 @@ class Session:
All actual work is delegated to the underlying client.
"""
- def __init__(self, client: "BaseClient", session_id: str, user: str):
+ def __init__(self, client: "BaseClient", session_id: str, user: UserIdentifier):
"""Initialize Session.
Args:
@@ -79,4 +81,4 @@ class Session:
return await self._client.get_session(self.id)
def __repr__(self) -> str:
- return f"Session(id={self.id}, user={self.user})"
+ return f"Session(id={self.id}, user={self.user.__str__()})"
diff --git a/openviking/core/context.py b/openviking/core/context.py
index fcfe4f09e..a674d6705 100644
--- a/openviking/core/context.py
+++ b/openviking/core/context.py
@@ -7,6 +7,8 @@ from enum import Enum
from typing import Any, Dict, List, Optional
from uuid import uuid4
+from openviking.session.user_id import UserIdentifier
+
class ResourceContentType(str, Enum):
"""Resource content type"""
@@ -55,7 +57,7 @@ class Context:
related_uri: Optional[List[str]] = None,
meta: Optional[Dict[str, Any]] = None,
session_id: Optional[str] = None,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
id: Optional[str] = None,
):
"""
@@ -139,9 +141,11 @@ class Context:
"meta": self.meta,
"related_uri": self.related_uri,
"session_id": self.session_id,
- "user": self.user,
}
+ if self.user:
+ data["user"] = self.user.to_dict()
+
# Add skill-specific fields from meta
if self.context_type == "skill":
data["name"] = self.meta.get("name", "")
diff --git a/openviking/service/core.py b/openviking/service/core.py
index 3c42f0532..e229faf6c 100644
--- a/openviking/service/core.py
+++ b/openviking/service/core.py
@@ -19,6 +19,7 @@ from openviking.service.resource_service import ResourceService
from openviking.service.search_service import SearchService
from openviking.service.session_service import SessionService
from openviking.session.compressor import SessionCompressor
+from openviking.session.user_id import UserIdentifier
from openviking.storage import VikingDBManager
from openviking.storage.collection_schemas import init_context_collection
from openviking.storage.viking_fs import VikingFS, init_viking_fs
@@ -44,7 +45,7 @@ class OpenVikingService:
path: Optional[str] = None,
vectordb_url: Optional[str] = None,
agfs_url: Optional[str] = None,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
config: Optional[OpenVikingConfig] = None,
):
"""Initialize OpenViking service.
@@ -65,7 +66,9 @@ class OpenVikingService:
agfs_url=agfs_url,
)
self._config = config
- self.user = config.user
+ self._user = user or UserIdentifier(
+ config.default_account, config.default_user, config.default_agent
+ )
# Infrastructure
self._agfs_manager: Optional[AGFSManager] = None
diff --git a/openviking/service/resource_service.py b/openviking/service/resource_service.py
index 9a7b5b2a7..a86103dd2 100644
--- a/openviking/service/resource_service.py
+++ b/openviking/service/resource_service.py
@@ -9,6 +9,7 @@ Provides resource management operations: add_resource, add_skill, wait_processed
from typing import Any, Dict, Optional
from openviking.exceptions import InvalidArgumentError, NotInitializedError
+from openviking.session.user_id import UserIdentifier
from openviking.storage import VikingDBManager
from openviking.storage.queuefs import get_queue_manager
from openviking.storage.viking_fs import VikingFS
@@ -29,7 +30,7 @@ class ResourceService:
viking_fs: Optional[VikingFS] = None,
resource_processor: Optional[ResourceProcessor] = None,
skill_processor: Optional[SkillProcessor] = None,
- user: str = "default",
+ user: Optional[UserIdentifier] = None,
):
self._vikingdb = vikingdb
self._viking_fs = viking_fs
@@ -43,7 +44,7 @@ class ResourceService:
viking_fs: VikingFS,
resource_processor: ResourceProcessor,
skill_processor: SkillProcessor,
- user: str,
+ user: Optional[UserIdentifier] = None,
) -> None:
"""Set dependencies (for deferred initialization)."""
self._vikingdb = vikingdb
diff --git a/openviking/service/session_service.py b/openviking/service/session_service.py
index 8dedd73cf..682c3c3f0 100644
--- a/openviking/service/session_service.py
+++ b/openviking/service/session_service.py
@@ -11,6 +11,7 @@ from typing import Any, Dict, List, Optional
from openviking.exceptions import NotFoundError, NotInitializedError
from openviking.session import Session
from openviking.session.compressor import SessionCompressor
+from openviking.session.user_id import UserIdentifier
from openviking.storage import VikingDBManager
from openviking.storage.viking_fs import VikingFS
from openviking.utils import get_logger
@@ -26,25 +27,25 @@ class SessionService:
vikingdb: Optional[VikingDBManager] = None,
viking_fs: Optional[VikingFS] = None,
session_compressor: Optional[SessionCompressor] = None,
- user: str = "default",
+ user: Optional[UserIdentifier] = None,
):
self._vikingdb = vikingdb
self._viking_fs = viking_fs
self._session_compressor = session_compressor
- self._user = user
+ self._user = user or UserIdentifier.the_default_user()
def set_dependencies(
self,
vikingdb: VikingDBManager,
viking_fs: VikingFS,
session_compressor: SessionCompressor,
- user: str,
+ user: Optional[UserIdentifier] = None,
) -> None:
"""Set dependencies (for deferred initialization)."""
self._vikingdb = vikingdb
self._viking_fs = viking_fs
self._session_compressor = session_compressor
- self._user = user
+ self._user = user or UserIdentifier.the_default_user()
def _ensure_initialized(self) -> None:
"""Ensure all dependencies are initialized."""
@@ -85,11 +86,13 @@ class SessionService:
name = entry.get("name", "")
if name in [".", ".."]:
continue
- sessions.append({
- "session_id": name,
- "uri": f"{session_base_uri}/{name}",
- "is_dir": entry.get("isDir", False),
- })
+ sessions.append(
+ {
+ "session_id": name,
+ "uri": f"{session_base_uri}/{name}",
+ "is_dir": entry.get("isDir", False),
+ }
+ )
return sessions
except Exception:
return []
diff --git a/openviking/session/compressor.py b/openviking/session/compressor.py
index b6d9aae51..5ff944476 100644
--- a/openviking/session/compressor.py
+++ b/openviking/session/compressor.py
@@ -8,10 +8,11 @@ Uses MemoryExtractor for 6-category extraction and MemoryDeduplicator for LLM-ba
"""
from dataclasses import dataclass
-from typing import Dict, List
+from typing import Dict, List, Optional
from openviking.core.context import Context, Vectorize
from openviking.message import Message
+from openviking.session.user_id import UserIdentifier
from openviking.storage import VikingDBManager
from openviking.storage.viking_fs import get_viking_fs
from openviking.utils import get_logger
@@ -65,8 +66,8 @@ class SessionCompressor:
async def extract_long_term_memories(
self,
messages: List[Message],
- user: str,
- session_id: str,
+ user: Optional["UserIdentifier"] = None,
+ session_id: Optional[str] = None,
) -> List[Context]:
"""Extract long-term memories from messages."""
if not messages:
@@ -108,7 +109,11 @@ class SessionCompressor:
elif result.decision == DedupDecision.MERGE:
# Only merge for supported categories
- if candidate.category in MERGE_SUPPORTED_CATEGORIES and result.similar_memories and viking_fs:
+ if (
+ candidate.category in MERGE_SUPPORTED_CATEGORIES
+ and result.similar_memories
+ and viking_fs
+ ):
target_memory = result.similar_memories[0]
try:
existing_content = await viking_fs.read_file(target_memory.uri)
diff --git a/openviking/session/session.py b/openviking/session/session.py
index 689dbe474..c4701c76f 100644
--- a/openviking/session/session.py
+++ b/openviking/session/session.py
@@ -13,6 +13,7 @@ from typing import TYPE_CHECKING, Any, Dict, List, Optional
from uuid import uuid4
from openviking.message import Message, Part
+from openviking.session.user_id import UserIdentifier
from openviking.utils import get_logger, run_async
from openviking.utils.config import get_openviking_config
@@ -67,14 +68,14 @@ class Session:
viking_fs: "VikingFS",
vikingdb_manager: Optional["VikingDBManager"] = None,
session_compressor: Optional["SessionCompressor"] = None,
- user: str = "default",
+ user: Optional["UserIdentifier"] = None,
session_id: Optional[str] = None,
auto_commit_threshold: int = 8000,
):
self._viking_fs = viking_fs
self._vikingdb_manager = vikingdb_manager
self._session_compressor = session_compressor
- self.user = user or "default"
+ self.user = user or UserIdentifier.the_default_user()
self.session_id = session_id or str(uuid4())
self.created_at = datetime.now()
self._auto_commit_threshold = auto_commit_threshold
@@ -94,9 +95,7 @@ class Session:
return
try:
- content = run_async(
- self._viking_fs.read_file(f"{self._session_uri}/messages.jsonl")
- )
+ content = run_async(self._viking_fs.read_file(f"{self._session_uri}/messages.jsonl"))
self._messages = [
Message.from_dict(json.loads(line))
for line in content.strip().split("\n")
diff --git a/openviking/session/user_id.py b/openviking/session/user_id.py
new file mode 100644
index 000000000..a69e6480f
--- /dev/null
+++ b/openviking/session/user_id.py
@@ -0,0 +1,75 @@
+import hashlib
+import re
+
+
+class UserIdentifier(object):
+ def __init__(self, account_id: str, user_id: str, agent_id: str):
+ self._account_id = account_id
+ self._user_id = user_id
+ self._agent_id = agent_id
+
+ verr = self._validate_error()
+ if verr:
+ raise ValueError(verr)
+
+ @classmethod
+ def the_default_user(cls, default_username: str = "default"):
+ return cls("default", default_username, "default")
+
+ def _validate_error(self) -> str:
+ """Validate the user identifier. all fields must be non-empty strings, and chars only in [a-zA-Z0-9_-]."""
+ pattern = re.compile(r"^[a-zA-Z0-9_-]+$")
+ if not self._account_id:
+ return "account_id is empty"
+ if not pattern.match(self._account_id):
+ return "account_id must be alpha-numeric string."
+ if not self._user_id:
+ return "user_id is empty"
+ if not pattern.match(self._user_id):
+ return "user_id must be alpha-numeric string."
+ if not self._agent_id:
+ return "agent_id is empty"
+ if not pattern.match(self._agent_id):
+ return "agent_id must be alpha-numeric string."
+ return ""
+
+ @property
+ def account_id(self) -> str:
+ return self._account_id
+
+ def unique_space_name(self, short: bool = True) -> str:
+ # 匿名化,只保留 {account_id}_{md5 of user and agent id}
+ hash = hashlib.md5((self._user_id + self._agent_id).encode()).hexdigest()
+ if short:
+ return f"{self._account_id}_{hash[:8]}"
+ return f"{self._account_id}_{hash}"
+
+ def memory_space_uri(self) -> str:
+ return "viking://agent/memories/" + self.unique_space_name()
+
+ def work_space_uri(self) -> str:
+ return "viking://agent/workspaces/" + self.unique_space_name()
+
+ def to_dict(self):
+ return {
+ "account_id": self._account_id,
+ "user_id": self._user_id,
+ "agent_id": self._agent_id,
+ }
+
+ @classmethod
+ def from_dict(cls, data: dict):
+ return cls(data["account_id"], data["user_id"], data["agent_id"])
+
+ def __str__(self) -> str:
+ return f"{self._account_id}:{self._user_id}:{self._agent_id}"
+
+ def __repr__(self) -> str:
+ return self.__str__()
+
+ def __eq__(self, other):
+ return (
+ self._account_id == other._account_id
+ and self._user_id == other._user_id
+ and self._agent_id == other._agent_id
+ )
diff --git a/openviking/utils/config/open_viking_config.py b/openviking/utils/config/open_viking_config.py
index c851b5794..7857951d0 100644
--- a/openviking/utils/config/open_viking_config.py
+++ b/openviking/utils/config/open_viking_config.py
@@ -8,6 +8,8 @@ from typing import Any, Dict, Optional
from pydantic import BaseModel, Field
+from openviking.session.user_id import UserIdentifier
+
from .embedding_config import EmbeddingConfig
from .parser_config import (
AudioConfig,
@@ -27,7 +29,11 @@ from .vlm_config import VLMConfig
class OpenVikingConfig(BaseModel):
"""Main configuration for OpenViking."""
- user: Optional[str] = Field(default="default_user", description="Default user identifier")
+ default_account: Optional[str] = Field(
+ default="default", description="Default account identifier"
+ )
+ default_user: Optional[str] = Field(default="default", description="Default user identifier")
+ default_agent: Optional[str] = Field(default="default", description="Default agent identifier")
storage: StorageConfig = Field(
default_factory=lambda: StorageConfig(), description="Storage configuration"
@@ -229,9 +235,9 @@ def is_valid_openviking_config(config: OpenVikingConfig) -> bool:
"""
errors = []
- # Validate user identifier
- if not config.user or not config.user.strip():
- errors.append("User identifier cannot be empty")
+ # Validate account identifier
+ if not config.default_account or not config.default_account.strip():
+ errors.append("Default account identifier cannot be empty")
# Validate service mode vs embedded mode consistency
is_service_mode = config.storage.vectordb.backend == "http"
@@ -254,7 +260,7 @@ def is_valid_openviking_config(config: OpenVikingConfig) -> bool:
def initialize_openviking_config(
config: Optional[OpenVikingConfig] = None,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
path: Optional[str] = None,
vectordb_url: Optional[str] = None,
agfs_url: Optional[str] = None,
@@ -264,7 +270,7 @@ def initialize_openviking_config(
Args:
config: Optional OpenVikingConfig object to use as base configuration
- user: Username for session management
+ user: UserIdentifier for session management
path: Local storage path for embedded mode
vectordb_url: Remote VectorDB service URL for service mode
agfs_url: Remote AGFS service URL for service mode
@@ -284,8 +290,9 @@ def initialize_openviking_config(
if user:
# Set user if provided, like a email address or a account_id
- user = user.strip().replace(" ", "_")
- config.user = user
+ config.default_account = user._account_id
+ config.default_user = user._user_id
+ config.default_agent = user._agent_id
# Configure storage based on provided parameters
if path:
diff --git a/openviking/utils/skill_processor.py b/openviking/utils/skill_processor.py
index b84a79f34..f340a925f 100644
--- a/openviking/utils/skill_processor.py
+++ b/openviking/utils/skill_processor.py
@@ -12,6 +12,7 @@ from typing import Any, Dict, List, Optional
from openviking.core.context import Context, ContextType, Vectorize
from openviking.core.mcp_converter import is_mcp_format, mcp_to_skill
from openviking.core.skill_loader import SkillLoader
+from openviking.session.user_id import UserIdentifier
from openviking.storage import VikingDBManager
from openviking.storage.queuefs.embedding_msg_converter import EmbeddingMsgConverter
from openviking.storage.viking_fs import VikingFS
@@ -41,7 +42,7 @@ class SkillProcessor:
self,
data: Any,
viking_fs: VikingFS,
- user: Optional[str] = None,
+ user: Optional[UserIdentifier] = None,
) -> Dict[str, Any]:
"""
Process and store a skill.