Get Business Details with Yelp API on New Run State Changed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Run State Changed from the OpenAI (ChatGPT) API

Next, do this

Get Business Details with the Yelp API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a OpenAI (ChatGPT) trigger and Yelp 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 Get Business Details action
1. Connect your Yelp account
2. Configure Business ID or Alias
3. Optional- Select a Device Platform
4. Optional- Configure Locale
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.1

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.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.1",
  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));
    },
  },
};

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.

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#

Get Business Details on Yelp

Description:Get details about a business [See docs here](https://docs.developer.yelp.com/reference/v3_business_info)

Version:0.0.1

Key:yelp-get-business-details

View on GitHub

Yelp Overview#

The Yelp API provides access to rich data on local businesses across various categories, including restaurants, bars, and service providers. Leveraging Yelp's API on Pipedream allows you to automate the retrieval of business information, ratings, and customer reviews, which can be instrumental in making data-driven decisions for market analysis, customer insights, or even personal use. By stitching the Yelp API into Pipedream workflows, you unlock potential for real-time monitoring, data collection, and cross-application synergy, enhancing your business intelligence and operational efficiency.

Action Code#

import { defineAction } from "@pipedream/types";
import yelp from "../../app/yelp.app.mjs";
import { DEVICE_OPTIONS, DOCS, } from "../../common/constants.mjs";
export default defineAction({
    name: "Get Business Details",
    description: `Get details about a business [See docs here](${DOCS.getBusinessDetails})`,
    key: "yelp-get-business-details",
    version: "0.0.1",
    type: "action",
    props: {
        yelp,
        businessIdOrAlias: {
            propDefinition: [
                yelp,
                "businessIdOrAlias",
            ],
        },
        devicePlatform: {
            label: "Device Platform",
            description: "Determines the platform for mobile_link",
            type: "string",
            options: DEVICE_OPTIONS,
            optional: true,
        },
        locale: {
            propDefinition: [
                yelp,
                "locale",
            ],
        },
    },
    async run({ $ }) {
        const { businessIdOrAlias, devicePlatform: device_platform, locale, } = this;
        const params = {
            $,
            businessIdOrAlias,
            params: {
                device_platform,
                locale,
            },
        };
        const business = await this.yelp.getBusinessDetails(params);
        $.export("$summary", `Obtained details for business "${business.name}"`);
        return business;
    },
});

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
Yelp	`yelp`	`app`	This component uses the Yelp app.
Business ID or Alias	`businessIdOrAlias`	`string`	A unique identifier for a Yelp Business. Can be either a 22-character Yelp Business ID, or a Yelp Business Alias.
Device Platform	`devicePlatform`	`string`	Select a value from the drop down menu:`{ "label": "Android", "value": "android" }{ "label": "iOS", "value": "ios" }{ "label": "Mobile (Generic)", "value": "mobile-generic" }`
Locale	`locale`	`string`	Locale code in the format of {language code}_{country code} (e.g. `en_US`). See the list of supported locales.

Action Authentication#

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

To retrieve your API key for Yelp,