# tPineconeClient

Available in...

* Cloud Data Fabric
* Data Fabric
* Qlik Talend Cloud Enterprise Edition
* Real-Time Big Data Platform

Upserts, queries, fetches, updates, or deletes records in Pinecone index namespaces.

Information noteNote:

This component is not shipped with your Talend Studio by default. You need to install it using the Feature Manager. For more information, see [Installing features using the Feature Manager](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/install-features-to-talend-studio).

For a quick introduction on using this component in your Job, see the following video:

## tPineconeClient Standard properties

These properties are used to configure tPineconeClient running in the Standard Job framework.

The Standard tPineconeClient component belongs to the AI family.

Information noteNote: This component is a specific version of a dynamic database connector. The properties related to database settings vary depending on your database type selection. For more information about dynamic database connectors, see [DB Generic components](https://help.qlik.com/talend/r/en-US/8.0/components/db-generic/db-generic-component).

## Basic settings

| Properties | Description |
| --- | --- |
| Database | Select the desired database type from the list and click<br>Apply. |
| Property type | Either Built-in or<br>Repository<br>.<br><br><ul> <li> <span>Built-in</span>: No property data stored                        centrally.</li> <li> <span>Repository</span>: Select the repository                        file in which the properties are stored. The fields that follow are                        completed automatically using the data retrieved.</li> </ul> |
| Schema and Edit Schema | A schema is a row description, it defines the number of fields to be<br>processed and passed on to the next component. The schema is either<br>Built-in or stored remotely in the<br>Repository.<br><br><ul> <li> <p> <span>Built-in</span>: You create and store the schema locally                           for this component only. For more information about a component schema in                           its <span>Basic settings</span> tab, see <a href="https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/basic-settings-tab" target="_blank">Basic settings tab</a>.</p> </li> <li> <p> <span>Repository</span>: You have already                           created the schema and stored it in the <span>Repository</span>. You can reuse it in various projects and Job                           designs. For more information about a component schema in its                              <span>Basic settings</span> tab, see <a href="https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/basic-settings-tab" target="_blank">Basic settings tab</a>.</p> </li> </ul><br><br>Click Edit<br>schema to make changes to the schema. If the current schema is of the Repository type, three options are available:<br><br><ul> <li> <p> <span>View schema</span>: choose this                option to view the schema only.</p> </li> <li> <p> <span>Change to built-in property</span>:                choose this option to change the schema to <span>Built-in</span> for local changes.</p> </li> <li> <p> <span>Update repository connection</span>:                choose this option to change the schema stored in the repository and decide whether                to propagate the changes to all the Jobs upon completion.</p> <p>If you just want to                propagate the changes to the current Job, you can select <span>No</span> upon completion and choose this schema metadata                again in the <span>Repository Content</span>                window.</p> </li> </ul> |
| Sync columns | Click this button to retrieve the schema from the preceding<br>component. |
| Guess schema | Click this button to retrieve the schema according to your<br>settings. |
| API Key | Enter the Pinecone API key in this field.<br><br>To enter the raw key, click the [...] button next to the<br>corresponding field to bring out the Enter a new<br>password dialog box, enter the key in the text field, and click<br>OK. You can also use a context variable in that<br>field.<br><br>For more information on how to find your Pinecone API Key, see [Authentication](https://docs.pinecone.io/guides/get-started/authentication). |
| Host | Enter the IP address of the Pinecone database in this field, or click the<br>[...] button next to the corresponding field to<br>retrieve it.<br><br>You can also use a context variable in that field. |
| Operation | Select the operation you want to perform to the incoming data and data records<br>in the Pinecone database table:<br><br><ul> <li> <span>Upsert</span>: Creates new records and overwrites                           existing records in the specified index namespace.</li> <li> <span>Query</span>: Retrieves the IDs of the most similar                           records in the index, along with their similarity scores. You need to                           specify the number of results to return in the <span>Top                              K</span> field, knowing that this number is linked to the number                           of existing records: if you enter 7 in that field and the database only                           contains 5 records, you will get 5 records.</li> <li> <span>Fetch</span>: Fetches records by ID from the specified                           index namespace.</li> <li> <span>Update</span>: Updates existing records in the specified                           index namespace.</li> <li> <span>Delete</span>: Removes records from the specified index                           namespace. If you need to apply this action on all the records of the                           specified namespace, select the <span>Delete all</span> check                           box that is displayed.</li> <li> <span>Get index stats</span>: Gets the details of a Pinecone                           index.</li> </ul><br><br>For more information on these data operations, see [Data](https://docs.pinecone.io/guides/data/upsert-data). |
| Namespace | Enter the name of the Pinecone index namespace on which you want to apply the<br>data operations. |

## Advanced settings

| Properties | Description |
| --- | --- |
| tStatCatcher Statistics | Select this check box to gather the Job processing metadata at a Job level<br>and at each component level. |
| Max batch size | Set the maximum number of records allowed in each batch.<br><br>For more information on these data operations, see [Upsert limits](https://docs.pinecone.io/guides/data/upsert-data#upsert-limits). |
| API version | Specify the version of the Pinecone API to be used in your requests.<br><br>For more information on API versioning, see [Specifying an API version](https://docs.pinecone.io/reference/api/versioning#specifying-an-api-version). |
| Filter | Specify a filter expression to be used when querying the Pinecone index.<br><br>For more information on filter expressions, see [Filter with metadata](https://docs.pinecone.io/guides/data/filter-with-metadata). |

## Global Variables

| Variables | Description |
| --- | --- |
| ERROR\_MESSAGE | ERROR\_MESSAGE: the error message generated by the component when an<br>error occurs. This is an After variable and it returns a string. |
| NB\_LINE | NB\_LINE: the number<br>of rows read by an input component or transferred to an output component. This is an<br>After variable and it returns an integer. |

**Related tasks**

* [Indexing phone reviews with embeddings and vector database](https://help.qlik.com/talend/en-US/components/8.0/ai/tembeddingai-tpineconeclient-tmap-indexing-phone-reviews-with-embeddings-and-vector-db "This Job reads phone review text files from a folder, splits the content into smaller chunks for better analysis, generates vector embeddings using Azure OpenAI, and stores them in a Pinecone vector database to enable semantic search.")