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

Split query DSL, analyzer, and aggregation sections and add more to analyzer section #4693

Merged
merged 8 commits into from
Aug 8, 2023

Conversation

kolchfa-aws
Copy link
Collaborator

Description

Split query DSL, analyzer, and aggregation sections and add more to analyzer section

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@kolchfa-aws Outstanding job on the writing! I learned valuable info too. My edits/comments are few.

_analyzers/index.md Show resolved Hide resolved

- A _search analyzer_ performs analysis at query time: OpenSearch analyzes the query string when you run a full-text query on a text field. For more information about ways to specify search analyzers, see [Search analyzers]({{site.url}}{{site.baseurl}}/analyzers/search-analyzers/).

In the majority of cases, you should use the same analyzer at indexing time and at search time because then the text field and the query string are analyzed in the same way and the resulting tokens match as expected.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion to tighten: "In most cases,..."

_analyzers/index.md Outdated Show resolved Hide resolved
_analyzers/index.md Outdated Show resolved Hide resolved
_analyzers/search-analyzers.md Outdated Show resolved Hide resolved
_analyzers/search-analyzers.md Outdated Show resolved Hide resolved
# Perform text analysis
# Analyze API

The analyze API allows you to perform [text analysis]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/), which is the process of converting unstructured text into individual tokens (usually words) that are optimized for search.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should "analyze" be capped since we're referring to the API name?

kolchfa-aws and others added 3 commits August 4, 2023 15:53
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!


# Bucket aggregations

Bucket aggregations categorize sets of documents as buckets. The type of bucket aggregation determines whether a given document falls into a bucket or not.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd prefer that we not use the phrasal verb "falls into". Would something like "The type of bucket aggregation determines into which bucket a given document is categorized" work?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Reworded.


Bucket aggregations categorize sets of documents as buckets. The type of bucket aggregation determines whether a given document falls into a bucket or not.

You can use bucket aggregations to implement faceted navigation (usually placed as a sidebar on a search result landing page) to help your users narrow down the results.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"filter" instead of "narrow down"?

_aggregations/metric/index.md Outdated Show resolved Hide resolved
_aggregations/metric/index.md Outdated Show resolved Hide resolved
_aggregations/metric/index.md Outdated Show resolved Hide resolved
_query-dsl/index.md Outdated Show resolved Hide resolved
_query-dsl/index.md Outdated Show resolved Hide resolved
_query-dsl/index.md Outdated Show resolved Hide resolved
_query-dsl/index.md Outdated Show resolved Hide resolved
_search-plugins/index.md Outdated Show resolved Hide resolved
kolchfa-aws and others added 3 commits August 7, 2023 12:50
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
@kolchfa-aws kolchfa-aws merged commit a87fdc0 into main Aug 8, 2023
@kolchfa-aws kolchfa-aws added backport 2.9 PR: Backport label for 2.9 backport 1.3 PR: Backport label for v1.3.x labels Aug 8, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.9 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.9 2.9
# Navigate to the new working tree
pushd ../.worktrees/backport-2.9
# Create a new branch
git switch --create backport/backport-4693-to-2.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a87fdc0f63aae07c41b1cf60294fe5dfe6fcc001
# Push it to GitHub
git push --set-upstream origin backport/backport-4693-to-2.9
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.9

Then, create a pull request where the base branch is 2.9 and the compare/head branch is backport/backport-4693-to-2.9.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-4693-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a87fdc0f63aae07c41b1cf60294fe5dfe6fcc001
# Push it to GitHub
git push --set-upstream origin backport/backport-4693-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-4693-to-1.3.

harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…nalyzer section (opensearch-project#4693)

* Add analyzer documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Add index and search analyzer pages

Signed-off-by: Fanit Kolchina <[email protected]>

* Doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* More doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Update index-analyzers.md

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
vagimeli added a commit that referenced this pull request Dec 21, 2023
…nalyzer section (#4693)

* Add analyzer documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Add index and search analyzer pages

Signed-off-by: Fanit Kolchina <[email protected]>

* Doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* More doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Update index-analyzers.md

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
@kolchfa-aws kolchfa-aws deleted the query-dsl-toc branch March 28, 2024 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.9 PR: Backport label for 2.9
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants