← Pinecone

Query IDs with Pinecone API

Pipedream makes it easy to connect APIs for Pinecone and 2,200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Query IDs with the Pinecone API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Query IDs with the Pinecone API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Query IDs action
    1. Connect your Pinecone account
    2. Select a Index Name
    3. Configure Top K
    4. Optional- Configure Filter
    5. Optional- Configure Include Values
    6. Optional- Configure Include Metadata
    7. Optional- Configure Namespace
    8. Optional- Configure Vector ID
    9. Optional- Configure Vector Values
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Query IDs with Pinecone API on New Requests from HTTP / Webhook API
HTTP / Webhook + Pinecone
 
Try it
Query IDs with Pinecone API on New Submission from Typeform API
Typeform + Pinecone
 
Try it
Query IDs with Pinecone API on New Submission (Instant) from Jotform API
Jotform + Pinecone
 
Try it
Query IDs with Pinecone API on New Custom Webhook Events from Stripe API
Stripe + Pinecone
 
Try it
Query IDs with Pinecone API on New Scheduled Tasks from Pipedream API
Pipedream + Pinecone
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Query IDs on Pinecone
Description:Searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores. [See the documentation](https://docs.pinecone.io/reference/api/data-plane/query).
Version:0.0.2
Key:pinecone-query-ids

Code

import app from "../../pinecone.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "pinecone-query-ids",
  name: "Query IDs",
  description: "Searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores. [See the documentation](https://docs.pinecone.io/reference/api/data-plane/query).",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    indexName: {
      propDefinition: [
        app,
        "indexName",
      ],
    },
    topK: {
      type: "integer",
      label: "Top K",
      description: "The number of results to return. E.g. `10`",
      min: 1,
      max: 10000,
      default: 10,
    },
    filter: {
      type: "object",
      label: "Filter",
      description: "The filter to apply. You can use vector metadata to limit your search. For guidance and examples, see [filtering-with-metadata](https://docs.pinecone.io/guides/data/filtering-with-metadata).",
      optional: true,
    },
    includeValues: {
      type: "boolean",
      label: "Include Values",
      description: "Whether to include the vector values in the response.",
      optional: true,
    },
    includeMetadata: {
      type: "boolean",
      label: "Include Metadata",
      description: "Whether to include the vector metadata in the response.",
      optional: true,
    },
    namespace: {
      propDefinition: [
        app,
        "namespace",
      ],
    },
    id: {
      optional: true,
      description: `${app.propDefinitions.vectorId.description} Each request can contain only one of the parameters either **Vector ID** or **Vector Values**.`,
      propDefinition: [
        app,
        "vectorId",
      ],
    },
    vector: {
      description: `${app.propDefinitions.vectorValues.description} Each request can contain only one of the parameters either **Vector Values** or **Vector ID**.`,
      propDefinition: [
        app,
        "vectorValues",
      ],
    },
  },
  methods: {
    query(args = {}) {
      return this.app.post({
        path: "/query",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      query,
      indexName,
      id,
      vector,
      topK,
      filter,
      includeValues,
      includeMetadata,
      namespace,
    } = this;

    const vectorParsed = utils.parseArray(vector);

    const response = await query({
      step,
      indexName,
      data: {
        id,
        ...(vectorParsed.length && {
          vector: vectorParsed,
        }),
        topK,
        filter: utils.parse(filter),
        includeValues,
        includeMetadata,
        namespace,
      },
    });

    step.export("$summary", `Successfully queried ${response.matches.length} matches.`);

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
PineconeappappThis component uses the Pinecone app.
Index NameindexNamestringSelect a value from the drop down menu.
Top KtopKinteger

The number of results to return. E.g. 10

Filterfilterobject

The filter to apply. You can use vector metadata to limit your search. For guidance and examples, see filtering-with-metadata.

Include ValuesincludeValuesboolean

Whether to include the vector values in the response.

Include MetadataincludeMetadataboolean

Whether to include the vector metadata in the response.

Namespacenamespacestring

The namespace to use.

Vector IDidstring

The ID of the vector. Each request can contain only one of the parameters either Vector ID or Vector Values.

Vector Valuesvectorstring[]

The values of the vector. Each request can contain only one of the parameters either Vector Values or Vector ID.

Authentication

Pinecone uses API keys for authentication. When you connect your Pinecone account, Pipedream securely stores the keys so you can easily authenticate to Pinecone APIs in both code and no-code steps.

To connect your Pinecone account to Pipedream,

  1. Open the Pinecone console and click "API Keys"
  2. Copy the API key and Environment values and paste each below

About Pinecone

Long-term Memory for AI. The Pinecone vector database makes it easy to build high-performance vector search applications. Developer-friendly, fully managed, and easily scalable without infrastructure hassles.

More Ways to Use Pinecone

Actions

Delete Vectors with the Pinecone API

Deletes one or more vectors by ID, from a single namespace. See the documentation.

 
Try it
Fetch Vectors with the Pinecone API

Looks up and returns vectors by ID, from a single namespace.. See the documentation.

 
Try it
Update Vector with the Pinecone API

Updates vector in a namespace. If a value is included, it will overwrite the previous value. See the documentation.

 
Try it
Upsert Vector with the Pinecone API

Writes vectors into a namespace. If a new value is upserted for an existing vector ID, it will overwrite the previous value. See the documentation.

 
Try it

Explore Other Apps

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.