View Source Nexlm.Behaviour behaviour (Nexlm v0.1.15)

Summary

Types

message()
tool_call()
tool_definition()
tool_result()

Callbacks

call(atom, map)
format_request(atom, list)
init(t)
parse_response(map)
validate_messages(list)

Types

Link to this type

message()

View Source 
@type message() :: %{role: String.t(), content: String.t() | [map()]}
Link to this type

tool_call()

View Source 
@type tool_call() :: %{id: String.t(), name: String.t(), arguments: map()}
Link to this type

tool_definition()

View Source 
@type tool_definition() :: %{
  name: String.t(),
  description: String.t(),
  parameters: %{type: String.t(), properties: map(), required: [String.t()]}
}
Link to this type

tool_result()

View Source 
@type tool_result() :: %{id: String.t(), result: any()}

Callbacks

Link to this callback

call(atom, map)

View Source 
@callback call(Nexlm.Config, map()) :: {:ok, map()} | {:error, Nexlm.Error.t()}
Link to this callback

format_request(atom, list)

View Source 
@callback format_request(Nexlm.Config, [message()]) ::
  {:ok, map()} | {:error, Nexlm.Error.t()}
Link to this callback

init(t)

View Source 
@callback init(Keyword.t()) :: {:ok, Nexlm.Config} | {:error, Nexlm.Error.t()}
Link to this callback

parse_response(map)

View Source 
@callback parse_response(map()) :: {:ok, message()} | {:error, Nexlm.Error.t()}
Link to this callback

validate_messages(list)

View Source 
@callback validate_messages([message()]) :: :ok | {:error, Nexlm.Error.t()}