Skip to content

docs: clarify API search filter description #1786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VictorGTheCoder wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify API search filter description #1786

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd04753
docs: clarify API search filter description
VictorGTheCoder May 22, 2026
6abbf8f
Potential fix for pull request finding
VictorGTheCoder May 22, 2026
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
17 changes: 7 additions & 10 deletions src/memos/api/product_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,18 +400,15 @@ class APISearchRequest(BaseRequest):
)

# ==== Filter conditions ====
# TODO: maybe add detailed description later
filter: dict[str, Any] | None = Field(
None,
description="""
Filter for the memory, example:
{
"`and` or `or`": [
{"id": "uuid-xxx"},
{"created_at": {"gt": "2024-01-01"}},
]
}
""",
description=(
"Optional structured metadata filter for narrowing memory search results. "
"Supports logical operators such as `and` and `or`, plus field-level "
"operator objects. Example: "
'`{"and": [{"field_name": {"eq": "value"}}, {"other_field": {"gte": 10}}]}`. '
"None means no metadata filter is applied."
),
)

# ==== Extended capabilities ====
Expand Down