Pinecone · Schema

RankedDocument

A ranked document with a relevance score and an index position.

Vector DatabasesAIEmbeddingsRAG

Properties

Name Type Description
index integer The index position of the document from the original request.
score number The relevance of the document to the query, normalized between 0 and 1, with scores closer to 1 indicating higher relevance.
document object
View JSON Schema on GitHub

JSON Schema

pinecone-rankeddocument-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RankedDocument",
  "title": "RankedDocument",
  "description": "A ranked document with a relevance score and an index position.",
  "type": "object",
  "properties": {
    "index": {
      "description": "The index position of the document from the original request.",
      "type": "integer"
    },
    "score": {
      "example": 0.5,
      "description": "The relevance of the document to the query, normalized between 0 and 1, with scores closer to 1 indicating higher relevance.",
      "type": "number"
    },
    "document": {
      "$ref": "#/components/schemas/Document"
    }
  },
  "required": [
    "index",
    "score"
  ]
}