Classify Text with Nyckel API on New Batch Completed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

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

Select this integration
Configure the New Batch Completed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
Configure the Classify Text action
1. Connect your Nyckel account
2. Select a Function ID
3. Configure Text Input
4. Optional- Configure Label Count
5. Optional- Configure Include Metadata
6. Optional- Configure Capture
7. Optional- Configure External ID
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 Batch Completed on OpenAI (ChatGPT)

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

Version:0.0.5

Key:openai-new-batch-completed

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-batch-completed",
  name: "New Batch Completed",
  description: "Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    _getLastCompleted() {
      return this.db.get("lastCompleted") || 0;
    },
    _setLastCompleted(lastCompleted) {
      this.db.set("lastCompleted", lastCompleted);
    },
    getMeta(batch) {
      return {
        id: batch.id,
        summary: `Batch Completed with ID ${batch.id}`,
        ts: batch.completed_at * 1000,
      };
    },
    async getAndProcessItems(max) {
      const lastCompleted = this._getLastCompleted();
      let maxCompleted = lastCompleted;
      const results = this.openai.paginate({
        resourceFn: this.openai.listBatches,
        max,
      });
      const batches = [];
      for await (const batch of results) {
        if (batch.completed_at && batch.completed_at > lastCompleted) {
          batches.push(batch);
          maxCompleted = Math.max(batch.completed_at, maxCompleted);
        }
      }
      this._setLastCompleted(maxCompleted);
      batches.reverse().forEach((item) => this.$emit(item, this.getMeta(item)));
    },
  },
  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`

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#

Classify Text on Nyckel

Description:Classifies text data based on pre-trained classifiers in Nyckel. [See the documentation](https://www.nyckel.com/docs#invoke-text)

Version:0.0.1

Key:nyckel-classify-text

View on GitHub

Nyckel Overview#

The Nyckel API offers machine learning capabilities, enabling you to add custom image and text classification to your applications without needing a data science background. With Nyckel, you can train models, make predictions, and refine your model iteratively as new data comes in. On Pipedream, you can integrate Nyckel to automate various tasks such as processing images uploaded to cloud storage, categorizing customer support tickets, or augmenting content moderation workflows. By harnessing the power of serverless on Pipedream, you can create efficient pipelines that respond in real-time to events, without managing infrastructure.

Action Code#

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

export default {
  key: "nyckel-classify-text",
  name: "Classify Text",
  description: "Classifies text data based on pre-trained classifiers in Nyckel.  [See the documentation](https://www.nyckel.com/docs#invoke-text)",
  version: "0.0.1",
  type: "action",
  props: {
    nyckel,
    functionId: {
      propDefinition: [
        nyckel,
        "functionId",
      ],
    },
    textInput: {
      type: "string",
      label: "Text Input",
      description: "The text input to classify",
    },
    labelCount: {
      propDefinition: [
        nyckel,
        "labelCount",
      ],
    },
    includeMetadata: {
      propDefinition: [
        nyckel,
        "includeMetadata",
      ],
    },
    capture: {
      propDefinition: [
        nyckel,
        "capture",
      ],
    },
    externalId: {
      propDefinition: [
        nyckel,
        "externalId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.nyckel.invokeFunction({
      $,
      functionId: this.functionId,
      data: {
        data: this.textInput,
      },
      params: {
        labelCount: this.labelCount,
        includeMetadata: this.includeMetadata,
        capture: this.capture,
        externalId: this.externalId,
      },
    });

    $.export("$summary", "Successfully classified text data");
    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
Nyckel	`nyckel`	`app`	This component uses the Nyckel app.
Function ID	`functionId`	`string`	Select a value from the drop down menu.
Text Input	`textInput`	`string`	The text input to classify
Label Count	`labelCount`	`integer`	The number of labels to return, along with their confidences. When not specified, only the highest confidence result is returned.
Include Metadata	`includeMetadata`	`boolean`	Whether to include the label metadata in the response.
Capture	`capture`	`boolean`	Whether to enable invoke capture for this invoke. Invoke capture saves informative samples captured from your invokes for future annotation.
External ID	`externalId`	`string`	Your unique identifier for this sample. This will be used if this invoke is saved through Invoke Capture.

Action Authentication#

Nyckel uses OAuth authentication. When you connect your Nyckel account, Pipedream will open a popup window where you can sign into Nyckel and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Nyckel API.

Pipedream requests the following authorization scopes when you connect your account: