Find Similar Links with Exa (Formerly Metaphor) API on New Run State Changed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for Exa (Formerly Metaphor), OpenAI (ChatGPT) and 2,200+ other apps remarkably fast.

Trigger workflow on

New Run State Changed from the OpenAI (ChatGPT) API

Next, do this

Find Similar Links with the Exa (Formerly Metaphor) 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 Exa (Formerly Metaphor) 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 Find Similar Links action
1. Connect your Exa (Formerly Metaphor) account
2. Configure Url
3. Optional- Configure Number Of Results
4. Optional- Configure Include Domains
5. Optional- Configure Exclude Domains
6. Optional- Configure Start Crawl Date
7. Optional- Configure End Crawl Date
8. Optional- Configure Start Published Date
9. Optional- Configure End Published Date
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.5

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.5",
  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#

Description:Find similar links to the link provided. See the documentation](https://docs.metaphor.systems/reference/findsimilar)

Version:0.0.1

Key:metaphor-find-similar-links

View on GitHub

Exa (Formerly Metaphor) Overview#

The Exa (Formerly Metaphor) API enables you to enrich your applications with machine learning-powered insights and data processing capabilities. With Exa, you can perform advanced data analysis, extract meaningful patterns, and automate decision-making processes within your projects. By integrating this API with Pipedream, you can create seamless workflows that leverage these intelligent features alongside other services to streamline your operations, enhance data intelligence, and drive innovation.

Action Code#

import metaphor from "../../metaphor.app.mjs";

export default {
  key: "metaphor-find-similar-links",
  name: "Find Similar Links",
  version: "0.0.1",
  description: "Find similar links to the link provided. See the documentation](https://docs.metaphor.systems/reference/findsimilar)",
  type: "action",
  props: {
    metaphor,
    url: {
      propDefinition: [
        metaphor,
        "url",
      ],
    },
    numResults: {
      propDefinition: [
        metaphor,
        "numResults",
      ],
      optional: true,
    },
    includeDomains: {
      propDefinition: [
        metaphor,
        "includeDomains",
      ],
      optional: true,
    },
    excludeDomains: {
      propDefinition: [
        metaphor,
        "excludeDomains",
      ],
      optional: true,
    },
    startCrawlDate: {
      propDefinition: [
        metaphor,
        "startCrawlDate",
      ],
      optional: true,
    },
    endCrawlDate: {
      propDefinition: [
        metaphor,
        "endCrawlDate",
      ],
      optional: true,
    },
    startPublishedDate: {
      propDefinition: [
        metaphor,
        "startPublishedDate",
      ],
      optional: true,
    },
    endPublishedDate: {
      propDefinition: [
        metaphor,
        "endPublishedDate",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      metaphor,
      ...data
    } = this;

    const response = await metaphor.findSimilarLinks({
      $,
      data,
    });

    $.export("$summary", `${response.results.length} result${response.results.length > 1
      ? "s were"
      : " was"} successfully fetched!`);
    return response;
  },
};

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
Exa (Formerly Metaphor)	`metaphor`	`app`	This component uses the Exa (Formerly Metaphor) app.
Url	`url`	`string`	"Crawl date" refers to the date that Metaphor discovered a link, which is more granular and can be more useful than published date. If endCrawlDate is specified, results will only include links that were crawled before endCrawlDate. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
Number Of Results	`numResults`	`integer`	Number of search results to return. Default 10. Up to 30 for basic plans. Up to thousands for custom plans.
Include Domains	`includeDomains`	`string[]`	List of domains to include in the search. If specified, results will only come from these domains. Only one of includeDomains and excludeDomains should be specified.
Exclude Domains	`excludeDomains`	`string[]`	List of domains to exclude in the search. If specified, results will only come from these domains. Only one of includeDomains and excludeDomains should be specified.
Start Crawl Date	`startCrawlDate`	`string`	"Crawl date" refers to the date that Metaphor discovered a link, which is more granular and can be more useful than published date. If startCrawlDate is specified, results will only include links that were crawled after startCrawlDate. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
End Crawl Date	`endCrawlDate`	`string`	"Crawl date" refers to the date that Metaphor discovered a link, which is more granular and can be more useful than published date. If endCrawlDate is specified, results will only include links that were crawled before endCrawlDate. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
Start Published Date	`startPublishedDate`	`string`	If specified, only links with a published date after startPublishedDate will be returned. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Note that for some links, we have no published date, and these links will be excluded from the results if startPublishedDate is specified.
End Published Date	`endPublishedDate`	`string`	If specified, only links with a published date before endPublishedDate will be returned. Must be specified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Note that for some links, we have no published date, and these links will be excluded from the results if endPublishedDate is specified.

Action Authentication#

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

Navigate to the overview tab to find your API key, and enter it below.