Skip to content

Conversation

kderusso
Copy link
Member

@kderusso kderusso commented Jan 3, 2025

Documents the following changes from #119011, #118617 and #117839

  • Add lenient parameter to semantic query
  • Highlight that semantic_text works with match and knn (query only) and sparse_vector

@kderusso kderusso added >docs General docs changes auto-backport Automatically create backport pull requests when merged :SearchOrg/Relevance Label for the Search (solution/org) Relevance team v9.0.0 v8.18.0 labels Jan 3, 2025
Copy link
Contributor

github-actions bot commented Jan 3, 2025

Documentation preview:

@kderusso kderusso marked this pull request as ready for review January 3, 2025 16:06
@kderusso kderusso requested a review from a team January 3, 2025 16:06
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-eng (Team:SearchOrg)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-relevance (Team:Search - Relevance)

@kderusso kderusso requested a review from leemthompo January 3, 2025 16:07
The `match` query is the standard query for performing a full-text search,
including options for fuzzy matching.

`Match` will also work against <<semantic-text, semantic_text>> fields.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth adding another note on what match query options can be used with semantic_text fields?
e.g. boost can be used, but specifying fuzziness has no impact when querying semantic_text fields?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good callout, I will update that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated, LMKWYT!

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.

LGTM. @szabosteve is back so tagging for visibility too :)

@leemthompo
Copy link
Contributor

run docs-build

@kderusso kderusso requested review from ioanatia and jimczi January 6, 2025 20:31
Copy link
Contributor

@Mikep86 Mikep86 left a comment

Choose a reason for hiding this comment

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

The content you've added so far looks good. Should we also update the semantic query docs to call out how to perform advanced search using sparse_vector or knn, or at least reference back to each of those queries' docs pages there? We used to have an Advanced search on semantic_text fields section that we removed with the change to the new format, this functionality could be a good reason to bring it back.

@kderusso
Copy link
Member Author

kderusso commented Jan 9, 2025

Should we also update the semantic query docs to call out how to perform advanced search using sparse_vector or knn, or at least reference back to each of those queries' docs pages there?

@Mikep86 This is called out in the field docs. I don't think it should be part of the query docs, because the individual query docs typically refer only to their own queries. I do think we could supplement this with blogs and tutorials in the future, but that may be out of scope for the current PR.

@kderusso kderusso requested a review from Mikep86 January 9, 2025 14:18
Copy link
Contributor

@Mikep86 Mikep86 left a comment

Choose a reason for hiding this comment

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

LGTM!

@kderusso kderusso merged commit c7ec808 into elastic:main Jan 9, 2025
5 checks passed
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.x

kderusso added a commit to kderusso/elasticsearch that referenced this pull request Jan 9, 2025
…9520)

* Update docs with new semantic text functionality

* PR feedback

* PR feedback

* PR Feedback
elasticsearchmachine pushed a commit that referenced this pull request Jan 9, 2025
…119883)

* Update docs with new semantic text functionality

* PR feedback

* PR feedback

* PR Feedback
@kderusso kderusso deleted the kderusso/semantic-text-additional-search-docs branch January 24, 2025 13:53
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 :SearchOrg/Relevance Label for the Search (solution/org) Relevance team v8.18.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants