Append to Thread in Automation Run with Testmo API on New Batch Completed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Append to Thread in Automation Run with the Testmo 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 Testmo 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 Append to Thread in Automation Run action
1. Connect your Testmo account
2. Select a Project Id
3. Select a Automation Run Id
4. Select a Thread Id
5. Optional- Configure Elapsed Observed
6. Optional- Configure Artifacts
7. Optional- Configure Number of Fields
8. Optional- Configure Number of Tests
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.4

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

Append to Thread in Automation Run on Testmo

Description:Appends test artifacts, fields or test results to an existing thread in an automation run. [See the documentation](https://docs.testmo.com/api/reference/automation-runs#post-automation-runs-threads-automation_run_thread_id-append)

Version:0.0.1

Key:testmo-append-to-thread

View on GitHub

Testmo Overview#

The Testmo API enables automation and integration of your testing workflows into the broader CI/CD pipeline. With Pipedream, you can use this API to trigger tests, update test cases, log results, and sync status with other project management tools. By creating custom serverless workflows on Pipedream, you can connect Testmo to various apps, manage test lifecycles, and respond to events from other services in real-time.

Action Code#

import testmo from "../../testmo.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "testmo-append-to-thread",
  name: "Append to Thread in Automation Run",
  version: "0.0.1",
  description: "Appends test artifacts, fields or test results to an existing thread in an automation run. [See the documentation](https://docs.testmo.com/api/reference/automation-runs#post-automation-runs-threads-automation_run_thread_id-append)",
  type: "action",
  props: {
    testmo,
    projectId: {
      propDefinition: [
        testmo,
        "projectId",
      ],
    },
    automationRunId: {
      propDefinition: [
        testmo,
        "automationRunId",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
    threadId: {
      propDefinition: [
        testmo,
        "threadId",
        (c) => ({
          automationRunId: c.automationRunId,
        }),
      ],
    },
    elapsedObserved: {
      type: "integer",
      label: "Elapsed Observed",
      description: "Partial observed elapsed (execution time) in microseconds to add to the overall observed time of the thread.",
      optional: true,
    },
    artifacts: {
      propDefinition: [
        testmo,
        "artifacts",
      ],
    },
    numFields: {
      type: "integer",
      label: "Number of Fields",
      description: "Number of fields to append",
      optional: true,
      reloadProps: true,
    },
    numTests: {
      type: "integer",
      label: "Number of Tests",
      description: "Number of tests to append",
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.numFields) {
      for (let i = 1; i <= this.numFields; i++) {
        props[`fieldName_${i}`] = {
          type: "string",
          label: `Field ${i} - Name`,
        };
        props[`type_${i}`] = {
          type: "integer",
          label: `Field ${i} - Type`,
          options: constants.FIELD_TYPES,
        };
        props[`value_${i}`] = {
          type: "string",
          label: `Field ${i} - Value`,
          optional: true,
        };
      }
    }
    if (this.numTests) {
      for (let i = 1; i <= this.numTests; i++) {
        props[`key_${i}`] = {
          type: "string",
          label: `Test ${i} - Key`,
          description: "Key used to identify tests across multiple automation runs (in the context of the same source)",
        };
        props[`testName_${i}`] = {
          type: "string",
          label: `Test ${i} - Name`,
          description: "Name of the test",
        };
        props[`status_${i}`] = {
          type: "string",
          label: `Test ${i} - Status`,
          description: "Alias of the status for the result of the test (for example, `failed` or `passed`). The status aliases can be configured in Testmo's admin area.",
        };
        props[`folder_${i}`] = {
          type: "string",
          label: `Test ${i} - Folder`,
          description: "Fully qualified name of the target folder of the test. Folders can be used to group related tests and usually map to class or type names as defined in the test automation suite",
        };
      }
    }
    return props;
  },
  async run({ $ }) {
    const artifacts = this.artifacts?.map((artifact) => ({
      name: artifact,
      url: artifact,
    }));
    const fields = [];
    for (let i = 1; i <= this.numFields; i++) {
      fields.push({
        name: this[`fieldName_${i}`],
        type: this[`type_${i}`],
        value: this[`value_${i}`],
      });
    }
    const tests = [];
    for (let i = 1; i <= this.numTests; i++) {
      tests.push({
        key: this[`key_${i}`],
        name: this[`testName_${i}`],
        status: this[`status_${i}`],
        folder: this[`folder_${i}`],
      });
    }

    const response = await this.testmo.appendToThread({
      threadId: this.threadId,
      data: {
        elapsed_observed: this.elapsedObserved,
        artifacts,
        fields,
        tests,
      },
      $,
    });

    $.export("$summary", `Successfully appended data to automation run thread with ID ${this.threadId}.`);

    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
Testmo	`testmo`	`app`	This component uses the Testmo app.
Project Id	`projectId`	`string`	Select a value from the drop down menu.
Automation Run Id	`automationRunId`	`string`	Select a value from the drop down menu.
Thread Id	`threadId`	`string`	Select a value from the drop down menu.
Elapsed Observed	`elapsedObserved`	`integer`	Partial observed elapsed (execution time) in microseconds to add to the overall observed time of the thread.
Artifacts	`artifacts`	`string[]`	List of URLs of externally stored test artifacts to link to the thread (such as log files, screenshots or test data)
Number of Fields	`numFields`	`integer`	Number of fields to append
Number of Tests	`numTests`	`integer`	Number of tests to append

Action Authentication#

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

To retrieve your API Key,