Class APIChain

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>
    tags?: string[]

    Accessors

    Methods

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

    Generated using TypeDoc