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

Hierarchy (view full)




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

Type declaration

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

    Key to use for output, defaults to output

    memory?: any



    • Parameters

      • inputs: ChainValues[]
      • Optional config: any[]

      Returns Promise<ChainValues[]>

      ⚠️ Deprecated ⚠️

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

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

      It is not recommended for use.

      Call the chain on all inputs in the list

    • Parameters

      • values: any
      • Optional config: any
      • Optional tags: 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.


      • input: ChainValues

        Input values for the chain run.

      • Optional options: 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
      • Optional config: 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.


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

    Generated using TypeDoc