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

Correct the type of the 'analyzer' parameter in the _analyze docs. #56650

Merged
merged 3 commits into from
May 13, 2020

Conversation

jtibshirani
Copy link
Contributor

This optional parameter can only be a string. To test out a transient custom
analysis chain, users are expected to use the 'tokenizer', 'filter', and
'char_filter' parameters.

Relates to #56586.

This optional parameter can only be a string. To test out a transient custom
analysis chain, users are expected to use the 'tokenizer', 'filter', and
'char_filter' parameters.
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label May 12, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (:Search/Analysis)

@elasticmachine elasticmachine added the Team:Search Meta label for search team label May 12, 2020
Copy link
Member

@cbuescher cbuescher left a comment

Choose a reason for hiding this comment

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

LGTM. I left a suggestion for a possible addition but would also go without it if you think its to distracting to mention at that point.

You can also provide a <<analysis-custom-analyzer,custom analyzer>>.
(Optional, string)
The name of the analyzer that should be applied to the provided `text`. See <<analysis-analyzers>>
for a list of built-in analyzers.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can mention that this also works for a custom analyzer that is defined in an index if "_analyze" is used on that index.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a sentence to clarify that this can be any analyzer configured in the index, and not just a built-in analyzer.

@jtibshirani
Copy link
Contributor Author

Thanks for the review !

@jtibshirani jtibshirani merged commit 7c316e3 into elastic:master May 13, 2020
@jtibshirani jtibshirani deleted the analyze-request-docs branch May 13, 2020 18:02
jtibshirani added a commit that referenced this pull request May 13, 2020
…56650)

This optional parameter can only be a string. To test out a transient custom
analysis chain, users are expected to use the 'tokenizer', 'filter', and
'char_filter' parameters.
jtibshirani added a commit that referenced this pull request May 13, 2020
…56650)

This optional parameter can only be a string. To test out a transient custom
analysis chain, users are expected to use the 'tokenizer', 'filter', and
'char_filter' parameters.
jtibshirani added a commit that referenced this pull request May 13, 2020
…56650)

This optional parameter can only be a string. To test out a transient custom
analysis chain, users are expected to use the 'tokenizer', 'filter', and
'char_filter' parameters.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search Relevance/Analysis How text is split into tokens Team:Docs Meta label for docs team Team:Search Meta label for search team v7.7.0 v7.8.0 v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants