Queries Pinecone in order to gather a specified number of documents that are most closely related to the given query.
pinecone, vector, vectordb, vectorstore, embeddings, ai, artificial intelligence, ml, machine learning, text, LLM
In the list below, the names of required properties appear in bold. Any other properties (not in bold) 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 | Description |
|---|---|---|---|
| Embedding Model | Embedding Model | OpenAI Model | Specifies which embedding model should be used in order to create embeddings from incoming Documents. Default model is OpenAI. |
| Pinecone API Key | Pinecone API Key | The API Key to use in order to authentication with Pinecone Sensitive Property: true | |
| OpenAI API Key | OpenAI API Key | The API Key for OpenAI in order to create embeddings Sensitive Property: true | |
| HuggingFace API Key | HuggingFace API Key | The API Key for interacting with HuggingFace Sensitive Property: true | |
| Pinecone Environment | Pinecone Environment | The name of the Pinecone Environment. This can be found in the Pinecone console next to the API Key. | |
| Index Name | Index Name | The name of the Pinecone index. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) | |
| Query | Query | The text of the query to send to Pinecone. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) | |
| Number of Results | Number of Results | 10 | The number of results to return from Pinecone Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Text Key | Text Key | text | The key in the document that contains the text to create embeddings for. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Namespace | Namespace | The name of the Pinecone Namespace to query into. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) | |
| Metadata Filter | Metadata Filter | Optional metadata filter to apply with the query. For example: { "author": {"$eq": "john.doe"} } Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) | |
| OpenAI Model | OpenAI Model | text-embedding-ada-002 | The name of the OpenAI model to use |
| HuggingFace Model | HuggingFace Model | sentence-transformers/all-MiniLM-L6-v2 | The name of the HuggingFace model to use |
| Output Strategy | Output Strategy | Row-Oriented | Specifies whether the output should contain only the text of the documents (each document separated by \n\n), or if it should be formatted as either single column-oriented JSON object, consisting of a keys 'ids', 'embeddings', 'documents', 'distances', and 'metadatas'; or if the results should be row-oriented, a JSON per line, each consisting of a single id, document, metadata, embedding, and distance. |
| Results Field | Results Field | If the input FlowFile is JSON Formatted, this represents the name of the field to insert the results. This allows the results to be inserted into "an existing input in order to enrich it. If this property is unset, the results will be written to the FlowFile contents, overwriting any pre-existing content. | |
| Include Metadata | Include Metadata | true | Whether or not to include the Documents' Metadata in the response |
| Include Distances | Include Distances | true | Whether or not to include the Documents' Distances (i.e., how far the Document was away from the query) in the response |