OptionalcmekThe ID of a customer-managed encryption key (CMEK) to use for this index. Requires CMEK to be enabled for your organization. Encrypted indexes cannot have full_text_search fields: a request that sets cmek_id and declares one is rejected, and a project that enforces CMEK rejects any schema with a full_text_search field with 412.
OptionaldeletionWhether deletion protection is enabled/disabled for the index.
Possible values: disabled or enabled.
OptionaldeploymentOptionalnameThe name of the index. Must be unique within the project. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'. If not provided, a name is generated automatically. Callers that require retry-safe behavior should provide an explicit name — a duplicate request with the same name returns 409, making success detectable on retry.
OptionalreadOptionaltagsCustom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags.
The configuration needed to create a Pinecone index. The
schemafield is required and defines the typed fields for the index. Thedeploymentfield selects infrastructure and defaults to managed (serverless) on AWSus-east-1if omitted. Thenameis auto-generated if not provided.Export
CreateIndexRequest