Pinecone · Schema

MetadataSchema

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when `schema` is present, only fields which are present in the `fields` object with a `filterable: true` are indexed. Note that `filterable: false` is not currently supported.

Vector DatabasesAIEmbeddingsRAG

Properties

Name Type Description
fields object A map of metadata field names to their configuration. The field name must be a valid metadata field name. The field name must be unique.
View JSON Schema on GitHub

JSON Schema

pinecone-metadataschema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetadataSchema",
  "title": "MetadataSchema",
  "example": {
    "fields": {
      "description": {
        "filterable": true
      },
      "genre": {
        "filterable": true
      },
      "year": {
        "filterable": true
      }
    }
  },
  "description": "Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when `schema` is present, only fields which are present in the `fields` object with a `filterable: true` are indexed. Note that `filterable: false` is not currently supported.",
  "type": "object",
  "properties": {
    "fields": {
      "description": "A map of metadata field names to their configuration. The field name must be a valid metadata field name. The field name must be unique.",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "filterable": {
            "description": "Whether the field is filterable. If true, the field is indexed and can be used in filters. Only true values are allowed.",
            "type": "boolean"
          }
        }
      }
    }
  },
  "required": [
    "fields"
  ]
}