Interface BaseLanguageModelInterface<RunOutput, CallOptions>

Base interface implemented by all runnables. Used for cross-compatibility between different versions of LangChain core.

Should not change on patch releases.

Type Parameters

RunOutput = any
CallOptions extends BaseLanguageModelCallOptions = BaseLanguageModelCallOptions

Hierarchy

RunnableInterface<BaseLanguageModelInput, RunOutput, CallOptions>
- BaseLanguageModelInterface

Implemented by

BaseLanguageModel

Index

Properties

CallOptions

CallOptions: CallOptions

Accessors

callKeys

get callKeys(): string[]
Returns string[]
- Defined in langchain-core/dist/language_models/base.d.ts:106

Methods

batch

batch(inputs, options?, batchOptions?): Promise<RunOutput[]>
Parameters
- inputs: BaseLanguageModelInput[]
- Optional options: Partial<CallOptions> | Partial<CallOptions>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<RunOutput[]>
Inherited from RunnableInterface.batch
- Defined in langchain-core/dist/runnables/base.d.ts:16
batch(inputs, options?, batchOptions?): Promise<(RunOutput | Error)[]>
Parameters
- inputs: BaseLanguageModelInput[]
- Optional options: Partial<CallOptions> | Partial<CallOptions>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(RunOutput | Error)[]>
Inherited from RunnableInterface.batch
- Defined in langchain-core/dist/runnables/base.d.ts:19
batch(inputs, options?, batchOptions?): Promise<(RunOutput | Error)[]>
Parameters
- inputs: BaseLanguageModelInput[]
- Optional options: Partial<CallOptions> | Partial<CallOptions>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(RunOutput | Error)[]>
Inherited from RunnableInterface.batch
- Defined in langchain-core/dist/runnables/base.d.ts:22

generatePrompt

generatePrompt(promptValues, options?, callbacks?): Promise<LLMResult>
Parameters
- promptValues: BasePromptValueInterface[]
- Optional options: CallOptions | string[]
- Optional callbacks: Callbacks
Returns Promise<LLMResult>
- Defined in langchain-core/dist/language_models/base.d.ts:107

getNumTokens

getNumTokens(content): Promise<number>
Parameters
- content: MessageContent
Returns Promise<number>
- Defined in langchain-core/dist/language_models/base.d.ts:118

invoke

invoke(input, options?): Promise<RunOutput>
Parameters
- input: BaseLanguageModelInput
- Optional options: Partial<CallOptions>
Returns Promise<RunOutput>
Inherited from RunnableInterface.invoke
- Defined in langchain-core/dist/runnables/base.d.ts:15

predict

predict(text, options?, callbacks?): Promise<string>
Parameters
- text: string
- Optional options: CallOptions | string[]
- Optional callbacks: Callbacks
Returns Promise<string>

⚠️ Deprecated ⚠️

Use .invoke() 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.
- Defined in langchain-core/dist/language_models/base.d.ts:111

predictMessages

predictMessages(messages, options?, callbacks?): Promise<BaseMessage>
Parameters
- messages: BaseMessage[]
- Optional options: CallOptions | string[]
- Optional callbacks: Callbacks
Returns Promise<BaseMessage>

Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
- Defined in langchain-core/dist/language_models/base.d.ts:115

serialize

serialize(): SerializedLLM
Returns SerializedLLM
- Defined in langchain-core/dist/language_models/base.d.ts:123

stream

stream(input, options?): Promise<IterableReadableStreamInterface<RunOutput>>
Parameters
- input: BaseLanguageModelInput
- Optional options: Partial<CallOptions>
Returns Promise<IterableReadableStreamInterface<RunOutput>>
Inherited from RunnableInterface.stream
- Defined in langchain-core/dist/runnables/base.d.ts:23

transform

transform(generator, options): AsyncGenerator<RunOutput, any, unknown>
Parameters
- generator: AsyncGenerator<BaseLanguageModelInput, any, unknown>
- options: Partial<CallOptions>
Returns AsyncGenerator<RunOutput, any, unknown>
Inherited from RunnableInterface.transform
- Defined in langchain-core/dist/runnables/base.d.ts:24

Interface BaseLanguageModelInterface<RunOutput, CallOptions>

Type Parameters

RunOutput = any

CallOptions extends BaseLanguageModelCallOptions = BaseLanguageModelCallOptions

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

CallOptions

Accessors

callKeys

Returns string[]

Methods

batch

Parameters

inputs: BaseLanguageModelInput[]

Optional options: Partial<CallOptions> | Partial<CallOptions>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<RunOutput[]>

Parameters

inputs: BaseLanguageModelInput[]

Optional options: Partial<CallOptions> | Partial<CallOptions>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(RunOutput | Error)[]>

Parameters

inputs: BaseLanguageModelInput[]

Optional options: Partial<CallOptions> | Partial<CallOptions>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(RunOutput | Error)[]>

generatePrompt

Parameters

promptValues: BasePromptValueInterface[]

Optional options: CallOptions | string[]

Optional callbacks: Callbacks

Returns Promise<LLMResult>

getNumTokens

Parameters

content: MessageContent

Returns Promise<number>

invoke

Parameters

input: BaseLanguageModelInput

Optional options: Partial<CallOptions>

Returns Promise<RunOutput>

predict

Parameters

text: string

Optional options: CallOptions | string[]

Optional callbacks: Callbacks

Returns Promise<string>

⚠️ Deprecated ⚠️

predictMessages

Parameters

messages: BaseMessage[]

Optional options: CallOptions | string[]

Optional callbacks: Callbacks

Returns Promise<BaseMessage>

Deprecated

serialize

Returns SerializedLLM

stream

Parameters

input: BaseLanguageModelInput

Optional options: Partial<CallOptions>

Returns Promise<IterableReadableStreamInterface<RunOutput>>

transform

Parameters

generator: AsyncGenerator<BaseLanguageModelInput, any, unknown>

options: Partial<CallOptions>

Returns AsyncGenerator<RunOutput, any, unknown>

Settings

Member Visibility

Theme

On This Page

`Optional` options: Partial<CallOptions> | Partial<CallOptions>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<CallOptions> | Partial<CallOptions>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<CallOptions> | Partial<CallOptions>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` options: CallOptions | string[]

`Optional` callbacks: Callbacks

`Optional` options: Partial<CallOptions>

`Optional` options: CallOptions | string[]

`Optional` callbacks: Callbacks

`Optional` options: CallOptions | string[]

`Optional` callbacks: Callbacks

`Optional` options: Partial<CallOptions>