Skip to content

docs(python): document context_query search modes (regex/semantic/temporal)#16

Open
lukemartinlogan wants to merge 1 commit into
mainfrom
docs/context-query-search-modes
Open

docs(python): document context_query search modes (regex/semantic/temporal)#16
lukemartinlogan wants to merge 1 commit into
mainfrom
docs/context-query-search-modes

Conversation

@lukemartinlogan

Copy link
Copy Markdown
Contributor

Summary

context_query gained prompt, time_begin, and time_end keyword arguments that select among three search modes. This updates the Python API reference (docs/api/python.md) to document them.

Changes

  • Full signature with the new keyword arguments and defaults.
  • Per-parameter docs, including the semantic result-cap fallback (max_results defaults to 10 for semantic).
  • A mode-selection table (regex / semantic / temporal) plus the priority order: temporal > semantic > regex.
  • Clarify that both regex patterns are full-string (std::regex_match) — substring matching needs .*pattern.*.
  • Worked examples for each mode, and updated end-to-end snippets to the keyword-argument style.

Docs-only change.

🤖 Generated with Claude Code

…poral)

context_query gained `prompt`, `time_begin`, and `time_end` keyword
arguments that select among three search modes. Update the Python API
reference to cover them:

- Full signature with the new keyword arguments and their defaults.
- Per-parameter docs, including the semantic result cap fallback (10).
- A mode-selection table (regex / semantic / temporal) and the priority
  order (temporal > semantic > regex).
- Note that both regex patterns are full-string (std::regex_match), so
  substring matching needs `.*pattern.*`.
- Worked examples for each mode, plus updated end-to-end snippets.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant