Skip to content

docs: document count(), ChatRole, and MultiVectorQuery maxDistance#25

Open
bsbodden wants to merge 1 commit intomainfrom
bsb/docs-py-catch-up
Open

docs: document count(), ChatRole, and MultiVectorQuery maxDistance#25
bsbodden wants to merge 1 commit intomainfrom
bsb/docs-py-catch-up

Conversation

@bsbodden
Copy link
Collaborator

@bsbodden bsbodden commented Mar 16, 2026

Summary

  • Update message-history docs: count()/count(sessionTag), ChatRole enum, deprecation of llm role
  • Update hybrid-queries docs: MultiVectorQuery with weighted multi-field search, per-vector maxDistance thresholds

Covers the features added in #24.


Note

Low Risk
Low risk documentation-only changes; no runtime behavior is modified.

Overview
Documents multi-vector search by adding a MultiVectorQuery section showing weighted querying across multiple vector fields and per-vector maxDistance thresholds/defaults.

Updates message history docs to reference the ChatRole enum (and deprecate the legacy llm role in favor of assistant) and adds examples for counting messages via MessageHistory.count() and count(sessionTag).

Written by Cursor Bugbot for commit 7e2da7b. This will update automatically on new commits. Configure here.

Update message-history docs to cover:
- ChatRole enum with supported roles (user, assistant, system, tool)
- Deprecation note for the "llm" role
- count() and count(sessionTag) methods

Update hybrid-queries docs to cover:
- MultiVectorQuery for searching across multiple vector fields
- Per-vector maxDistance thresholds with examples
@jit-ci
Copy link

jit-ci bot commented Mar 16, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

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