Class OpenAIModerationChain

Class representing a chain for moderating text using the OpenAI Moderation API. It extends the BaseChain class and implements the OpenAIModerationChainInput interface.

Example

const moderation = new ChatOpenAIModerationChain({ throwError: true });

const badString = "Bad naughty words from user";

try {
  const { output: moderatedContent, results } = await moderation.call({
    input: badString,
  });

  if (results[0].category_scores["harassment/threatening"] > 0.01) {
    throw new Error("Harassment detected!");
  }

  const model = new OpenAI({ temperature: 0 });
  const promptTemplate = "Hello, how are you today {person}?";
  const prompt = new PromptTemplate({
    template: promptTemplate,
    inputVariables: ["person"],
  });
  const chain = new LLMChain({ llm: model, prompt });
  const response = await chain.call({ person: moderatedContent });
  console.log({ response });
} catch (error) {
  console.error("Naughty words detected!");
}

Hierarchy

Implements

  • OpenAIModerationChainInput

Constructors

constructor

Properties

caller client clientConfig inputKey outputKey throwError verbose callbacks? memory? metadata? openAIApiKey? openAIOrganization? tags?

Accessors

inputKeys outputKeys

Methods

apply batch bind call invoke map pipe prepOutputs run serialize stream streamLog toJSON toJSONNotImplemented transform withConfig withFallbacks withListeners withRetry deserialize isRunnable

Constructors

constructor

Properties

caller

caller: AsyncCaller

client

client: OpenAI

clientConfig

clientConfig: ClientOptions

inputKey

inputKey: string = "input"

outputKey

outputKey: string = "output"

throwError

throwError: boolean

verbose

verbose: boolean

Whether to print out response text.

Optional callbacks

callbacks?: Callbacks

Optional memory

memory?: BaseMemory

Optional metadata

metadata?: Record<string, unknown>

Optional openAIApiKey

openAIApiKey?: string

Optional openAIOrganization

openAIOrganization?: string

Optional tags

tags?: string[]

Accessors

inputKeys

  • get inputKeys(): string[]

  • Returns string[]

outputKeys

  • get outputKeys(): string[]

  • Returns string[]

Methods

apply

batch

bind

call

  • Run the core logic of this chain and add to output if desired.

    Wraps _call and handles memory.

    Parameters

    Returns Promise<ChainValues>

invoke

  • Invoke the chain with the provided input and returns the output.

    Parameters

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

map

pipe

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<ChainValues, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<ChainValues, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

prepOutputs

  • Parameters

    • inputs: Record<string, unknown>
    • outputs: Record<string, unknown>
    • returnOnlyOutputs: boolean = false

    Returns Promise<Record<string, unknown>>

run

  • Parameters

    Returns Promise<string>

serialize

stream

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<ChainValues>>

    A readable stream that is also an iterable.

streamLog

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

toJSON

toJSONNotImplemented

transform

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<ChainValues, any, unknown>

withConfig

withFallbacks

withListeners

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<ChainValues, ChainValues, BaseCallbackConfig>

withRetry

Static deserialize

Static isRunnable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc