Class APIChain

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

Hierarchy (View Summary)

BaseChain
- APIChain

Implements

APIChainInput

Index

Constructors

constructor

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

Properties

apiAnswerChain

apiAnswerChain: LLMChain

apiDocs

apiDocs: string

apiRequestChain

apiRequestChain: LLMChain

headers

headers: {} = {}

inputKey

inputKey: string = "question"

`Optional`memory

memory?: any

outputKey

outputKey: string = "output"

Key to use for output, defaults to output

Accessors

inputKeys

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

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from QAEvalChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:41

outputKeys

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

Methods

_chainType

_chainType(): "api_chain"
Return the string type key uniquely identifying this class of chain.

Returns "api_chain"
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/api/api_chain.ts:94

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from BaseChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:258

call

call(values: any, config?: any, tags?: string[]): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:243

invoke

invoke(input: ChainValues, options?: any): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:86

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:149

run

run(input: any, config?: any): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:190

serialize

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

Returns SerializedAPIChain
Overrides BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/api/api_chain.ts:119

`Static`deserialize

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

`Static`fromLLMAndAPIDocs

fromLLMAndAPIDocs(
    llm: BaseLanguageModelInterface,
    apiDocs: string,
    options?: APIChainOptions & Omit<
        APIChainInput,
        "apiAnswerChain"
        | "apiRequestChain"
        | "apiDocs",
    >,
): 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 remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/api/api_chain.ts:136

Class APIChain

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns APIChain

Properties

apiAnswerChain

apiDocs

apiRequestChain

headers

inputKey

Optionalmemory

outputKey

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_chainType

Returns "api_chain"

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedAPIChain

Staticdeserialize

Parameters

Returns Promise<APIChain>

StaticfromLLMAndAPIDocs

Parameters

Returns APIChain

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`fromLLMAndAPIDocs