View Source HyperLLM.Tool behaviour (hyper_llm v0.5.0)

Defines the behaviour that all workflow tool modules must implement.

Each tool module must implement the call/1 callback, which takes a keyword list of inputs and returns a tuple containing a result atom and output keyword list.

Summary

Callbacks

Executes the tool with the given input values.

Callbacks

call(input)

@callback call(input :: keyword()) :: {atom(), keyword()}

Executes the tool with the given input values.

Parameters

  • input - A keyword list containing the tool-specific input values

Returns

  • {result, output} - A tuple containing:
    • result - An atom indicating the result of the tool execution (e.g., :ok, :error, :high, :low)
    • output - A keyword list containing the tool's output values