BaseChatModel<Options extends ChatModelOptions> class abstract

Chat models base class. It should take in chat messages and return a chat message.

Inheritance
Implementers

Constructors

BaseChatModel({required Options defaultOptions})
Chat models base class. It should take in chat messages and return a chat message.
const

Properties

defaultOptions → Options
The default options to use when invoking the Runnable.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
modelType → String
Return type of language model.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batch(List<PromptValue> inputs, {List<Options>? options}) → Future<List<ChatResult>>
Batches the invocation of the Runnable on the given inputs.
inherited
bind(Options options) → RunnableBinding<PromptValue, Options, ChatResult>
Binds the Runnable to the given options.
inherited
call(List<ChatMessage> messages, {Options? options}) → Future<AIChatMessage>
Runs the chat model on the given messages and returns a chat message.
close() → void
Cleans up any resources associated with it the Runnable.
inherited
countTokens(PromptValue promptValue, {Options? options}) → Future<int>
Returns the number of tokens resulting from tokenize the given prompt.
inherited
getCompatibleOptions(RunnableOptions? options) → Options?
Returns the given options if they are compatible with the Runnable, otherwise returns null.
inherited
invoke(PromptValue input, {Options? options}) → Future<ChatResult>
Invokes the Runnable on the given input.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe<NewRunOutput extends Object?, NewCallOptions extends RunnableOptions>(Runnable<ChatResult, NewCallOptions, NewRunOutput> next) → RunnableSequence<PromptValue, NewRunOutput>
Pipes the output of this Runnable into another Runnable using a RunnableSequence.
inherited
stream(PromptValue input, {Options? options}) → Stream<ChatResult>
Streams the output of invoking the Runnable on the given input.
inherited
streamFromInputStream(Stream<PromptValue> inputStream, {Options? options}) → Stream<ChatResult>
Streams the output of invoking the Runnable on the given inputStream.
override
tokenize(PromptValue promptValue, {Options? options}) → Future<List<int>>
Tokenizes the given prompt using the encoding used by the language model.
inherited
toString() → String
A string representation of this object.
inherited
withFallbacks(List<Runnable<PromptValue, RunnableOptions, ChatResult>> fallbacks) → RunnableWithFallback<PromptValue, ChatResult>
Adds fallback runnables to be invoked if the primary runnable fails.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited