-
Notifications
You must be signed in to change notification settings - Fork 258
Clarify Vector Database project guidance #8092
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
Open
kosabogi
wants to merge
6
commits into
main
Choose a base branch
from
vector-database-project-context
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c398fde
Clarify Vector Database project guidance
kosabogi 4720683
Document exact CPS project type values
kosabogi 485c26d
Clarify Serverless vector project configurations
kosabogi 6be91ba
Clarify Vector Database index defaults
kosabogi b1a8ee4
Correct vector landing project guidance
kosabogi 2d93465
Merge branch 'main' into vector-database-project-context
kosabogi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,10 @@ Dense vectors use neural embeddings to represent semantic meaning. They translat | |
| - Performing image and multimedia similarity search | ||
| - Delivering content-based recommendations | ||
|
|
||
| :::{tip} | ||
| If you're using {{serverless-full}}, the [{{es}} Vector Database project type](/solutions/vector-database.md) is recommended when embeddings and similarity search are central to your application. | ||
| ::: | ||
|
|
||
| ## Working with dense vectors in {{es}} | ||
|
|
||
| :::{tip} | ||
|
|
@@ -39,16 +43,27 @@ To implement dense vector search in {{es}}, you need both an index configuration | |
| 2. **Query the index with k-NN search** | ||
| - Use the [`knn` query](knn.md) to retrieve results based on vector similarity | ||
|
|
||
| ### General purpose and vector optimized projects [vector-profiles] | ||
| ### Choose a {{serverless-short}} project configuration [vector-profiles] | ||
| ```{applies_to} | ||
| serverless: | ||
| ``` | ||
|
|
||
| When you use the [API]({{cloud-serverless-apis}}operation/operation-createelasticsearchproject) to create an {{es-serverless}} project, you can choose between two profiles: `general_purpose` and `vector`. | ||
| The general purpose profile is recommended for most search use cases, including full text search, sparse vectors, and dense vectors that use compression such as BBQ. | ||
| The vector profile is recommended only when your use case is based on uncompressed dense vectors with high dimensionality. | ||
| The available configuration depends on your project type. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this information appears too late: users must choose a project before they can index and query data, but the section comes after those implementation steps. and this isn't only about vectors so it also feels a bit misplaced |
||
|
|
||
| :::::{tab-set} | ||
| ::::{tab-item} {{es}} project | ||
| When you use the [API]({{cloud-serverless-apis}}operation/operation-createelasticsearchproject) to create an {{es-serverless}} project, select one of two `optimized_for` profiles: | ||
|
|
||
| For more information about how the profile affects virtual compute unit (VCU) allocation and costs, refer to [](/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md). | ||
| * `general_purpose`: Recommended for most search use cases, including full-text search, sparse vectors, and dense vectors that use compression such as BBQ. | ||
| * `vector`: Recommended only for uncompressed, high-dimensional dense vectors. | ||
|
|
||
| For information about how the profile affects virtual compute unit (VCU) allocation and costs, refer to [](/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md). | ||
| :::: | ||
|
|
||
| ::::{tab-item} {{es}} Vector Database project | ||
| Vector Database projects don't use an `optimized_for` profile. Indices use [`index.mode: vectordb_document`](elasticsearch://reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-vectordb-document-mode) automatically. | ||
| :::: | ||
| ::::: | ||
|
|
||
| ## Better Binary Quantization (BBQ) [bbq] | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
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.
I'd think the "Choose a {{serverless-short}} project configuration" should live alongside this information as they go hand in hand?