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

Hierarchy (view full)

Implements

Constructors

Properties

apiAnswerChain: LLMChain<string, any>
apiDocs: string
apiRequestChain: LLMChain<string, any>
headers: {} = {}
inputKey: string = "question"
outputKey: string = "output"

Key to use for output, defaults to output

memory?: any

Accessors

Methods

  • Parameters

    • inputs: ChainValues[]
    • Optionalconfig: any[]

    Returns Promise<ChainValues[]>

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

    Call the chain on all inputs in the list

  • Parameters

    • values: any
    • Optionalconfig: any
    • Optionaltags: string[]

    Returns Promise<ChainValues>

    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.

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

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optionaloptions: any

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

  • Parameters

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

    Returns Promise<Record<string, unknown>>

  • Parameters

    • input: any
    • Optionalconfig: any

    Returns Promise<string>

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

  • Static method to create a new APIChain from a BaseLanguageModel and API documentation.

    Parameters

    • llm: BaseLanguageModelInterface

      BaseLanguageModel instance.

    • apiDocs: string

      API documentation.

    • options: APIChainOptions & Omit<APIChainInput, "apiAnswerChain" | "apiRequestChain" | "apiDocs"> = {}

      Optional configuration options for the APIChain.

    Returns APIChain

    New APIChain instance.

""