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

Add vector search documentation #9135

Open
wants to merge 31 commits into
base: main
Choose a base branch
from

Merge branch 'vector-restructure' of https://github.com/opensearch-pr…

e2a1cf9
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Open

Add vector search documentation #9135

Merge branch 'vector-restructure' of https://github.com/opensearch-pr…
e2a1cf9
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Feb 14, 2025 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (5)

_vector-search/ml-powered-search/multimodal-search.md|113 col 153| [OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.
_vector-search/ml-powered-search/semantic-search.md|120 col 153| [OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.
_vector-search/performance-tuning-search.md|47 col 24| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_vector-search/vector-search-techniques/knn-score-script.md|22 col 18| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_vector-search/optimizing-storage/binary-quantization.md|13 col 167| [OpenSearch.UnitsSpacing] Put a space between the number and the units in '0s '.

Filtered Findings (2808)

_automating-configurations/workflow-security.md|21 col 295| [OpenSearch.Spelling] Error: _framework. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_automating-configurations/api/create-workflow.md|139 col 70| [OpenSearch.HeadingAcronyms] '(YAML)': Don't define acronyms in headings.
_automating-configurations/workflow-steps.md|57 col 17| [OpenSearch.Spelling] Error: parallelization. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_automating-configurations/workflow-builder.md|23 col 4| [OpenSearch.HeadingCapitalization] 'Accessing OpenSearch Flow' is a heading and should be in sentence case.
_automating-configurations/workflow-builder.md|72 col 162| [OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.
_automating-configurations/workflow-builder.md|95 col 296| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/app-analytics.md|23 col 12| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/app-analytics.md|28 col 17| [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.
_observing-your-data/app-analytics.md|36 col 13| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/notifications/index.md|26 col 216| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/log-ingestion.md|9 col 3| [OpenSearch.HeadingCapitalization] 'Log Ingestion' is a heading and should be in sentence case.
_observing-your-data/log-ingestion.md|23 col 1| [OpenSearch.DirectionAboveBelow] Use 'following example' instead of 'example below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/log-ingestion.md|42 col 34| [OpenSearch.SubstitutionsError] Use 'ingest pipeline' instead of 'ingestion pipeline'.
_observing-your-data/log-ingestion.md|42 col 234| [OpenSearch.SubstitutionsError] Use 'ingest pipeline' instead of 'ingestion pipeline'.
_observing-your-data/query-insights/index.md|38 col 4| [OpenSearch.HeadingCapitalization] 'Query Insights settings' is a heading and should be in sentence case.
_observing-your-data/query-insights/top-n-queries.md|104 col 136| [OpenSearch.AcronymParentheses] 'SSSZ': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_observing-your-data/event-analytics.md|31 col 5| [OpenSearch.HeadingCapitalization] 'OpenSearch Dashboards Query Assistant' is a heading and should be in sentence case.
_observing-your-data/event-analytics.md|40 col 6| [OpenSearch.HeadingCapitalization] 'Enabling Query Assistant' is a heading and should be in sentence case.
_observing-your-data/event-analytics.md|52 col 6| [OpenSearch.HeadingCapitalization] 'Setting up Query Assistant' is a heading and should be in sentence case.
_observing-your-data/event-analytics.md|68 col 173| [OpenSearch.Spelling] Error: _flights. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/event-analytics.md|109 col 5| [OpenSearch.Spelling] Error: Livestreaming. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/index.md|19 col 34| [OpenSearch.Spelling] Error: timeframe. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/index.md|19 col 34| [OpenSearch.SubstitutionsError] Use 'time frame' instead of 'timeframe'.
_observing-your-data/index.md|19 col 77| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/index.md|20 col 25| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/event-analytics)'.
_observing-your-data/index.md|22 col 31| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/operational-panels)'.
_observing-your-data/index.md|25 col 25| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/trace/index)'.
_observing-your-data/index.md|27 col 24| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/notebooks)'.
_observing-your-data/query-insights/health.md|12 col 4| [OpenSearch.HeadingCapitalization] 'Health Stats API' is a heading and should be in sentence case.
_observing-your-data/observability-security.md|36 col 344| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
_observing-your-data/notebooks.md|79 col 3| [OpenSearch.AcronymParentheses] 'PPL': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_observing-your-data/prometheusmetrics.md|74 col 4| [OpenSearch.Spelling] Error: Datasource. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/prometheusmetrics.md|197 col 24| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'page, enter'.
_observing-your-data/ad/security.md|35 col 315| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/document-level-security)'.
_observing-your-data/ad/security.md|35 col 426| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/field-level-security)'.
_observing-your-data/ad/dashboards-anomaly-detection.md|30 col 14| [OpenSearch.Spelling] Error: Vizlib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/ad/settings.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Anomaly Detection settings' is a heading and should be in sentence case.
_observing-your-data/ad/settings.md|30 col 56| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|34 col 129| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|35 col 157| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|36 col 254| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|37 col 277| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|39 col 125| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|41 col 151| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|42 col 133| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|45 col 545| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/ad/settings.md|45 col 554| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/ad/settings.md|45 col 783| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|46 col 149| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|47 col 92| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|48 col 137| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|48 col 208| [OpenSearch.LatinismsSubstitution] Use 'using, through, by accessing, or by choosing' instead of 'via'.
_observing-your-data/ad/result-mapping.md|410 col 81| [OpenSearch.Spelling] Error: _name. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/trace/getting-started.md|11 col 3| [OpenSearch.HeadingCapitalization] 'Getting started with Trace Analytics' is a heading and should be in sentence case.
_observing-your-data/trace/getting-started.md|21 col 44| [OpenSearch.DirectionAboveBelow] Use 'following example' instead of 'example below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/trace/getting-started.md|84 col 41| [OpenSearch.SubstitutionsError] Use 'time frame' instead of 'timeframe'.
_observing-your-data/trace/getting-started.md|84 col 41| [OpenSearch.Spelling] Error: timeframe. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/trace/getting-started.md|84 col 77| [OpenSearch.SubstitutionsError] Use 'for more information about' instead of 'For more information on'.
_observing-your-data/trace/index.md|12 col 3| [OpenSearch.HeadingCapitalization] 'Trace Analytics' is a heading and should be in sentence case.
_observing-your-data/trace/trace-analytics-jaeger.md|50 col 71| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'analytics. Set'.
_observing-your-data/operational-panels.md|12 col 122| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/operational-panels.md|22 col 164| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/event-analytics)'.
_observing-your-data/alerting/monitors.md|54 col 80| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'alert.id'.
_observing-your-data/alerting/cron.md|13 col 71| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
_observing-your-data/alerting/cron.md|17 col 10| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|18 col 8| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|19 col 16| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|20 col 9| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|21 col 15| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|39 col 130| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/index.md|48 col 514| [OpenSearch.Spelling] Error: selectin. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/ad/index.md|107 col 234| [Vale.Terms] Use 'JSON' instead of 'json'.
TERMS.md|7 col 3| [OpenSearch.Inclusive] Use 'stop, end, or cancel' instead of 'abort' because the latter is an offensive term.
TERMS.md|13 col 78| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
TERMS.md|17 col 6| [OpenSearch.Spelling] Error: hoc. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|45 col 98| [OpenSearch.Inclusive] Use 'allow list' instead of 'whitelist' because the latter is an offensive term.
TERMS.md|92 col 66| [OpenSearch.Spelling] Error: autoscaling. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|98 col 98| [OpenSearch.SignatureV4] 'Signature Version 4': Use 'AWS Signature Version 4' instead of 'SigV4' on first appearance. Then, Signature Version 4 may be used. Only use SigV4 when space is limited.
TERMS.md|104 col 73| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
TERMS.md|110 col 3| [OpenSearch.Inclusive] Use 'blocked day' instead of 'black day' because the latter is an offensive term.
TERMS.md|114 col 3| [OpenSearch.Inclusive] Use 'deny list' instead of 'blacklist' because the latter is an offensive term.
TERMS.md|165 col 23| [OpenSearch.SubstitutionsError] Use 'command line interface' instead of 'command-line interface'.
TERMS.md|187 col 3| [OpenSearch.Spelling] Error: cyber. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|189 col 1| [OpenSearch.Cyber] Use 'cyber' as a prefix. Remove spaces or hyphens in 'cyber and'.
TERMS.md|189 col 116| [OpenSearch.Spelling] Error: cyber. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|195 col 18| [OpenSearch.SubstitutionsError] Use 'data is' instead of 'data are'.
TERMS.md|195 col 38| [OpenSearch.Spelling] Error: datas. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|207 col 15| [OpenSearch.Spelling] Error: datastore. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|209 col 69| [OpenSearch.Spelling] Error: VMware. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|218 col 105| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
TERMS.md|226 col 76| [OpenSearch.Inclusive] Use 'deny list' instead of 'blacklist' because the latter is an offensive term.
TERMS.md|288 col 3| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
TERMS.md|288 col 12| [OpenSearch.Spelling] Error: cetera. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|292 col 21| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
TERMS.md|342 col 3| [OpenSearch.Spelling] Error: hardcode. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|374 col 72| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
TERMS.md|378 col 90| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
TERMS.md|380 col 141| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
TERMS.md|388 col 6| [OpenSearch.SubstitutionsError] Use 'ingest pipeline' instead of 'ingestion pipeline'.
TERMS.md|412 col 6| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
TERMS.md|412 col 29| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
TERMS.md|412 col 70| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
TERMS.md|420 col 6| [OpenSearch.SubstitutionsError] Use 'key-value' instead of 'key/value'.
TERMS.md|426 col 13| [OpenSearch.Inclusive] Use 'stop, end, clear, remove, or cancel' instead of 'Kill' because the latter is an offensive term.
TERMS.md|426 col 58| [OpenSearch.Inclusive] Use 'stop, end, clear, remove, or cancel' instead of 'kill' because the latter is an offensive term.
TERMS.md|478 col 42| [OpenSearch.DirectionTopBottom] Use 'lower left' instead of 'bottom left' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
TERMS.md|478 col 60| [OpenSearch.DirectionTopBottom] Use 'lower right' instead of 'bottom right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
TERMS.md|498 col 3| [OpenSearch.Inclusive] Use 'cluster manager' instead of 'master' because the latter is an offensive term.
TERMS.md|502 col 3| [OpenSearch.Inclusive] Use 'cluster manager' instead of 'master' because the latter is an offensive term.
TERMS.md|540 col 121| [OpenSearch.Inclusive] Use 'cluster manager' instead of 'master' because the latter is an offensive term.
TERMS.md|592 col 30| [OpenSearch.Spelling] Error: MBps. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|609 col 34| [OpenSearch.Spelling] Error: nonencrypted. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
TERMS.md|611 col 3| [OpenSearch.Please] Using 'please' is unnecessary. Remove.
TERMS.md|703 col 11| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
TERMS.md|705 col 31| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
TERMS.md|711 col 3| [OpenSearch.Inclusive] Use 'replica, secondary, standby' instead of 'slave' because the latter is an offensive term.
TERMS.md|777 col 42| [OpenSearch.DirectionTopBottom] Use 'upper left' instead of 'top left' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
TERMS.md|777 col 57| [OpenSearch.DirectionTopBottom] Use 'upper right' instead of 'top right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
TERMS.md|809 col 8| [OpenSearch.SubstitutionsError] Use 'webpage' instead of 'web page'.
TERMS.md|813 col 8| [OpenSearch.SubstitutionsError] Use 'website' instead of 'web site'.
TERMS.md|819 col 3| [OpenSearch.Inclusive] Use 'open day' instead of 'white day' because the latter is an offensive term.
TERMS.md|823 col 3| [OpenSearch.Inclusive] Use 'allow list' instead of 'whitelist' because the latter is an offensive term.
TERMS.md|837 col 3| [OpenSearch.Spelling] Error: Yellowdog. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/security.md|45 col 301| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/document-level-security)'.
_observing-your-data/alerting/security.md|45 col 412| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/field-level-security)'.
_observing-your-data/alerting/security.md|51 col 21| [Vale.Terms] Use 'Alerting plugin' instead of 'alerting plugin'.
_observing-your-data/alerting/per-query-bucket-monitors.md|29 col 86| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/per-query-bucket-monitors.md|29 col 95| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/per-query-bucket-monitors.md|31 col 99| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/index)'.
_observing-your-data/alerting/per-query-bucket-monitors.md|87 col 97| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/index)'.
_observing-your-data/alerting/per-query-bucket-monitors.md|104 col 1| [OpenSearch.Repetition] 'custom' is repeated.
_observing-your-data/alerting/per-cluster-metrics-monitors.md|43 col 9| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/alerting/settings.md|13 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_observing-your-data/alerting/settings.md|21 col 95| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore)'.
_observing-your-data/alerting/settings.md|39 col 55| [Vale.Terms] Use 'Alerting plugin' instead of 'alerting plugin'.
_observing-your-data/ad/api.md|329 col 25| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|501 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|627 col 158| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/api.md|629 col 42| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|634 col 117| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|2176 col 44| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/api.md|2236 col 118| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|2236 col 144| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|2238 col 54| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/api.md|2238 col 132| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|2238 col 190| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|2503 col 136| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|2712 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|3023 col 277| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|3043 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|3072 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|3221 col 181| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|3223 col 93| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/alerting/per-document-monitors.md|33 col 1| [OpenSearch.DashSpacing] There should be no spaces around the dash in 'tags --- that'.
_observing-your-data/alerting/dashboards-alerting.md|39 col 14| [OpenSearch.Spelling] Error: Vizlib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/dashboards-alerting.md|86 col 233| [OpenSearch.Spelling] Error: unlinks. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/triggers.md|18 col 363| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'ABOVE' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/triggers.md|18 col 375| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'BELOW' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/triggers.md|134 col 80| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'alert.id'.
404.md|9 col 48| [OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.
404.md|11 col 96| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
404.md|11 col 142| [OpenSearch.Please] Using 'please' is unnecessary. Remove.
MAINTAINERS.md|3 col 56| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
MAINTAINERS.md|3 col 76| [Vale.Terms] Use 'GitHub' instead of 'github'.
MAINTAINERS.md|5 col 4| [OpenSearch.HeadingCapitalization] 'Current Maintainers' is a heading and should be in sentence case.
MAINTAINERS.md|9 col 3| [OpenSearch.Spelling] Error: Fanit. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|9 col 9| [OpenSearch.Spelling] Error: Kolchina. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|11 col 23| [OpenSearch.Spelling] Error: natebower. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|12 col 3| [OpenSearch.Spelling] Error: Miki. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|12 col 8| [OpenSearch.Spelling] Error: Barahmand. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|13 col 9| [OpenSearch.Spelling] Error: Venable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|13 col 23| [OpenSearch.Spelling] Error: dlvenable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|14 col 23| [OpenSearch.Spelling] Error: epugh. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|20 col 23| [OpenSearch.Spelling] Error: hdhalter. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
MAINTAINERS.md|21 col 23| [OpenSearch.Spelling] Error: vagimeli. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
CONTRIBUTING.md|15 col 57| [OpenSearch.Exclamation] Don't use exclamation points in documentation.
CONTRIBUTING.md|25 col 29| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
CONTRIBUTING.md|50 col 12| [OpenSearch.AcronymParentheses] 'README': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
CONTRIBUTING.md|91 col 13| [OpenSearch.Spelling] Error: Bundler. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
CONTRIBUTING.md|150 col 48| [OpenSearch.Spelling] Error: backport. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
CONTRIBUTING.md|159 col 39| [OpenSearch.Spelling] Error: VSCode. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
CONTRIBUTING.md|159 col 283| [OpenSearch.Spelling] Error: VSCode. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/composite-monitors.md|213 col 5| [OpenSearch.HeadingCapitalization] 'Get Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/alerting/composite-monitors.md|229 col 5| [OpenSearch.HeadingCapitalization] 'Update Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/alerting/composite-monitors.md|273 col 5| [OpenSearch.HeadingCapitalization] 'Delete Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/alerting/composite-monitors.md|281 col 5| [OpenSearch.HeadingCapitalization] 'Execute Composite Monitor' is a heading and should be in sentence case.
_im-plugin/security.md|12 col 22| [OpenSearch.SubstitutionsError] Use 'data is' instead of 'data are'.
_im-plugin/security.md|12 col 214| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/configuration/system-indices)'.
_im-plugin/security.md|20 col 175| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/im-plugin/ism/api)'.
_im-plugin/index-alias.md|66 col 22| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_im-plugin/index-alias.md|265 col 37| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_im-plugin/data-streams.md|22 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_im-plugin/data-streams.md|39 col 169| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_im-plugin/data-streams.md|165 col 30| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_im-plugin/data-streams.md|246 col 122| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_im-plugin/data-streams.md|246 col 152| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_im-plugin/data-streams.md|257 col 52| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/alerting/api.md|322 col 50| [OpenSearch.Spelling] Error: tz. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/api.md|322 col 172| [OpenSearch.SubstitutionsError] Use 'time zone' instead of 'TimeZone'.
_im-plugin/index-rollups/settings.md|18 col 164| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_im-plugin/index-rollups/settings.md|21 col 85| [OpenSearch.Spelling] Error: ingestions. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_im-plugin/index-rollups/settings.md|22 col 92| [OpenSearch.Spelling] Error: ingestions. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_im-plugin/index-transforms/transforms-apis.md|31 col 13| [OpenSearch.TableHeadings] 'Data Type' is a table heading and should be in sentence case.
_im-plugin/index-transforms/transforms-apis.md|39 col 10| [OpenSearch.TableHeadings] 'Data Type' is a table heading and should be in sentence case.
_im-plugin/index-transforms/transforms-apis.md|49 col 157| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/query-dsl)'.
_im-plugin/index-transforms/transforms-apis.md|51 col 185| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/bucket-agg)'.
_im-plugin/index-transforms/transforms-apis.md|53 col 226| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/metric-agg)'.
_im-plugin/index-transforms/transforms-apis.md|55 col 6| [OpenSearch.SubstitutionsError] Use 'example request' instead of 'Sample Request'.
_im-plugin/index-transforms/transforms-apis.md|55 col 6| [OpenSearch.HeadingCapitalization] 'Sample Request' is a heading and should be in sentence case.
_im-plugin/index-transforms/transforms-apis.md|104 col 6| [OpenSearch.HeadingCapitalization] 'Sample Response' is a heading and should be in sentence case.
_im-plugin/index-transforms/transforms-apis.md|104 col 6| [OpenSearch.SubstitutionsError] Use 'example response' instead of 'Sample Response'.
_im-plugin/index-transforms/transforms-apis.md|187 col 10| [OpenSearch.TableHeadings] 'Data Type' is a table heading and should be in sentence case.
_im-plugin/index-transforms/transforms-apis.md|196 col 6| [OpenSearch.SubstitutionsError] Use 'example request' instead of 'Sample Request'.
... (Too many findings. Dropped some findings)

Annotations

Check failure on line 113 in _vector-search/ml-powered-search/multimodal-search.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _vector-search/ml-powered-search/multimodal-search.md#L113

[OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.
Raw output
{"message": "[OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.", "location": {"path": "_vector-search/ml-powered-search/multimodal-search.md", "range": {"start": {"line": 113, "column": 153}}}, "severity": "ERROR"}

Check failure on line 120 in _vector-search/ml-powered-search/semantic-search.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _vector-search/ml-powered-search/semantic-search.md#L120

[OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.
Raw output
{"message": "[OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'knn'.", "location": {"path": "_vector-search/ml-powered-search/semantic-search.md", "range": {"start": {"line": 120, "column": 153}}}, "severity": "ERROR"}

Check warning on line 47 in _vector-search/performance-tuning-search.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _vector-search/performance-tuning-search.md#L47

[OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
Raw output
{"message": "[OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.", "location": {"path": "_vector-search/performance-tuning-search.md", "range": {"start": {"line": 47, "column": 24}}}, "severity": "WARNING"}

Check warning on line 22 in _vector-search/vector-search-techniques/knn-score-script.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _vector-search/vector-search-techniques/knn-score-script.md#L22

[OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
Raw output
{"message": "[OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.", "location": {"path": "_vector-search/vector-search-techniques/knn-score-script.md", "range": {"start": {"line": 22, "column": 18}}}, "severity": "WARNING"}

Check warning on line 13 in _vector-search/optimizing-storage/binary-quantization.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _vector-search/optimizing-storage/binary-quantization.md#L13

[OpenSearch.UnitsSpacing] Put a space between the number and the units in '0s '.
Raw output
{"message": "[OpenSearch.UnitsSpacing] Put a space between the number and the units in '0s '.", "location": {"path": "_vector-search/optimizing-storage/binary-quantization.md", "range": {"start": {"line": 13, "column": 167}}}, "severity": "WARNING"}