Class APIChain

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

Hierarchy (view full)

BaseChain
- APIChain

Implements

APIChainInput

Index

Constructors

Properties

apiAnswerChain apiDocs apiRequestChain headers inputKey outputKey memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize fromLLMAndAPIDocs

Constructors

constructor

new APIChain(fields): APIChain
Parameters
- fields: APIChainInput
Returns APIChain
Overrides BaseChain.constructor
- Defined in langchain/src/chains/api/api_chain.ts:61

Properties

apiAnswerChain

apiAnswerChain: LLMChain<string, any>

apiDocs

apiDocs: string

apiRequestChain

apiRequestChain: LLMChain<string, any>

headers

headers: {} = {}

inputKey

inputKey: string = "question"

outputKey

outputKey: string = "output"

Key to use for output, defaults to output

`Optional`memory

memory?: any

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in langchain/src/chains/api/api_chain.ts:53

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in langchain/src/chains/api/api_chain.ts:57

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in langchain/src/chains/base.ts:258

call

call(values, config?, tags?): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: 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.
Inherited from BaseChain.call
- Defined in langchain/src/chains/base.ts:243

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.
- Optionaloptions: any
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in langchain/src/chains/base.ts:86

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>>
Inherited from BaseChain.prepOutputs
- Defined in langchain/src/chains/base.ts:149

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in langchain/src/chains/base.ts:190

serialize

serialize(): SerializedAPIChain
Return a json-like object representing this chain.

Returns SerializedAPIChain
Overrides BaseChain.serialize
- Defined in langchain/src/chains/api/api_chain.ts:119

`Static`deserialize

deserialize(data): Promise<APIChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedAPIChain
Returns Promise<APIChain>
Overrides BaseChain.deserialize
- Defined in langchain/src/chains/api/api_chain.ts:98

`Static`fromLLMAndAPIDocs

fromLLMAndAPIDocs(llm, apiDocs, options?): APIChain
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.
- Defined in langchain/src/chains/api/api_chain.ts:136