​
Overview

The generateText method allows you to generate text responses from your workflows. This is useful when you need a complete response at once.

​
Usage

import Itzam from "itzam";

const itzam = new Itzam("YOUR_API_KEY");

const response = await itzam.generateText({
  input: "Hello, world!",
  workflowSlug: "my_great_workflow",
  // Optional parameters
  groupId: "my-group-id",
});

​
Parameters

ParameterTypeDescription
inputstringThe input text to generate a response for.
workflowSlugstringThe slug of the Workflow to use for generation.
groupIdstringOptional. Identifier for grouping related runs.

​
Return Value

The generateText method returns the following object:

type GenerateTextResponse = {
  text: string; // The generated text
  metadata: {
    runId: string; // The ID of the run
    cost: number; // The cost of the run in USD
    model: {
      name: string; // The name of the model
      tag: string; // The tag of the model
    };
    durationInMs: number; // The duration of the run in milliseconds
    inputTokens: number; // The number of input tokens used for this generation
    outputTokens: number; // The number of output tokens used for this generation
  };
};