Object Detection with JigsawStack API on New File Created from OpenAI (ChatGPT) API

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

Trigger workflow on

New File Created from the OpenAI (ChatGPT) API

Next, do this

Object Detection with the JigsawStack 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 JigsawStack action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New File Created trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Optional- Select a Purpose
Configure the Object Detection action
1. Connect your JigsawStack account
2. Optional- Configure Image URL
3. Optional- Configure File Store Key
4. Optional- Configure Image File
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 File Created on OpenAI (ChatGPT)

Description:Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)

Version:0.0.10

Key:openai-new-file-created

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-file-created",
  name: "New File Created",
  description: "Emit new event when a new file is created in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/files/list)",
  version: "0.0.10",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    purpose: {
      propDefinition: [
        common.props.openai,
        "purpose",
      ],
      description: "If specified, events will only be emitted for files with the specified purpose.",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getData() {
      return this.openai.listFiles({
        purpose: this.purpose,
      });
    },
    getMeta(item) {
      return {
        id: item.id,
        summary: `New File: ${item.filename}`,
        ts: item.created_at * 1000,
      };
    },
  },
  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`
Purpose	`purpose`	`string`	Select a value from the drop down menu:`fine-tuneassistantsvisionbatch`

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#

Object Detection on JigsawStack

Description:Recognize objects within a provided image and retrieve it with great accuracy. [See the documentation](https://docs.jigsawstack.com/api-reference/ai/object-detection)

Version:0.0.1

Key:jigsawstack-object-detection

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import mime from "mime";
import {
  checkTmp,
  throwError,
} from "../../common/utils.mjs";
import jigsawstack from "../../jigsawstack.app.mjs";

export default {
  key: "jigsawstack-object-detection",
  name: "Object Detection",
  description: "Recognize objects within a provided image and retrieve it with great accuracy. [See the documentation](https://docs.jigsawstack.com/api-reference/ai/object-detection)",
  version: "0.0.1",
  type: "action",
  props: {
    jigsawstack,
    url: {
      type: "string",
      label: "Image URL",
      description: "The URL of the image to process.",
      optional: true,
    },
    fileStoreKey: {
      type: "string",
      label: "File Store Key",
      description: "The key used to store the image on Jigsawstack file [Storage](https://docs.jigsawstack.com/api-reference/store/file/add).",
      optional: true,
    },
    imageFile: {
      type: "string",
      label: "Image File",
      description: "The path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp).",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      jigsawstack,
      ...data
    } = this;

    if (Object.keys(data).length > 1) {
      throw new ConfigurationError("You must provide only one option, either the **Image URL**, the **Image File**, or the **File Storage Key**.");
    }

    if (data.fileStoreKey) data.file_store_key = data.fileStoreKey;

    if (data.imageFile) {
      const filePath = checkTmp(data.imageFile);
      const file = fs.readFileSync(filePath);
      const { key } = await jigsawstack.uploadFile({
        headers: {
          "Content-Type": mime.getType(filePath),
        },
        data: file,
      });
      data.file_store_key = key;
    }

    try {
      const response = await jigsawstack.detectObjectsInImage({
        $,
        data,
      });
      $.export("$summary", "Successfully detected objects in the image");
      return response;

    } catch (e) {
      return throwError(e);
    }
  },
};

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
JigsawStack	`jigsawstack`	`app`	This component uses the JigsawStack app.
Image URL	`url`	`string`	The URL of the image to process.
File Store Key	`fileStoreKey`	`string`	The key used to store the image on Jigsawstack file Storage.
Image File	`imageFile`	`string`	The path to a file in the `/tmp` directory. See the documentation on working with files.