Extend embeddings docs - #2788
Open
vkozyura wants to merge 8 commits into
Open
Conversation
vkozyura
marked this pull request as ready for review
July 31, 2026 11:57
BobdenOs
reviewed
Aug 5, 2026
BobdenOs
reviewed
Aug 6, 2026
| CREATE EXTENSION IF NOT EXISTS vector; | ||
| ``` | ||
| - Vectors stored in native `vector` type | ||
| - `vector_embedding()` SQL function uses hash-based algorithm for testing. Override the SQL function to use real embedding services in production. |
Contributor
There was a problem hiding this comment.
This still says "uses hash based".
BobdenOs
reviewed
Aug 6, 2026
| ``` | ||
| - Vectors stored in native `vector` type | ||
| - `vector_embedding()` SQL function uses hash-based algorithm for testing. Override the SQL function to use real embedding services in production. | ||
| - For Node.js, the `pgvector` npm package is only required when you need to read vector columns from query results. If you only pass vectors as parameters (for example, in WHERE clauses or function arguments), the package is not needed: `npm install pgvector` |
Contributor
There was a problem hiding this comment.
This example is not fully accurate and should be double checked. If the vector embedding function is used to create the ending on the fly inside the database the plug-in is not required, but if the client is sending the embedding through a placeholder then the plug-in is still required. The current way it is written is the second example which does require the plug-in.
Contributor
Author
There was a problem hiding this comment.
fixed. hope it is correct now
- Restore H2 reference in local testing info box - Remove HANA mention from testing section, clarify PostgreSQL requires custom vector_embedding function - Link vector functions directly to individual HANA documentation pages to avoid duplication - Clarify l2normalize description with accessible language - Fix PostgreSQL implementation status - no default hash function provided - Remove SQLite section from Database-Specific Considerations (testing-only, internal details) - Add pgvector installation prerequisite for PostgreSQL - Clarify when pgvector npm package is needed (only for reading vector columns) - Remove specific HANA model details to avoid maintenance burden
…iderations Remove incorrect statement about hash-based algorithm. PostgreSQL has no default implementation - developers must define their own function.
Correct the explanation: package IS required when passing vectors as parameters from client or reading vector columns. Only not needed when vectors are generated entirely within the database.
BobdenOs
approved these changes
Aug 12, 2026
Contributor
Author
|
Hi @smahati, from a content perspective, the docs have been reviewed and are ready. Please review them from your side. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs for cap-js/cds-dbs#1676