Skip to content
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

Group vector queries into new section #110722

Merged

Conversation

carlosdelest
Copy link
Member

@carlosdelest carlosdelest commented Jul 10, 2024

Group together vector queries in a new Query DSL section. Moves vector queries from the specialized queries section.

This helps creating a base page for vector queries, avoid the queries being scattered, and cleans up a bit the Query DSL section.

This is the new Query DSL layout:

image

@carlosdelest carlosdelest added >docs General docs changes Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v8.15.0 Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v8.16.0 labels Jul 10, 2024
Copy link
Contributor

Documentation preview:

@carlosdelest carlosdelest marked this pull request as ready for review July 10, 2024 17:07
@elasticsearchmachine elasticsearchmachine removed the Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch label Jul 10, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

[[vector-queries]]
== Vector queries

Vector queries search efficiently for vectors in order to perform <<semantic-search,semantic search>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

May be better phrase like this: "Vector queries are specialized queries that work on vector fields to efficiently perform semantic search"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I like that, thanks!

Copy link
Contributor

@mayya-sharipova mayya-sharipova left a comment

Choose a reason for hiding this comment

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

@carlosdelest Thanks, makes sense

Copy link
Contributor

@ChrisHegarty ChrisHegarty left a comment

Choose a reason for hiding this comment

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

LGTM

@carlosdelest carlosdelest requested a review from a team July 11, 2024 07:19
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

This looks great @carlosdelest!

One thought was to perhaps group text_expansion and weighted_tokens into an appendix called something like "Legacy vector queries" to communicate visually that they have been superseded. WDYT?

<<query-dsl-semantic-query,`semantic` query>>::
A query that allows you to perform semantic search on <<semantic-text,`semantic_text`>> fields.

=== Deprecated vector queries
Copy link
Member Author

Choose a reason for hiding this comment

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

@leemthompo , WDYT? I think adding an additional WARN is overkill, but double checking.

Copy link
Contributor

Choose a reason for hiding this comment

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

Note-perfect as always @carlosdelest 👍

@@ -12,6 +12,7 @@ A query used to search <<sparse-vector,`sparse_vector`>> field types.
<<query-dsl-semantic-query,`semantic` query>>::
A query that allows you to perform semantic search on <<semantic-text,`semantic_text`>> fields.

[discrete]
Copy link
Contributor

Choose a reason for hiding this comment

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

::shakes fist::

@carlosdelest carlosdelest merged commit f29b92c into elastic:main Jul 11, 2024
5 checks passed
carlosdelest added a commit to carlosdelest/elasticsearch that referenced this pull request Jul 11, 2024
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants