DeletePinecone
Description
Deletes vectors from a Pinecone index.
Tags
datavolo, delete, embeddings, genai, generative ai, pinecone, rag, retrieval augmented generation, vector store
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
Display Name | API Name | Default Value | Allowable Values | Description |
---|---|---|---|---|
Pinecone API Key * | Pinecone API Key | The API key for the Pinecone service | ||
Pinecone Index * | Pinecone Index | The name of the Pinecone index to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
Pinecone Namespace | Pinecone Namespace | default | The name of the Pinecone namespace to use Supports Expression Language, using FlowFile attributes and Environment variables. | |
ID Prefix | ID Prefix | The Pinecone vector ID prefix. If specified, only the vectors whose IDs start with the given value will be deleted. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
Web Client Service * | Web Client Service | Controller Service: WebClientServiceProvider Implementations: StandardWebClientServiceProvider | The Web Client Service to use for communicating with Pinecone |
Dynamic Properties
This component does not support dynamic properties.
Relationships
Name | Description |
---|---|
failure | FlowFiles that cannot be sent to Pinecone, and for which a retry is not expected to be successful, are routed to this relationship |
retry | FlowFiles that fail to be sent to Pinecone, but for which a retry may help, are routed to this relationship |
success | FlowFiles that are successfully sent to Pinecone are routed to this relationship |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
Example Use Cases
Use Case 1
Delete all vectors from a Pinecone index.
Configuration
Set the 'Pinecone API Key' property to the API key for the Pinecone service.
Set the 'Pinecone Index' property to the name of the Pinecone index from which to delete vectors.
Leave the 'Namespace' property unset.
Leave the 'ID Prefix' property unset.
Set 'Web Client Service' property to a WebClientService that can be used to make requests to the OpenAI API.
Use Case 2
Delete a namespace, along with all of its vectors, from a Pinecone index.
Configuration
Set the 'Pinecone API Key' property to the API key for the Pinecone service.
Set the 'Pinecone Index' property to the name of the Pinecone index from which to delete vectors.
Set the 'Namespace' property to the name of the namespace to delete.
Leave the 'ID Prefix' property unset.
Set 'Web Client Service' property to a WebClientService that can be used to make requests to the OpenAI API.
Use Case 3
Delete all vectors for a particular document from a Pinecone index.
This is often used in dataflows for RAG (Retrieval Augmented Generation), in order to remove vectors for all chunks of a document.
Configuration
Set the 'Pinecone API Key' property to the API key for the Pinecone service.
Set the 'Pinecone Index' property to the name of the Pinecone index from which to delete vectors.
Set the 'Namespace' property to the name of the namespace that the document lives in, or leave it blank if the namespace is unknown.
Set the 'ID Prefix' property to the ID of the document whose vectors should be deleted. Often this is the filename of the original document.
Set the 'Web Client Service' property to a WebClientService that can be used to make requests to the OpenAI API.
System Resource Considerations
This component does not specify system resource considerations.