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]: Update rest of core parameter descriptions #623

Merged
merged 6 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion spec/schemas/_core.reindex.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ components:
size:
description: |-
The number of documents to index per batch.
Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB.
Use the `size` setting when indexing from a remote cluster. This ensures that batches fit inside the on-heap buffer. The buffer defaults to a maximum size of `100MB`.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
slice:
$ref: '_common.yaml#/components/schemas/SlicedScroll'
Expand Down
8 changes: 4 additions & 4 deletions spec/schemas/_core.reindex_rethrottle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ components:
type: object
properties:
batches:
description: The number of scroll responses pulled back by the reindex.
description: The number of scroll responses shown by the reindex.
type: number
created:
description: The number of documents that were successfully created.
Expand All @@ -64,10 +64,10 @@ components:
description: The number of documents that were successfully deleted.
type: number
noops:
description: The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`.
description: The number of documents that were ignored because the script used for the reindex and returned a `noop` value for `ctx.op`.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
requests_per_second:
description: The number of requests per second effectively executed during the reindex.
description: The number of successful requests per second during the reindex.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
retries:
$ref: '_common.yaml#/components/schemas/Retries'
Expand All @@ -83,7 +83,7 @@ components:
description: The number of documents that were successfully processed.
type: number
updated:
description: The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.
description: The number of documents that were successfully updated.
type: number
version_conflicts:
description: The number of version conflicts that reindex hits.
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/_core.scripts_painless_execute.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ components:
type: object
properties:
document:
description: Document that's temporarily indexed in-memory and accessible from the script.
description: A document that's temporarily indexed in-memory and accessible from the painless script.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: object
index:
$ref: '_common.yaml#/components/schemas/IndexName'
Expand Down
46 changes: 23 additions & 23 deletions spec/schemas/_core.search.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ components:
type: object
properties:
total:
description: Total hit count information, present only if `track_total_hits` wasn't `false` in the search request.
description: The total hit count information, present only if `track_total_hits` wasn't set to `false` in the search request.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
oneOf:
- $ref: '#/components/schemas/TotalHits'
- type: integer
Expand Down Expand Up @@ -639,18 +639,18 @@ components:
- text
TrackHits:
description: |-
Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
The number of hits matching the query. When `true`, the exact
number of hits is returned at the cost of some performance. When `false`, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits.
Default is `10,000` hits
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
oneOf:
- type: boolean
- type: integer
format: int32
SourceConfigParam:
description: |-
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
Used as a query parameter along with the `_source_includes` and `_source_excludes` parameters.
Use this setting when a query parameter along with the `_source_includes` and `_source_excludes` parameters.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
oneOf:
- type: boolean
- $ref: '_common.yaml#/components/schemas/Fields'
Expand All @@ -664,7 +664,7 @@ components:
type: integer
format: int32
from:
description: Inner hit starting document offset.
description: The inner hit starting document offset.
Copy link
Contributor

Choose a reason for hiding this comment

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

"The inner hit that initiates document offset"?

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: integer
format: int32
collapse:
Expand Down Expand Up @@ -703,14 +703,14 @@ components:
field:
$ref: '_common.yaml#/components/schemas/Field'
inner_hits:
description: The number of inner hits and their sort order
description: The number of inner hits and their sort order.
oneOf:
- $ref: '#/components/schemas/InnerHits'
- type: array
items:
$ref: '#/components/schemas/InnerHits'
max_concurrent_group_searches:
description: The number of concurrent requests allowed to retrieve the inner_hits per group
description: The number of concurrent requests that are allowed to be retrieved by the `inner_hits` per group.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: integer
required:
- field
Expand Down Expand Up @@ -761,7 +761,7 @@ components:
boundary_scanner_locale:
description: |-
Controls which locale is used to search for sentence and word boundaries.
This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`.
This parameter takes the form of a language tag, for example, `"en-US"`, `"fr-FR"`, `"ja-JP"`.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: string
force_source:
deprecated: true
Expand All @@ -782,8 +782,8 @@ components:
max_analyzed_offset:
description: |-
If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed, thus not highlighted and no error is returned
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to lower value than the query setting.
The rest of the text is not processed, not highlighted, and no error is returned.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to a lower value than the query setting.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to a lower value than the query setting.
The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it is set to a lower value than the query setting.

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: integer
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
format: int32
no_match_size:
Expand All @@ -793,10 +793,10 @@ components:
number_of_fragments:
description: |-
The maximum number of fragments to return.
If the number of fragments is set to `0`, no fragments are returned.
Instead, the entire field contents are highlighted and returned.
This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required.
If `number_of_fragments` is `0`, `fragment_size` is ignored.
When the number of fragments is set to `0`, no fragments are returned.
Instead, the entirety of a field's contents are highlighted and returned.
This is useful when you need to highlight short texts such as a title or address, but fragmentation is not required.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
If `number_of_fragments` is set to `0`, the `fragment_size` is ignored.
type: integer
format: int32
options:
Expand All @@ -808,21 +808,21 @@ components:
phrase_limit:
description: |-
Controls the number of matching phrases in a document that are considered.
Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory.
Only supported by the `fvh` highlighter.
This prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory.
When using `matched_fields`, phrase limited phrases per matched field are considered. Raising the limit increases the query time and consumes more memory.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
This setting is only supported by the `fvh` highlighter.
type: integer
format: int32
post_tags:
description: |-
Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text.
When used in conjunction with `pre_tags`, defines the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `<em>` and `</em>` tags.
type: array
items:
type: string
pre_tags:
description: |-
Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text.
When used in conjunction with `post_tags`, defines the HTML tags to use for the highlighted text.
By default, highlighted text is wrapped in `<em>` and `</em>` tags.
type: array
items:
Expand Down Expand Up @@ -899,11 +899,11 @@ components:
rescore_query:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
query_weight:
description: Relative importance of the original query versus the rescore query.
description: The relative importance of the original query versus the rescore query.
Copy link
Contributor

Choose a reason for hiding this comment

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

"versus" => "as compared to"?

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
format: float
rescore_query_weight:
description: Relative importance of the rescore query versus the original query.
description: The relative importance of the rescore query versus the original query.
Copy link
Contributor

Choose a reason for hiding this comment

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

"versus" => "as compared to"?

Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
format: float
score_mode:
Expand All @@ -922,7 +922,7 @@ components:
type: object
properties:
text:
description: Global suggest text, to avoid repetition when the same text is used in several suggesters
description: The global suggest text, to avoid repetition when the same text is used in several suggesters
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: string
Copy link
Contributor Author

Choose a reason for hiding this comment

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

PointInTimeReference:
type: object
Expand Down
10 changes: 5 additions & 5 deletions spec/schemas/_core.termvectors.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ components:
properties:
max_doc_freq:
description: |-
Ignore words which occur in more than this many docs.
Defaults to unbounded.
Ignore words which occur in more than the number of docs indicated.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
Default is unbounded.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
max_num_terms:
description: Maximum number of terms that must be returned per field.
description: The maximum number of terms that must be returned per field.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
max_term_freq:
description: |-
Ignore words with more than this frequency in the source doc.
Defaults to unbounded.
Default is unbounded.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
max_word_length:
description: |-
The maximum word length above which words will be ignored.
Defaults to unbounded.
Default is unbounded.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
type: number
min_doc_freq:
description: Ignore terms which do not occur in at least this many docs.
Expand Down
Loading