Pinecone DescribeIndexStats

Pinecone DescribeIndexStats

Certified

Describe statistics for a Pinecone index

Returns statistics for a Pinecone index, including the total vector count and the per-namespace vector counts.

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

Get index statistics.

yaml
id: pinecone_describe_index_stats
namespace: company.team

tasks:
  - id: stats
    type: io.kestra.plugin.pinecone.DescribeIndexStats
    apiKey: "{{ secret('PINECONE_API_KEY') }}"
    indexName: my-embeddings
Properties

Pinecone API key

Index name

Name of the Pinecone index to operate on.

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

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).

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).

SubTypeinteger

Vector count per namespace

Total number of vectors across all namespaces