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.

Sign up for GitHub

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

Reopen mterm descriptions PR for editorial. #648

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Reopen mterm descriptions PR for editorial. #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76ecdea
Reopen mtern descriptions PR for editorial.
Naarcha-AWS Oct 25, 2024
ca4c934
Apply suggestions from code review
Naarcha-AWS Oct 25, 2024
95bcb91
Remove spaces
Naarcha-AWS Oct 25, 2024
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.mtermvectors.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ components:
_index:
$ref: '_common.yaml#/components/schemas/IndexName'
doc:
description: An artificial document for which you want to retrieve term vectors.
description: An artificial document for which you want to retrieve term vectors.
type: object
fields:
$ref: '_common.yaml#/components/schemas/Fields'
Expand Down
16 changes: 8 additions & 8 deletions spec/schemas/_core.rank_eval.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
template_id:
$ref: '_common.yaml#/components/schemas/Id'
params:
description: The search template parameters.
description: The search template parameters.
type: object
additionalProperties:
type: object
Expand Down Expand Up @@ -70,7 +70,7 @@
- type: object
properties:
ignore_unlabeled:
description: Controls how unlabeled documents in the search results are counted. When `true`, unlabeled documents are ignored and do not count as relevant or irrelevant. When `false`, unlabeled documents are treated as irrelevant.
description: Controls how unlabeled documents in the search results are counted. When `true`, unlabeled documents are ignored and are not treated as relevant or irrelevant. When `false`, unlabeled documents are treated as irrelevant.
type: boolean
RankEvalMetricRatingThreshold:
allOf:
Expand All @@ -84,7 +84,7 @@
type: object
properties:
k:
description: Sets the maximum number of documents retrieved per query. This value replaces the usual `size` parameter in the query.
description: Sets the maximum number of documents retrieved per query. This value replaces the `size` parameter in the query.
type: number
RankEvalMetricRecall:
allOf:
Expand All @@ -100,15 +100,15 @@
- type: object
properties:
normalize:
description: When `true`, this metric calculates the Normalized DCG (https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG).
description: When `true`, calculates the [normalized discounted cumulative gain (nDCG)](https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG).

Check failure on line 103 in spec/schemas/_core.rank_eval.yaml

View workflow job for this annotation

GitHub Actions / check 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'en.wikipedia'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'en.wikipedia'.", "location": {"path": "spec/schemas/_core.rank_eval.yaml", "range": {"start": {"line": 103, "column": 111}}}, "severity": "ERROR"}
type: boolean
RankEvalMetricExpectedReciprocalRank:
allOf:
- $ref: '#/components/schemas/RankEvalMetricBase'
- type: object
properties:
maximum_relevance:
description: The highest relevance grade used in the user-supplied relevance judgments.
description: The highest relevance grade used in user-supplied relevance judgments.
type: number
required:
- maximum_relevance
Expand All @@ -119,17 +119,17 @@
description: The `metric_score`, found in the `metric_details` section, shows the contribution of this query to the global quality metric score.
type: number
unrated_docs:
description: The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents.
description: The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a `ratings` value. This can be used to ask the user to supply ratings for these documents.
type: array
items:
$ref: '#/components/schemas/UnratedDocument'
hits:
description: The `hits` section shows a grouping of the search results with their supplied ratings
description: The `hits` section provides a grouping of the search results with their supplied ratings.
type: array
items:
$ref: '#/components/schemas/RankEvalHitItem'
metric_details:
description: The `metric_details` section gives additional information about the calculated quality metric, in other words, how many of the retrieved documents were relevant. The content varies for each metric but allows for better interpretation of the results.
description: The `metric_details` section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents. The content varies for each metric but allows for better interpretation of the results.
type: object
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
additionalProperties:
type: object
Expand Down
Loading