Skip to content

Adds a new vector and full-text search quickstart - #7923

Open
kosabogi wants to merge 8 commits into
mainfrom
vector-full-text-search-quickstart
Open

Adds a new vector and full-text search quickstart#7923
kosabogi wants to merge 8 commits into
mainfrom
vector-full-text-search-quickstart

Conversation

@kosabogi

@kosabogi kosabogi commented Aug 12, 2026

Copy link
Copy Markdown
Member

This PR adds a new vector and full-text search quickstart that:

  • Guides users through connecting official Elasticsearch clients, creating an index, and indexing sample data.
  • Demonstrates semantic search, hybrid search, and ES|QL aggregation.
  • Provides examples and complete runnable scripts for Python, TypeScript, PHP, Ruby, C#/.NET, Java, and Go.

Testing

All seven client examples were tested end to end with Claude against Elasticsearch. The tests verified the expected search rankings and ES|QL aggregation output.

Manually testing the tutorial: WIP

  • Python
  • TypeScript
  • PHP
  • Ruby
  • C#/.NET
  • Java
  • Go

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Claude, Cursor - GPT 5.6

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

kosabogi and others added 3 commits August 12, 2026 12:17
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 2 warnings found

⚠️ Warnings (2): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
solutions/vector-database/vector-full-text-search.md 512 Elastic.MenuArrows Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy.
solutions/vector-database/vector-full-text-search.md 512 Elastic.MenuArrows Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy.

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

kosabogi commented Aug 13, 2026

Copy link
Copy Markdown
Member Author

Hi @alexmarhaba @dustincoates @georgewallace @KOTungseth @leemthompo ,

I've added the tutorial here, so please feel free to review it from now on.

These commits include the modifications we agreed on in our last call.

All commits include additional content refinements. I ran our review guidelines against this content and found a few areas that I thought would benefit from some small tweaks based on our guidelines. These include:

  • Improved the introduction to clarify the tutorial’s purpose, audience, and expected outcomes
  • Simplified the tutorial structure by removing unnecessary H3 headings
  • Expanded a few explanations
  • Replaced hardcoded product names with substitutions
  • Organized the Next steps part into subsections
  • Updated code examples based on end-to-end tests performed with Claude. For these, I'd love someone from the engineering team to take a close look even though the end-to-end tests were successful

All these changes are negotiable. Please let me know what you think.

Thank you in advance!

::::{tab-item} macOS and Linux

```bash
export ES_URL="https://YOUR-PROJECT.es.REGION.aws.elastic.cloud:443"

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 need to tell folks how to find this: https://www.elastic.co/docs/solutions/elasticsearch-solution-project/search-connection-details

(#7709 is updating that page)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

In this step we advise users to copy those from the Getting started page they land on when they create a new project. I was also considering adding guidance for cases where they navigate to other pages, but I was afraid that would make the text unnecessarily longer. I'm leaning towards what we have in the Create a project step being enough, but I'm happy to add the Search connection details page if you'd suggest it.

@dustincoates

Copy link
Copy Markdown
Contributor

I took a quick glance and it looks good to me, thanks!

navigation_title: Vector and full-text search
description: Step-by-step tutorial for connecting an application to an Elasticsearch Vector Database project, indexing data, and running full-text, semantic, hybrid, and ES|QL searches.
applies_to:
serverless: ga

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.

If this page is intended for this particular project type, then we can use the new product id I've created for it.

See more details in https://github.com/elastic/docs-content-internal/issues/1534

@yetanothertw yetanothertw Aug 20, 2026

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.

Also, this is now merged and should be released soon, so with the new version of docs-builder, you'll be able to tag the page with the applies_to tag as well.

@yetanothertw yetanothertw mentioned this pull request Aug 14, 2026
2 tasks
@kosabogi

kosabogi commented Aug 19, 2026

Copy link
Copy Markdown
Member Author

After testing the tutorial end to end thoroughly, I found that the previous structure mixed two usage models. Users were expected to add snippets to one file and rerun it for verification, but rerunning attempted to recreate the books index and failed with resource_already_exists_exception. Individual examples also depended on earlier imports and initialization, so they could not be tested independently.

The guide was still usable when followed as a single uninterrupted flow, but the overall user experience did not feel clear or intuitive.

Since we agreed that each step should be independently verifiable to support users’ understanding and learning, I updated the tutorial to provide two clear paths:

  • Progressive steps: Standalone, verifiable examples with the required setup and detailed explanations.
  • Complete runnable script: One file for quick results, using a separate index to avoid conflicts.

Happy to tweak anything based on feedback.

@KOTungseth @alexmarhaba @dustincoates @georgewallace

@kosabogi
kosabogi marked this pull request as ready for review August 19, 2026 14:24
@kosabogi
kosabogi requested review from a team as code owners August 19, 2026 14:24
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