cohere · Schema

RerankResult

Properties

Name Type Description
index integer The index of the document in the original input list.
relevance_score number The relevance score assigned to the document for the given query. Higher scores indicate greater relevance.
document object The document text, returned when return_documents is true.
View JSON Schema on GitHub

JSON Schema

cohere-rerankresult-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RerankResult",
  "title": "RerankResult",
  "type": "object",
  "properties": {
    "index": {
      "type": "integer",
      "description": "The index of the document in the original input list."
    },
    "relevance_score": {
      "type": "number",
      "description": "The relevance score assigned to the document for the given query. Higher scores indicate greater relevance."
    },
    "document": {
      "type": "object",
      "description": "The document text, returned when return_documents is true.",
      "properties": {
        "text": {
          "type": "string",
          "description": "The text content of the document."
        }
      }
    }
  }
}