Available Actions

add

Adds two numbers

add

Adds two numbers

copy_file

Copies a file from source to destination

create

Create a new task

decrement_action

Decrements a value by 1

delete

Delete a value from the state at a given path

delete

Delete a task

delete_file

Deletes a file or directory with optional recursive deletion

deregister_action

Deregisters an existing action module

divide

Divides one number by another

divide

Divides one number by another

do_work_action

Simulates the robot performing work tasks

enqueue_action

Enqueues another action based on params

eval

Evaluates a mathematical expression

generate_chat_response

Choose an option and explain why

generate_tool_response

Generate a response using LangChain to coordinate with tools/functions

get

Get a value from the state at a given path

get_boolean_response

Get a true/false answer to a question with explanation

get_chat_response

Get a natural language response from the AI assistant

github_issues_create Github API

Create a new issue on GitHub

github_issues_filter Github API

Filter repository issues on GitHub

github_issues_find Github API

Get a specific issue from GitHub

github_issues_list Github API

List all issues from a GitHub repository

github_issues_update Github API

Update an existing issue on GitHub

idle_action

Simulates the robot doing nothing

increment_action

Increments a value by 1

inspect_action

Inspects a value

instructor_chat_completion

Makes a raw chat completion call using Instructor with structured prompting

kill_process

Terminates a child process

langchain_chat_completion

Chat completion action using Langchain

list_directory

Lists directory contents with optional pattern matching

log_action

Logs a message with a specified level

make_directory

Creates a new directory, optionally creating parent directories

move_action

Moves the robot to a specified location

move_file

Moves a file from source to destination

multiply

Multiplies two numbers

multiply

Multiplies two numbers

noop_action

No operation, returns input unchanged

openai_ex_chat_completion

Chat completion using OpenAI Ex with support for tool calling

openai_ex_embeddings

Generate embeddings using OpenAI Ex with support for OpenRouter

openai_ex_image_generation

Generate images using OpenAI Ex with support for OpenRouter

openai_ex_response_retrieve

Retrieve an asynchronous response using OpenAI Ex

random_sleep_action

Introduces a random sleep within a specified range

read_file

Reads content from a file

recharge

Simulates recharging the robot's battery

register_action

Registers a new action module

report_action

Simulates the robot reporting its status

set

Set a value in the state at a given path

sleep_action

Sleeps for a specified duration

spawn_process

Spawns a child process under the agent's supervisor

Generic actions for state management

subtract

Subtracts one number from another

subtract

Subtracts one number from another

tasks

Actions for managing a list of tasks

today

Returns today's date in specified format

todo_action

A placeholder for a todo item

toggle

Toggle the completion status of a task

update

Update a value in the state at a given path with a new value

update

Update an existing task

weather Weather

Get the weather for a given location via the OpenWeatherMap API

write_file

Writes content to a file, optionally creating parent directories

openai_ex_chat_completion

Chat completion using OpenAI Ex with support for tool calling

Jido.AI.Actions.OpenaiEx

Parameters

model

Required

{:custom, Jido.AI.Model, :validate_model_opts, []}

The AI model to use (e.g., {:openai, [model: "gpt-4"]} or %Jido.AI.Model{})

Validation: type: {:custom, Jido.AI.Model, :validate_model_opts, []}

messages

{:list, {:map, [role: :atom, content: :string]}}

List of message maps with :role and :content (required if prompt is not provided)

Validation: type: {:list, {:map, [role: :atom, content: :string]}}

prompt

{:custom, Jido.AI.Prompt, :validate_prompt_opts, []}

The prompt to use for the response (required if messages is not provided)

Validation: type: {:custom, Jido.AI.Prompt, :validate_prompt_opts, []}

tools

{:list, :atom}

List of Jido.Action modules for function calling

Validation: type: {:list, :atom}

tool_choice

:map

Tool choice configuration

Validation: type: :map

temperature

float

Temperature for response randomness (0-2)

Default: 0.7

Validation: type: float

max_tokens

integer

Maximum tokens in response

Validation: type: integer

top_p

float

Top p sampling parameter (0-1)

Validation: type: float

frequency_penalty

float

Frequency penalty (-2.0 to 2.0)

Validation: type: float

presence_penalty

float

Presence penalty (-2.0 to 2.0)

Validation: type: float

stop

{:list, :string}

Stop sequences

Validation: type: {:list, :string}

response_format

one of [:text, :json]

Response format (text or json)

Default: :text

Validation: type: one of [:text, :json], must be one of: :text, :json

seed

integer

Random number seed for deterministic responses

Validation: type: integer

stream

boolean

Whether to stream the response

Validation: type: boolean