Pinecone CreateIndex

Pinecone CreateIndex

Certified

Create a serverless Pinecone index

Creates a new serverless index in Pinecone. Pod-based indexes are out of scope — use serverless only. If an index with the same name already exists, the task throws an error.

yaml
type: io.kestra.plugin.pinecone.CreateIndex

Create a serverless index on AWS us-east-1.

yaml
id: pinecone_create_index
namespace: company.team

tasks:
  - id: create_index
    type: io.kestra.plugin.pinecone.CreateIndex
    apiKey: "{{ secret('PINECONE_API_KEY') }}"
    indexName: my-embeddings
    dimension: 1536
    metric: COSINE
    cloud: aws
    region: us-east-1
Properties

Pinecone API key

Cloud provider (aws, gcp, azure)

Number of dimensions in the vector embeddings

Index name

Name of the Pinecone index to operate on.

Cloud region (e.g. us-east-1)

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultdisabled

Deletion protection

Set to 'enabled' to prevent accidental deletion. Defaults to 'disabled'.

Control-plane host override

Optional URL override for the Pinecone control-plane API. Defaults to https://api.pinecone.io when unset. Set this to point to a local emulator (e.g. http://localhost: 5080).

DefaultCOSINE
Possible Values
COSINEEUCLIDEANDOTPRODUCT

Distance metric used for similarity search

Accepted values: COSINE, EUCLIDEAN, DOTPRODUCT.

Defaulttrue

Enable TLS for gRPC data-plane connections

Set to false when connecting to a local emulator that does not support TLS. Defaults to true (production Pinecone always requires TLS).

Host URL of the created index

Name of the created index

Index status state (e.g. Initializing, Ready)