View as Markdown
Pinecone icon

Pinecone ACTION

Query IDs

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.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pinecone account once, then configure and run Query IDs from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "pinecone-query-ids",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pinecone: { authProvisionId: "apn_xxxxxxx" },
    indexName: "Index Name",
    topK: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Query IDs inputs
Property Type Description
indexName Index Name string
The name of the index. E.g. my-index.pinecone.io
Required Dynamic
topK Top K integer
The number of results to return. E.g. 10
Required
filter Filter object
The filter to apply. You can use vector metadata to limit your search. For guidance and examples, see filtering-with-metadata.
Optional
includeValues Include Values boolean
Whether to include the vector values in the response.
Optional
includeMetadata Include Metadata boolean
Whether to include the vector metadata in the response.
Optional
namespace Namespace string
The namespace to use.
Optional
id Vector ID string
The ID of the vector. Each request can contain only one of the parameters either Vector ID or Vector Values.
Optional
vector Vector Values string[]
The values of the vector. Each request can contain only one of the parameters either Vector Values or Vector ID.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
pinecone-query-ids
Version
0.0.4
App
Pinecone
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes