Skip to content

Search: use with_positions_offsets term vector for some fields #7724

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

Merged
merged 1 commit into from
Dec 7, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions readthedocs/search/documents.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,11 @@ class PageDocument(RTDDocTypeMixin, Document):
Simple analyzer will break the text in non-letter characters,
so a text like ``python.submodule`` will be broken like [python, submodule]
instead of [python.submodule].
See more at https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html # noqa

https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html
Some text fields use the ``with_positions_offsets`` term vector,
this is to have faster highlighting on big documents.
See more at https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-vector.html
"""

# Metadata
Expand All @@ -77,7 +80,7 @@ class PageDocument(RTDDocTypeMixin, Document):
properties={
'id': fields.KeywordField(),
'title': fields.TextField(),
'content': fields.TextField(),
'content': fields.TextField(term_vector='with_positions_offsets'),
}
)
domains = fields.NestedField(
Expand All @@ -89,7 +92,7 @@ class PageDocument(RTDDocTypeMixin, Document):

# For showing in the search result
'type_display': fields.TextField(),
'docstrings': fields.TextField(),
'docstrings': fields.TextField(term_vector='with_positions_offsets'),

# Simple analyzer breaks on `.`,
# otherwise search results are too strict for this use case
Expand Down