Class used to generate prompts for the AutoGPT model. It takes into account the AI's name, role, tools, token counter, and send token limit. The class also handles the formatting of messages and the construction of the full prompt.

Hierarchy

Implements

Constructors

Properties

PromptValueReturnType: ChatPromptValueInterface
aiName: string
aiRole: string
inputVariables: string[]

A list of variable names the prompt template expects

partialVariables: PartialValues<any>

Partial variables

sendTokenLimit: number
tokenCounter: ((text) => Promise<number>)

Type declaration

    • (text): Promise<number>
    • Parameters

      • text: string

      Returns Promise<number>

tools: ObjectTool[]
name?: string
outputParser?: BaseOutputParser<unknown>

How to parse the output of calling an LLM on this formatted prompt

Methods

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns Runnable<any, any, RunnableConfig>

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: any[]

      Array of inputs to each batch call.

    • Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<ChatPromptValueInterface[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Error | ChatPromptValueInterface)[]>

  • Parameters

    Returns Promise<(Error | ChatPromptValueInterface)[]>

  • Constructs the full prompt based on the provided goals.

    Parameters

    • goals: string[]

      An array of goals.

    Returns string

    The full prompt as a string.

  • Format the prompt given the input values.

    Parameters

    • values: TypedPromptInputValues<any>

      A dictionary of arguments to be passed to the prompt template.

    Returns Promise<string>

    A formatted prompt string.

    Example

    prompt.format({ foo: "bar" });
    
  • Format the prompt given the input values and return a formatted prompt value.

    Parameters

    • values: TypedPromptInputValues<any>

    Returns Promise<ChatPromptValueInterface>

    A formatted PromptValue.

  • Parameters

    • Optional suffix: string

    Returns string

  • Invokes the prompt template with the given input and options.

    Parameters

    • input: any

      The input to invoke the prompt template with.

    • Optional options: BaseCallbackConfig

      Optional configuration for the callback.

    Returns Promise<ChatPromptValueInterface>

    A Promise that resolves to the output of the prompt template.

  • Merges partial variables and user variables.

    Parameters

    • userVariables: TypedPromptInputValues<any>

      The user variables to merge with the partial variables.

    Returns Promise<InputValues<any>>

    A Promise that resolves to an object containing the merged variables.

  • 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<ChatPromptValueInterface, NewRunOutput>

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

    Returns Runnable<any, Exclude<NewRunOutput, Error>, RunnableConfig>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<ChatPromptValueInterface>>

    A readable stream that is also an iterable.

  • 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

    • input: any
    • Optional options: Partial<RunnableConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • 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

    • generator: AsyncGenerator<any, any, unknown>
    • options: Partial<RunnableConfig>

    Returns AsyncGenerator<ChatPromptValueInterface, any, unknown>

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    Returns RunnableWithFallbacks<any, ChatPromptValueInterface>

    A new RunnableWithFallbacks.

  • 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<any, ChatPromptValueInterface, RunnableConfig>

  • Returns Promise<BasePromptTemplate<InputValues, BasePromptValueInterface, string>>

    ⚠️ Deprecated ⚠️

    Load a prompt template from a json-like object describing it.

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

    Remarks

    Deserializing needs to be async because templates (e.g. FewShotPromptTemplate) can reference remote resources that we read asynchronously with a web request.

Generated using TypeDoc