Saltar al contenido

Pinecone (Beta) Query Vectors activity

Introduction

A Pinecone (Beta) Query Vectors activity, using its Pinecone (Beta) connection, queries vectors from Pinecone using vector or string data and is intended to be used as a source to provide data in an operation.

Note

For beta access and to provide feedback, contact the Jitterbit Product Team.

Create a Pinecone (Beta) Query Vectors activity

An instance of a Pinecone (Beta) Query Vectors activity is created from a Pinecone (Beta) connection using its Query Vectors activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Pinecone (Beta) Query Vectors activity can be edited from these locations:

Configure a Pinecone (Beta) Query Vectors activity

Follow these steps to configure a Pinecone (Beta) Query Vectors activity:

Step 1: Enter a name and select an index

In this step, provide a name for the activity and select an index. Each user interface element of this step is described below.

Pinecone Query Vectors activity configuration step 1

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to identify the activity. The name must be unique for each Pinecone (Beta) Query Vectors activity and must not contain forward slashes / or colons :.

  • Select an index: This section displays indexes available in the Pinecone (Beta) endpoint.

    • Selected index: After an index is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of indexes. The search is not case-sensitive. If indexes are already displayed within the table, the table results are filtered in real time with each keystroke. To reload indexes from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon or the word Refresh to reload indexes from the Pinecone (Beta) endpoint. This may be useful if indexes have been added to Pinecone (Beta). This action refreshes all metadata used to build the table of indexes displayed in the configuration.

    • Selecting an index: Within the table, click anywhere on a row to select an index. Only one index can be selected. The information available for each index is fetched from the Pinecone (Beta) endpoint:

      • Name: The name of the index.

      • Type: The type of the index, either dense or sparse.

      • Host: The host name of the index.

    Tip

    If the table does not populate with available indexes, the Pinecone (Beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Index namespace: Enter the index namespace.

  • Optional settings: Click to expand additional optional settings:

    • Query Type: Specify the query type to be used, either Query by raw vector data or Query by text. For more information, refer to the Pinecone Search with a vector and Search with text documentation respectively.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Pinecone Query Vectors activity configuration step 2

  • Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    The Pinecone (Beta) connector uses the Pinecone API. Refer to the Pinecone Search overview documentation for more information.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Pinecone (Beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Pinecone (Beta) Query Vectors activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Pinecone (Beta) Query Vectors activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.