diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml index ba30a5ca..e130a31f 100644 --- a/spec/schemas/_core.mtermvectors.yaml +++ b/spec/schemas/_core.mtermvectors.yaml @@ -24,18 +24,18 @@ components: filter: $ref: '_core.termvectors.yaml#/components/schemas/Filter' offsets: - description: When `true`, the response includes the term offsets. + description: When `true`, the response includes the term offsets. type: boolean payloads: - description: When `true`, the response includes the term payloads. + description: When `true`, the response includes the term payloads. type: boolean positions: - description: When `true`, the response includes the term positions. + description: When `true`, the response includes the term positions. type: boolean routing: $ref: '_common.yaml#/components/schemas/Routing' term_statistics: - description: When `true`, the response includes the term frequency and the document frequency. + description: When `true`, the response includes the term frequency and the document frequency. type: boolean version: $ref: '_common.yaml#/components/schemas/VersionNumber' diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml index 81899233..404d09c3 100644 --- a/spec/schemas/_core.rank_eval.yaml +++ b/spec/schemas/_core.rank_eval.yaml @@ -14,7 +14,7 @@ components: request: $ref: '#/components/schemas/RankEvalQuery' ratings: - description: A list of document ratings. + description: A list of document ratings. type: array items: $ref: '#/components/schemas/DocumentRating' @@ -45,7 +45,7 @@ components: _index: $ref: '_common.yaml#/components/schemas/IndexName' rating: - description: The document's relevance with regard to the specified search request. + description: The document's relevance with regard to the specified search request. type: number required: - _id @@ -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 are not treated 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: @@ -78,7 +78,7 @@ components: - type: object properties: relevant_rating_threshold: - description: Sets the rating threshold above which documents are considered to be relevant. + description: Sets the rating threshold above which documents are considered to be relevant. type: number RankEvalMetricBase: type: object @@ -119,7 +119,7 @@ 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' @@ -129,7 +129,7 @@ components: items: $ref: '#/components/schemas/RankEvalHitItem' metric_details: - 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. + 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