Class APIChain

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

Hierarchy (view full)

Implements

Constructors

constructor

Properties

apiAnswerChain apiDocs apiRequestChain headers inputKey outputKey memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize fromLLMAndAPIDocs

Constructors

constructor

Properties

apiAnswerChain

apiAnswerChain: LLMChain<string, LLMType>

apiDocs

apiDocs: string

apiRequestChain

apiRequestChain: LLMChain<string, LLMType>

headers

headers: {} = {}

Type declaration

    inputKey

    inputKey: string = "question"

    outputKey

    outputKey: string = "output"

    Key to use for output, defaults to output

    Optional memory

    memory?: BaseMemory

    Accessors

    inputKeys

    outputKeys

    Methods

    apply

    • apply(inputs, config?): Promise<ChainValues[]>

    • Parameters

      • inputs: ChainValues[]
      • Optional config: (RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[])[]

      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

    call

    • call(values, config?, tags?): Promise<ChainValues>

    • Parameters

      • values: ChainValues & {
            signal?: AbortSignal;
            timeout?: number;
        }
      • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]
      • 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.

    invoke

    • invoke(input, options?): Promise<ChainValues>

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

      Parameters

      • input: ChainValues

        Input values for the chain run.

      • Optional options: RunnableConfig

      Returns Promise<ChainValues>

      Promise that resolves with the output of the chain run.

    prepOutputs

    • prepOutputs(inputs, outputs, returnOnlyOutputs?): Promise<Record<string, unknown>>

    • Parameters

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

      Returns Promise<Record<string, unknown>>

    run

    • run(input, config?): Promise<string>

    • Parameters

      • input: any
      • Optional config: RunnableConfig | CallbackManager | (BaseCallbackHandler | BaseCallbackHandlerMethodsClass)[]

      Returns Promise<string>

      Deprecated

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

    serialize

    Static deserialize

    Static fromLLMAndAPIDocs

    • fromLLMAndAPIDocs(llm, apiDocs, options?): APIChain

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

      Parameters

      • llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

        BaseLanguageModel instance.

      • apiDocs: string

        API documentation.

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

        Optional configuration options for the APIChain.

      Returns APIChain

      New APIChain instance.

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc