mirror of
https://github.com/basicmachines-co/basic-memory
synced 2026-06-21 13:47:35 +00:00
docs: add tag: shorthand limitation note to search_notes docstring
The tag: query shorthand doesn't work with hybrid search (default when semantic search is enabled) because it strips the text query. Document the workaround: use search_type="text" or the tags parameter instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: phernandez <paul@basicmachines.co>
This commit is contained in:
@@ -302,6 +302,10 @@ async def search_notes(
|
||||
- `search_notes("work-project", "category:observation")` - Filter by observation categories
|
||||
- `search_notes("team-docs", "author:username")` - Find content by author (if metadata available)
|
||||
|
||||
**Note:** `tag:` shorthand requires `search_type="text"` when semantic search is enabled
|
||||
(the default is hybrid). Alternatively, use the `tags` parameter for tag filtering with
|
||||
any search type: `search_notes("project", "query", tags=["my-tag"])`
|
||||
|
||||
### Search Type Examples
|
||||
- `search_notes("my-project", "Meeting", search_type="title")` - Search only in titles
|
||||
- `search_notes("work-docs", "docs/meeting-*", search_type="permalink")` - Pattern match permalinks
|
||||
|
||||
Reference in New Issue
Block a user