View Source LangChain.ChatModels.ChatModel behaviour (LangChain v0.3.0-rc.0)

Summary

Types

call_response()
t()
tool()
tools()

Callbacks

call(t, arg2, list)
restore_from_map(map)
serialize_config(t)

Functions

add_callback(model, callback_map)

Add a LangChain.ChatModels.LLMCallbacks callback map to the ChatModel if it includes the :callback key.

restore_from_map(data)

Restore a ChatModel from a serialized config map.

serialize_config(model)

Create a serializable map from a ChatModel's current configuration that can later be restored.

Types

Link to this type

call_response()

View Source 
@type call_response() ::
  {:ok,
   LangChain.Message.t()
   | [LangChain.Message.t()]
   | [LangChain.MessageDelta.t()]}
  | {:error, String.t()}
Link to this type

t()

View Source 
@type t() :: Ecto.Schema.t()
Link to this type

tool()

View Source 
@type tool() :: LangChain.Function.t()
Link to this type

tools()

View Source 
@type tools() :: [tool()]

Callbacks

Link to this callback

call(t, arg2, list)

View Source 
@callback call(
  t(),
  String.t() | [LangChain.Message.t()],
  [LangChain.Function.t()]
) :: call_response()
Link to this callback

restore_from_map(map)

View Source 
@callback restore_from_map(%{required(String.t()) => any()}) ::
  {:ok, struct()} | {:error, String.t()}
Link to this callback

serialize_config(t)

View Source 
@callback serialize_config(t()) :: %{required(String.t()) => any()}

Functions

Link to this function

add_callback(model, callback_map)

View Source 
@spec add_callback(%{optional(:callbacks) => nil | map()}, map()) :: map() | struct()

Add a LangChain.ChatModels.LLMCallbacks callback map to the ChatModel if it includes the :callback key.

Link to this function

restore_from_map(data)

View Source 
@spec restore_from_map(nil | %{required(String.t()) => any()}) ::
  {:ok, struct()} | {:error, String.t()}

Restore a ChatModel from a serialized config map.

Link to this function

serialize_config(model)

View Source

Create a serializable map from a ChatModel's current configuration that can later be restored.