Delete Vectors with Pinecone API on New Run State Changed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Pinecone, OpenAI (ChatGPT) and 2,400+ other apps remarkably fast.

Trigger workflow on

New Run State Changed from the OpenAI (ChatGPT) API

Next, do this

Delete Vectors with the Pinecone API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a OpenAI (ChatGPT) trigger and Pinecone action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Run State Changed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Configure Thread ID
Configure the Delete Vectors action
1. Connect your Pinecone account
2. Select a Index Name
3. Optional- Configure Prefix
4. Optional- Configure Namespace
5. Configure Vector IDs
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Run State Changed on OpenAI (ChatGPT)

Description:Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)

Version:0.0.6

Key:openai-new-run-state-changed

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-run-state-changed",
  name: "New Run State Changed",
  description: "Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    threadId: {
      propDefinition: [
        common.props.openai,
        "threadId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getStatusItems() {
      return this.db.get("statusItems");
    },
    setStatusItems(value) {
      this.db.set("statusItems", value);
    },
    async getData() {
      const {
        openai,
        threadId,
      } = this;

      const { data } = await openai.listRuns({
        threadId,
      });

      return data;
    },
    getMeta(item) {
      const ts = Date.now();
      return {
        id: `${item.id}-${ts}`,
        summary: `Run State Changed: ${item.id}`,
        ts,
      };
    },
    statusByItemId(itemId, statusItems) {
      const { [itemId]: status } = statusItems || {};
      return status;
    },
    buildStatusItems(data) {
      return data?.reduce((acc, item) => ({
        ...acc,
        [item.id]: item.status,
      }), {});
    },
    async getAndProcessItems(maxEvents) {
      const {
        getData,
        getStatusItems,
        setStatusItems,
        statusByItemId,
        buildStatusItems,
        getMeta,
        $emit: emit,
      } = this;

      const data = await getData();
      const statusItems = getStatusItems();

      Array.from(data)
        .reverse()
        .forEach((item, index) => {
          const statusChanged = statusByItemId(item.id, statusItems) !== item.status;
          if ((!maxEvents || index < maxEvents) && statusChanged) {
            emit(item, getMeta(item));
          }
        });

      setStatusItems(buildStatusItems(data));
    },
  },
  sampleEmit,
};

Trigger 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.

Label	Prop	Type	Description
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs

Trigger Authentication#

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

About 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.

Action#

Delete Vectors on Pinecone

Description:Deletes one or more vectors by ID, from a single namespace. [See the documentation](https://docs.pinecone.io/reference/api/data-plane/delete).

Version:0.0.2

Key:pinecone-delete-vectors

View on GitHub

Pinecone Overview#

The Pinecone API enables you to work with vector databases, which are essential for building and scaling applications with AI features like recommendation systems, image recognition, and natural language processing. On Pipedream, you can create serverless workflows integrating Pinecone with other apps, automate data ingestion, query vector databases in response to events, and orchestrate complex data processing pipelines that leverage Pinecone's similarity search.

Action Code#

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

export default {
  key: "pinecone-delete-vectors",
  name: "Delete Vectors",
  description: "Deletes one or more vectors by ID, from a single namespace. [See the documentation](https://docs.pinecone.io/reference/api/data-plane/delete).",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    indexName: {
      propDefinition: [
        app,
        "indexName",
      ],
    },
    prefix: {
      propDefinition: [
        app,
        "prefix",
      ],
    },
    namespace: {
      propDefinition: [
        app,
        "namespace",
      ],
    },
    ids: {
      type: "string[]",
      label: "Vector IDs",
      description: "The IDs of the vectors. E.g. `[\"vec1\", \"vec2\"]`",
      propDefinition: [
        app,
        "vectorId",
      ],
    },
  },
  methods: {
    deleteVector(args = {}) {
      return this.app.post({
        path: "/vectors/delete",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      deleteVector,
      indexName,
      ids,
      namespace,
    } = this;

    await deleteVector({
      step,
      indexName,
      data: {
        ids: utils.parseArray(ids),
        namespace,
      },
    });

    step.export("$summary", "Successfully deleted vectors");
    return {
      success: true,
    };
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Pinecone	`app`	`app`	This component uses the Pinecone app.
Index Name	`indexName`	`string`	Select a value from the drop down menu.
Prefix	`prefix`	`string`	The vector IDs to fetch. Does not accept values containing spaces. E.g. `my-prefix`
Namespace	`namespace`	`string`	The namespace to use.
Vector IDs	`ids`	`string[]`	The IDs of the vectors. E.g. `["vec1", "vec2"]`

Action 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,