Pinecone · Schema

Serverless

Configuration needed to deploy a serverless index.

Vector DatabasesAIEmbeddingsRAG

Properties

Name Type Description
cloud string The public cloud where you would like your index hosted. Possible values: `gcp`, `aws`, or `azure`.
region string The region where you would like your index to be created.
read_capacity object
source_collection string The name of the collection to be used as the source for the index.
schema object
View JSON Schema on GitHub

JSON Schema

pinecone-serverlessspec-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServerlessSpec",
  "title": "Serverless",
  "description": "Configuration needed to deploy a serverless index.",
  "type": "object",
  "properties": {
    "cloud": {
      "example": "aws",
      "description": "The public cloud where you would like your index hosted.\nPossible values: `gcp`, `aws`, or `azure`.",
      "x-enum": [
        "gcp",
        "aws",
        "azure"
      ],
      "type": "string"
    },
    "region": {
      "example": "us-east-1",
      "description": "The region where you would like your index to be created.",
      "type": "string"
    },
    "read_capacity": {
      "$ref": "#/components/schemas/ReadCapacity"
    },
    "source_collection": {
      "example": "movie-embeddings",
      "description": "The name of the collection to be used as the source for the index.",
      "type": "string"
    },
    "schema": {
      "$ref": "#/components/schemas/MetadataSchema"
    }
  },
  "required": [
    "cloud",
    "region"
  ]
}