Class that extends BaseChain and represents a chain specifically designed for making API requests and processing API responses.

Hierarchy

Implements

Constructors

Properties

apiAnswerChain: LLMChain<string, LLMType>
apiDocs: string
apiRequestChain: LLMChain<string, LLMType>
headers: {} = {}

Type declaration

    inputKey: string = "question"
    outputKey: string = "output"

    Key to use for output, defaults to output

    verbose: boolean

    Whether to print out response text.

    callbacks?: Callbacks
    memory?: BaseMemory
    metadata?: Record<string, unknown>
    name?: string
    tags?: string[]

    Accessors

    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 RunnableSequence<any, any>

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

      Parameters

      • inputs: ChainValues[]

        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<ChainValues[]>

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

    • Parameters

      Returns Promise<(Error | ChainValues)[]>

    • Parameters

      Returns Promise<(Error | ChainValues)[]>

    • Parameters

      • values: ChainValues & {
            signal?: AbortSignal;
            timeout?: number;
        }
      • Optional config: RunnableConfig | Callbacks
      • Optional tags: string[]

        Deprecated

      Returns Promise<ChainValues>

      Deprecated

      Use .invoke() instead. Will be removed in 0.2.0.

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

      Wraps _call and handles memory.

    • Parameters

      • Optional suffix: string

      Returns string

    • Pick keys from the dict output of this runnable. Returns a new runnable.

      Parameters

      • keys: string | string[]

      Returns RunnableSequence<any, any>

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

    • Parameters

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

      Returns Promise<Record<string, unknown>>

    • Stream output in chunks.

      Parameters

      Returns Promise<IterableReadableStream<ChainValues>>

      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: ChainValues
      • 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

      Returns AsyncGenerator<ChainValues, any, unknown>

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

    Generated using TypeDoc