A Jido.Action for simple text completion without system prompts.
This action provides straightforward text completion using ReqLLM.
Unlike Chat, it does not support system prompts - it simply completes
the given prompt text.
Parameters
model(optional) - Model alias (e.g.,:fast,:capable) or direct specprompt(required) - The text prompt to completemax_tokens(optional) - Maximum tokens to generate (default:1024)temperature(optional) - Sampling temperature 0.0-2.0 (default:0.7)timeout(optional) - Request timeout in milliseconds
Examples
# Basic completion
{:ok, result} = Jido.Exec.run(Jido.AI.Actions.LLM.Complete, %{
prompt: "The capital of France is"
})
# With custom settings
{:ok, result} = Jido.Exec.run(Jido.AI.Actions.LLM.Complete, %{
model: :capable,
prompt: "Elixir is a functional programming language",
max_tokens: 500,
temperature: 0.5
})Summary
Functions
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.
Lifecycle hook called after Action execution.
Lifecycle hook called after output validation.
Lifecycle hook called after parameter validation.
Lifecycle hook called before output validation.
Lifecycle hook called before parameter validation.
Lifecycle hook called when an error occurs.
Returns the output schema of the Action.
Executes the completion 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.
Validates the output result for the Action.
Validates the input parameters for the Action.
Returns the version of the Action.
Functions
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.
Lifecycle hook called after Action execution.
Lifecycle hook called after output validation.
Lifecycle hook called after parameter validation.
Lifecycle hook called before output validation.
Lifecycle hook called before parameter validation.
Lifecycle hook called when an error occurs.
Returns the output schema of the Action.
Executes the completion action.
Returns
{:ok, result}- Successful response withtext,model, andusagekeys{:error, reason}- Error from ReqLLM or validation
Result Format
%{
text: "The completed text",
model: "anthropic:claude-haiku-4-5",
usage: %{
input_tokens: 10,
output_tokens: 25,
total_tokens: 35
}
}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.
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"}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.