Skip to content

Clarify Vector Database project guidance - #8092

Merged
kosabogi merged 13 commits into
mainfrom
vector-database-project-context
Sep 8, 2026
Merged

Clarify Vector Database project guidance#8092
kosabogi merged 13 commits into
mainfrom
vector-database-project-context

Conversation

@kosabogi

@kosabogi kosabogi commented Aug 26, 2026

Copy link
Copy Markdown
Member

Summary

  • Add the Vector Database project type and exact value to cross-project search tag guidance.
  • Clarify the Elasticsearch and Vector Database project choices in the Search getting-started flow.
  • Distinguish Elasticsearch Serverless API profiles from the dedicated Vector Database project type using tabs.
  • Recommend the Vector Database project type for embedding-driven workloads on the vector search landing page.

This draft follows the project positioning introduced in #7961. Open product questions are listed in a separate PR comment.

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>
@kosabogi

kosabogi commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

Questions to confirm

@alexmarhaba @dustincoates Before finalizing the content, could you please confirm the following?

  1. Project selection: Is this the intended recommendation: use Vector Database when embeddings and similarity search are central to the workload, and use the Elasticsearch project type for general-purpose or mixed lexical, time series, and analytics workloads?
  2. Agent Builder: I can see Agent Builder in a Vector Database project in QA, and the current Kibana configuration also enables it and includes it in the Vector Database navigation. However, PR #7961 currently tells users to choose the Elasticsearch project type when they need Agent Builder. Is that guidance outdated? Should Agent Builder be removed from that Elasticsearch-specific recommendation, and should we document a Vector Database-specific access path?

@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

✅ 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.

kosabogi and others added 4 commits August 26, 2026 11:16
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>
@alexmarhaba

Copy link
Copy Markdown

Should Agent Builder be removed from that Elasticsearch-specific recommendation, and should we document a Vector Database-specific access path?

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.

@kosabogi
kosabogi marked this pull request as ready for review August 31, 2026 13:18
@kosabogi
kosabogi requested a review from a team as a code owner August 31, 2026 13:18
@kosabogi

Copy link
Copy Markdown
Member Author

2. PR #7961 currently tells users to choose the Elasticsearch project type when they need Agent Builder

Thanks Alex, I left a comment on that PR mentioning this.
cc @yetanothertw

@dustincoates

Copy link
Copy Markdown
Contributor

Project selection: Is this the intended recommendation: use Vector Database when embeddings and similarity search are central to the workload, and use the Elasticsearch project type for general-purpose or mixed lexical, time series, and analytics workloads?

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.

Comment thread solutions/search/vector.md Outdated

@leemthompo leemthompo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread solutions/search/vector/dense-vector.md Outdated
Comment thread solutions/search/get-started.md Outdated
@kosabogi
kosabogi requested a review from a team as a code owner September 7, 2026 08:37
Comment thread solutions/images/serverless-vector-project-selection.jpg Outdated
@kosabogi
kosabogi requested a review from leemthompo September 7, 2026 09:13

@leemthompo leemthompo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My main concern is that the Search get-started page now includes way too much detail about choosing and configuring a project. I'd keep only the concise project-type comparison and creation paths here; move the detailed guidance to the relevant deploy-manage content in #7961.

Comment thread solutions/search/get-started.md
Comment thread solutions/search/vector.md Outdated
@kosabogi

kosabogi commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

My main concern is that the Search get-started page now includes way too much detail about choosing and configuring a project. I'd keep only the concise project-type comparison and creation paths here; move the detailed guidance to the relevant deploy-manage content in #7961.

I agree that this section has grown too long. I applied your suggestions and left a comment on @yetanothertw’s PR requesting clarification about the distinction between the Elasticsearch vector profile and the Vector Database project type, with a link to the detailed profile guidance.

The failing links depend on #7961, which introduces the target section and anchor. I’ll update this branch from main after #7961 merges and the link validation should then pass.

@kosabogi kosabogi mentioned this pull request Sep 8, 2026
2 tasks
@kosabogi
kosabogi merged commit 5258727 into main Sep 8, 2026
13 of 14 checks passed
@kosabogi
kosabogi deleted the vector-database-project-context branch September 8, 2026 15:25
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.

4 participants