Reopen mtern descriptions PR for editorial. (#648)

* Reopen mtern descriptions PR for editorial. Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Remove spaces Signed-off-by: Archer <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Oct 25, 2024 · 931a61a · 931a61a
1 parent 0605aec
commit 931a61a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml
@@ -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'

diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml
@@ -21,7 +21,7 @@ components:
         template_id:
           $ref: '_common.yaml#/components/schemas/Id'
         params:
-          description: The search template parameters.
+          description: The search template parameters. 
           type: object
           additionalProperties:
             type: object
@@ -70,7 +70,7 @@ components:
         - 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:
@@ -84,7 +84,7 @@ components:
       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:
@@ -100,15 +100,15 @@ components:
         - 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).
               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
@@ -119,17 +119,17 @@ components:
           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
           additionalProperties:
             type: object