Clarify Vector Database project guidance - #8092
Conversation
Distinguish the dedicated project type from Elasticsearch profiles and surface it where users select projects or route cross-project searches. Co-authored-by: Cursor <cursoragent@cursor.com>
Questions to confirm@alexmarhaba @dustincoates Before finalizing the content, could you please confirm the following?
|
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Use the API values readers need when filtering or routing by the predefined project type tag. Co-authored-by: Cursor <cursoragent@cursor.com>
Separate Elasticsearch profiles from the Vector Database index mode so readers can select the correct configuration for their project type. Co-authored-by: Cursor <cursoragent@cursor.com>
Surface the separate project type and its automatic vector index mode where readers first learn about vector search. Co-authored-by: Cursor <cursoragent@cursor.com>
Recommend the Vector Database project for embedding-driven Serverless workloads without duplicating lower-level configuration details. Co-authored-by: Cursor <cursoragent@cursor.com>
Agent builder is available on all project types, so not sure why we're recommending to use ES for it here, I would remove that mention. |
Thanks Alex, I left a comment on that PR mentioning this. |
That would be a good way to put it. We'll probably want to eventually change it so that more and more of the mixed workloads move over to VDB, but for now, I think this is good. |
| # Vector search in {{es}} | ||
|
|
||
| :::{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. |
There was a problem hiding this comment.
We should avoid admonitions at the very top of a page as much as possible. This has been abused in the past. This info can go in a dedicated subsection, as high as you like in the tree. This TIP now has 3 different links, which is a recipe for immediate user confusion.
leemthompo
left a comment
leemthompo
left a comment
There was a problem hiding this comment.
We're now distributing decision guidance across get-started.md, vector.md, dense-vector.md.
Think about presenting this together on one neutral comparison page or in one expanded "Choose your deployment type" section in get-started.md. The vector overview and dense-vector pages could then link to that guidance instead of duplicating partial recommendations.
The page needs to compare:
- Elasticsearch with general_purpose
- Elasticsearch with vector
- Elasticsearch VDB
A comparison table might be clearer than tabs because users need to evaluate all three choices together.
| 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. |
There was a problem hiding this comment.
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
| ::: | ||
|
|
||
| If you're not sure which project type to choose, select the **{{es}}** project type. This project type provides core {{es}} search capabilities along with additional UI tools to help you build search-powered applications faster. | ||
| Select the project type that matches your workload: |
There was a problem hiding this comment.
I'd think the "Choose a {{serverless-short}} project configuration" should live alongside this information as they go hand in hand?
4 participants
Summary
This draft follows the project positioning introduced in #7961. Open product questions are listed in a separate PR comment.