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: ChatPromptValue
aiName: string
aiRole: string
inputVariables: string[]

A list of variable names the prompt template expects

lc_kwargs: SerializedFields
lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable: boolean = true
partialVariables: PartialValues<any>

Partial variables

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

Type declaration

    • (text): Promise<number>
    • Parameters

      • text: string

      Returns Promise<number>

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

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

lc_runnable: boolean = true

Accessors

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

    Returns undefined | {
        [key: string]: string;
    }

  • get lc_attributes(): undefined | SerializedFields
  • A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

    Returns undefined | SerializedFields

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

    Returns undefined | {
        [key: string]: string;
    }

Methods

  • Internal method that handles batching and configuration for a runnable It takes a function, input values, and optional configuration, and returns a promise that resolves to the output values.

    Type Parameters

    • T extends any

    Parameters

    • func: ((inputs, options?, runManagers?, batchOptions?) => Promise<(Error | ChatPromptValue)[]>)

      The function to be executed for each input value.

    • inputs: T[]
    • Optional options: Partial<BaseCallbackConfig & {
          runType?: string;
      }> | Partial<BaseCallbackConfig & {
          runType?: string;
      }>[]
    • Optional batchOptions: RunnableBatchOptions

    Returns Promise<(Error | ChatPromptValue)[]>

    A promise that resolves to the output values.

  • 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" });
    
  • 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<ChatPromptValue>

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

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

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

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

    A new runnable sequence.

  • 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<BaseCallbackConfig>
    • 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

    Returns AsyncGenerator<ChatPromptValue, any, unknown>

  • Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

    Type Parameters

    • I extends any

    • O extends ChatPromptValue<O>

    Parameters

    • inputGenerator: AsyncGenerator<I, any, unknown>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
        • (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
        • Parameters

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: BaseCallbackConfig & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

Generated using TypeDoc