Jido.AI.Actions.Planning.Prioritize (Jido AI v2.2.0)

Copy Markdown View Source

A Jido.Action for prioritizing tasks based on given criteria.

This action uses ReqLLM with a specialized system prompt for task prioritization, analyzing and ordering tasks according to their importance, urgency, and dependencies.

Parameters

  • model (optional) - Model alias (e.g., :planning) or direct spec
  • tasks (required) - List of tasks to prioritize
  • criteria (optional) - Prioritization criteria (e.g., "impact", "urgency", "effort")
  • context (optional) - Additional context about the project
  • max_tokens (optional) - Maximum tokens to generate (default: 4096)
  • temperature (optional) - Sampling temperature (default: 0.5)
  • timeout (optional) - Request timeout in milliseconds

Examples

# Basic prioritization
{:ok, result} = Jido.Exec.run(Jido.AI.Actions.Planning.Prioritize, %{
  tasks: [
    "Fix critical bug",
    "Update documentation",
    "Refactor authentication",
    "Add new feature"
  ]
})

# With specific criteria
{:ok, result} = Jido.Exec.run(Jido.AI.Actions.Planning.Prioritize, %{
  tasks: ["Task A", "Task B", "Task C"],
  criteria: "Business impact, development effort, and dependencies"
})

# With context
{:ok, result} = Jido.Exec.run(Jido.AI.Actions.Planning.Prioritize, %{
  tasks: ["Design database", "Build API", "Create UI"],
  criteria: "Dependencies and value delivery",
  context: "Early-stage startup, need MVP quickly"
})

Summary

Functions

__action_metadata__()

Returns the Action metadata. Alias for to_json/0.

category()

Returns the category of the Action.

description()

Returns the description of the Action.

name()

Returns the name of the Action.

on_after_run(result)

Lifecycle hook called after Action execution.

on_after_validate_output(output)

Lifecycle hook called after output validation.

on_after_validate_params(params)

Lifecycle hook called after parameter validation.

on_before_validate_output(output)

Lifecycle hook called before output validation.

on_before_validate_params(params)

Lifecycle hook called before parameter validation.

on_error(failed_params, error, context, opts)

Lifecycle hook called when an error occurs.

output_schema()

Returns the output schema of the Action.

run(params, context)

Executes the prioritize action.

schema()

Returns the input schema of the Action.

tags()

Returns the tags associated with the Action.

to_json()

Returns the Action metadata as a JSON-serializable map.

to_tool()

Converts the Action to an LLM-compatible tool format.

validate_output(output)

Validates the output result for the Action.

validate_params(params)

Validates the input parameters for the Action.

vsn()

Returns the version of the Action.

Functions

__action_metadata__()

Returns the Action metadata. Alias for to_json/0.

category()

Returns the category of the Action.

description()

Returns the description of the Action.

name()

Returns the name of the Action.

on_after_run(result)

Lifecycle hook called after Action execution.

on_after_validate_output(output)

Lifecycle hook called after output validation.

on_after_validate_params(params)

Lifecycle hook called after parameter validation.

on_before_validate_output(output)

Lifecycle hook called before output validation.

on_before_validate_params(params)

Lifecycle hook called before parameter validation.

on_error(failed_params, error, context, opts)

Lifecycle hook called when an error occurs.

output_schema()

Returns the output schema of the Action.

run(params, context)

Executes the prioritize action.

Returns

  • {:ok, result} - Successful response with prioritization, ordered_tasks, scores, and usage keys
  • {:error, reason} - Error from ReqLLM or validation

Result Format

%{
  prioritization: "The full prioritization analysis",
  ordered_tasks: ["Task 1", "Task 2", ...],
  scores: %{"Task 1" => 9, "Task 2" => 7, ...},
  model: "anthropic:claude-sonnet-4-20250514",
  usage: %{...}
}

schema()

Returns the input schema of the Action.

tags()

Returns the tags associated with the Action.

to_json()

Returns the Action metadata as a JSON-serializable map.

to_tool()

Converts the Action to an LLM-compatible tool format.

validate_output(output)

@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"}

validate_params(params)

@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"}

vsn()

Returns the version of the Action.