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

[DOCS] Add token graph concept docs #53339

Merged
merged 11 commits into from
Mar 19, 2020
Merged

[DOCS] Add token graph concept docs #53339

merged 11 commits into from
Mar 19, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 10, 2020

Adds conceptual docs for token graphs.
These docs cover:

  • How a token graph is constructed from a token stream
  • How synonyms and multi-position tokens impact token graphs
  • How token graphs are used during search
  • Why some token filters produce invalid token graphs

Also makes the following supporting changes:

  • Adds anchors to the Anatomy of an Analyzer docs for cross-linking
  • Adds several SVGs for token graph diagrams

Preview link

http://elasticsearch_53339.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/token-graphs.html

Adds conceptual docs for token graphs.
These docs cover:

* How a token graph is constructed from a token stream
* How synonyms and multi-position tokens impact token graphs
* How token graphs are used during search
* Why some token filters produce invalid token graphs

Also makes the following supporting changes:
* Adds anchors to the 'Anatomy of an Analyzer' docs for cross-linking
* Adds several SVGs for token graph diagrams
@jrodewig jrodewig added >docs General docs changes :Search Relevance/Analysis How text is split into tokens labels Mar 10, 2020
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

Copy link
Contributor

@jimczi jimczi left a comment

Choose a reason for hiding this comment

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

❤️ @jrodewig
I left one comment, we could also add a link to this new section in the synonym_graph and word-delimiter-graph docs ?

<<analysis-index-search-time,Indexing>> ignores the `positionLength` attribute
and does not support token graphs containing multi-position tokens.

However, queries, such as the <<query-dsl-match-query-phrase,`match_phrase`>>
Copy link
Contributor

Choose a reason for hiding this comment

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

match queries are also affected. The input ny city with a ny, new york expansion creates an incorrect (ny OR new) AND york AND city query with the synonym filter.

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 updated this with d4a711d to mention the match query.

@jrodewig
Copy link
Contributor Author

Thanks @jimczi. I've added some cross-links to this page in the synonym_graph and word-delimiter-graph docs.

@jrodewig jrodewig merged commit 8d5478f into elastic:master Mar 19, 2020
@jrodewig jrodewig deleted the docs__add-token-graph-concepts branch March 19, 2020 11:42
jrodewig added a commit that referenced this pull request Mar 19, 2020
Adds conceptual docs for token graphs.
These docs cover:

* How a token graph is constructed from a token stream
* How synonyms and multi-position tokens impact token graphs
* How token graphs are used during search
* Why some token filters produce invalid token graphs

Also makes the following supporting changes:
* Adds anchors to the 'Anatomy of an Analyzer' docs for cross-linking
* Adds several SVGs for token graph diagrams
jrodewig added a commit that referenced this pull request Mar 19, 2020
Adds conceptual docs for token graphs.
These docs cover:

* How a token graph is constructed from a token stream
* How synonyms and multi-position tokens impact token graphs
* How token graphs are used during search
* Why some token filters produce invalid token graphs

Also makes the following supporting changes:
* Adds anchors to the 'Anatomy of an Analyzer' docs for cross-linking
* Adds several SVGs for token graph diagrams
@jrodewig
Copy link
Contributor Author

Backport commits

master 8d5478f
7.x 8f4a3eb
7.6 f27c188

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 v7.6.3 v7.7.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants