Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions src/memos/api/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
MemOSGetMemoryResponse,
MemOSGetMessagesResponse,
MemOSGetTaskStatusResponse,
MemOSListKnowledgebaseFileResponse,
MemOSListKnowledgebaseResponse,
MemOSSearchResponse,
)
from memos.log import get_logger
Expand Down Expand Up @@ -65,6 +67,14 @@ def _validate_required_params(self, **params):
if not param_value:
raise ValueError(f"{param_name} is required")

@staticmethod
def _validate_page_size(*, page: int, size: int, max_size: int = 100) -> None:
"""Validate 1-based pagination params used by knowledgebase list endpoints."""
if not isinstance(page, int) or page < 1:
raise ValueError("page must be an integer >= 1")
if not isinstance(size, int) or size < 1 or size > max_size:
raise ValueError(f"size must be an integer in [1, {max_size}]")

def get_message(
self,
user_id: str,
Expand Down Expand Up @@ -417,6 +427,96 @@ def get_knowledgebase_file(
if retry == MAX_RETRY_COUNT - 1:
raise

def list_knowledgebases(
self, page: int = 1, size: int = 10
) -> MemOSListKnowledgebaseResponse | None:
"""
List knowledgebases owned by the authenticated caller.

Issue #1382 — adds the missing list endpoint so callers can enumerate
KB ids without having to remember them out of band.

Args:
page: 1-based page index. Must be >= 1.
size: Page size. Must be in [1, 100].

Returns:
``MemOSListKnowledgebaseResponse`` on success, or ``None`` if all
retries were exhausted (the underlying exception is re-raised on
the final retry, mirroring the rest of this client).
"""
# Validate pagination
self._validate_page_size(page=page, size=size)

url = f"{self.base_url}/list/knowledgebase"
payload = {
"page": page,
"size": size,
}

for retry in range(MAX_RETRY_COUNT):
try:
response = requests.post(
url, data=json.dumps(payload), headers=self.headers, timeout=30
)
response.raise_for_status()
response_data = response.json()

return MemOSListKnowledgebaseResponse(**response_data)
except Exception as e:
logger.error(f"Failed to list knowledgebase (retry {retry + 1}/3): {e}")
if retry == MAX_RETRY_COUNT - 1:
raise

def list_knowledgebase_documents(
self,
knowledgebase_id: str,
page: int = 1,
size: int = 10,
) -> MemOSListKnowledgebaseFileResponse | None:
"""
List documents (files) inside a knowledgebase.

Issue #1382 — many downstream use cases (bulk delete, UI listing,
verifying ingest) need to enumerate the files of a KB without
knowing each ``file_id`` ahead of time.

Args:
knowledgebase_id: target knowledgebase identifier.
page: 1-based page index. Must be >= 1.
size: Page size. Must be in [1, 100].

Returns:
``MemOSListKnowledgebaseFileResponse`` on success, or ``None``
if all retries were exhausted (the underlying exception is
re-raised on the final retry).
"""
# Validate required parameters
self._validate_required_params(knowledgebase_id=knowledgebase_id)
# Validate pagination
self._validate_page_size(page=page, size=size)

url = f"{self.base_url}/list/knowledgebase-file"
payload = {
"knowledgebase_id": knowledgebase_id,
"page": page,
"size": size,
}

for retry in range(MAX_RETRY_COUNT):
try:
response = requests.post(
url, data=json.dumps(payload), headers=self.headers, timeout=30
)
response.raise_for_status()
response_data = response.json()

return MemOSListKnowledgebaseFileResponse(**response_data)
except Exception as e:
logger.error(f"Failed to list knowledgebase-file (retry {retry + 1}/3): {e}")
if retry == MAX_RETRY_COUNT - 1:
raise

def get_task_status(self, task_id: str) -> MemOSGetTaskStatusResponse | None:
"""
get task status
Expand Down
66 changes: 66 additions & 0 deletions src/memos/api/product_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -1246,6 +1246,72 @@ def files(self) -> list[FileDetail]:
return self.data.file_detail_list


class ListKnowledgebaseData(BaseModel):
"""Data model for list knowledgebase response based on actual API.

Schema kept loose (`extra="allow"`) so the SDK does not break if the
server adds new fields.
"""

model_config = {"extra": "allow"}

knowledgebase_list: list[dict[str, Any]] = Field(
default_factory=list,
alias="knowledgebase_list",
description="List of knowledgebase summaries",
)
total: int | None = Field(
None, description="Total knowledgebase count if returned by the server"
)
page: int | None = Field(None, description="Current page index (1-based) if returned")
size: int | None = Field(None, description="Page size if returned")


class MemOSListKnowledgebaseResponse(BaseModel):
"""Response model for list knowledgebase operation based on actual API."""

code: int = Field(..., description="Response status code")
message: str = Field(..., description="Response message")
data: ListKnowledgebaseData = Field(..., description="List results data")

@property
def knowledgebases(self) -> list[dict[str, Any]]:
"""Convenient access to knowledgebase list."""
return self.data.knowledgebase_list


class ListKnowledgebaseFileData(BaseModel):
"""Data model for list knowledgebase-file response based on actual API.

Reuses the loose `FileDetail` model so the SDK stays compatible with
new server-side fields.
"""

model_config = {"extra": "allow"}

file_detail_list: list[FileDetail] = Field(
default_factory=list,
alias="file_detail_list",
description="List of file details inside the knowledgebase",
)
total: int | None = Field(None, description="Total file count if returned by the server")
page: int | None = Field(None, description="Current page index (1-based) if returned")
size: int | None = Field(None, description="Page size if returned")


class MemOSListKnowledgebaseFileResponse(BaseModel):
"""Response model for list knowledgebase-file operation based on actual API."""

code: int = Field(..., description="Response status code")
message: str = Field(..., description="Response message")
data: ListKnowledgebaseFileData = Field(..., description="List results data")

@property
def files(self) -> list[FileDetail]:
"""Convenient access to file list."""
return self.data.file_detail_list


class MemOSAddResponse(BaseModel):
"""Response model for add message operation based on actual API."""

Expand Down
Loading
Loading