Returns the Action metadata. Alias for to_json/0.

Returns the category of the Action.

Returns the description of the Action.

Returns the name of the Action.

@spec on_after_run({:ok, map()} | {:error, any()}) :: {:ok, map()} | {:error, any()}

Lifecycle hook called after Action execution.

@spec on_after_validate_output(map()) :: {:ok, map()} | {:error, any()}

Lifecycle hook called after output validation.

@spec on_after_validate_params(map()) :: {:ok, map()} | {:error, any()}

Lifecycle hook called after parameter validation.

@spec on_before_validate_output(map()) :: {:ok, map()} | {:error, any()}

Lifecycle hook called before output validation.

@spec on_before_validate_params(map()) :: {:ok, map()} | {:error, any()}

Lifecycle hook called before parameter validation.

@spec on_error(map(), any(), map(), keyword()) :: {:ok, map()} | {:error, any()}

Lifecycle hook called when an error occurs.

Returns the output schema of the Action.

@spec run(map(), map()) :: {:ok, map()} | {:ok, map(), any()} | {:error, any()}

Executes the Action with the given parameters and context.

The run/2 function must be implemented in the module using Jido.Action.

Returns the input schema of the Action.

Returns the tags associated with the Action.

Returns the Action metadata as a JSON-serializable map.

Converts the Action to an LLM-compatible tool format.

@spec validate_output(map()) :: {:ok, map()} | {:error, String.t()}

Validates the output result for the Action.

Examples

iex> defmodule ExampleAction do
...>   use Jido.Action,
...>     name: "example_action",
...>     output_schema: [
...>       result: [type: :string, required: true]
...>     ]
...> end
...> ExampleAction.validate_output(%{result: "test", extra: "ignored"})
{:ok, %{result: "test", extra: "ignored"}}

iex> ExampleAction.validate_output(%{extra: "ignored"})
{:error, "Invalid output for Action: Required key :result not found"}

@spec validate_params(map()) :: {:ok, map()} | {:error, String.t()}

Validates the input parameters for the Action.

Examples

iex> defmodule ExampleAction do
...>   use Jido.Action,
...>     name: "example_action",
...>     schema: [
...>       input: [type: :string, required: true]
...>     ]
...> end
...> ExampleAction.validate_params(%{input: "test"})
{:ok, %{input: "test"}}

iex> ExampleAction.validate_params(%{})
{:error, "Invalid parameters for Action: Required key :input not found"}

Returns the version of the Action.