-
Couldn't load subscription status.
- Fork 394
docs: add page for couchbase_query (CouchbaseQueryVectorStore) and refactor existing Couchbase docs #1079
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.
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
base: main
Are you sure you want to change the base?
docs: add page for couchbase_query (CouchbaseQueryVectorStore) and refactor existing Couchbase docs #1079
Conversation
44f9441 to
a45f8e0
Compare
6edfde6 to
17b9ade
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for the new CouchbaseQueryVectorStore implementation and refactors existing Couchbase vector store documentation to distinguish between two different approaches: the Query-based implementation (new, preferred) and the Search-based implementation (existing). The changes clarify that Couchbase now offers two methods for vector search using different services.
Key changes:
- Adds comprehensive documentation for
CouchbaseQueryVectorStoreincluding setup, usage, indexing options, and comparisons - Renames existing Couchbase documentation to
couchbase_search.mdxto reflect its use of the Search Service - Updates navigation and card references to distinguish between "Couchbase Query" and "Couchbase Search"
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/oss/javascript/integrations/vectorstores/index.mdx |
Updates card titles and links to distinguish between Query and Search implementations |
src/oss/javascript/integrations/vectorstores/couchbase_search.mdx |
Refines title and clarifies this implementation uses the Search Service |
src/oss/javascript/integrations/vectorstores/couchbase_query.mdx |
New comprehensive documentation page for the Query-based vector store implementation |
src/oss/javascript/integrations/providers/all_providers.mdx |
Updates provider cards to show both Query (recommended) and Search implementations |
src/oss/javascript/integrations/vectorstores/couchbase_query.mdx
Outdated
Show resolved
Hide resolved
src/oss/javascript/integrations/vectorstores/couchbase_query.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| - `DistanceStrategy.L2` - L2 (Euclidean) distance | ||
| - `DistanceStrategy.EUCLIDEAN` - Euclidean distance |
Copilot
AI
Oct 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lines 260 and 261 both describe the same distance metric (Euclidean distance). Having both L2 and EUCLIDEAN listed separately with the same description is confusing for users. Please clarify if these are truly identical or if there are subtle implementation differences that should be documented.
| - `DistanceStrategy.L2` - L2 (Euclidean) distance | |
| - `DistanceStrategy.EUCLIDEAN` - Euclidean distance | |
| - `DistanceStrategy.L2`/`DistanceStrategy.EUCLIDEAN` - Euclidean (L2) distance |
| - `DistanceStrategy.L2_SQUARED` - Squared L2 distance | ||
| - `DistanceStrategy.EUCLIDEAN_SQUARED` - Squared Euclidean distance |
Copilot
AI
Oct 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to the previous issue, L2_SQUARED and EUCLIDEAN_SQUARED appear to be redundant entries describing the same metric. Consider consolidating these or explicitly documenting any differences between the two strategies.
| - `DistanceStrategy.L2_SQUARED` - Squared L2 distance | |
| - `DistanceStrategy.EUCLIDEAN_SQUARED` - Squared Euclidean distance | |
| - `DistanceStrategy.L2_SQUARED` - Squared L2 (Euclidean) distance |
Overview
Type of change
Type: New documentation page
Related issues/PRs
Checklist
docs devsrc/docs.jsonif neededAdditional notes