Jido.AI.Actions.OpenaiEx.ResponseRetrieve (Jido AI v0.5.2)

View Source

Summary

Functions

category()

description()

name()

on_after_run(result)

Callback implementation for Jido.Action.on_after_run/1.

on_after_validate_params(params)

Callback implementation for Jido.Action.on_after_validate_params/1.

on_before_validate_params(params)

Callback implementation for Jido.Action.on_before_validate_params/1.

on_error(failed_params, error, context, opts)

Callback implementation for Jido.Action.on_error/4.

run(params, context)

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

Retrieves an asynchronous response using OpenAI Responses API.

Parameters

  • params: Map containing:
    • model: Either a %Jido.AI.Model{} struct or a tuple of {provider, opts}
    • response_id: The ID of the response to retrieve
  • context: The action context containing state and other information

Returns

  • {:ok, %{ id: response_id, model: model_name, content: response_content, tool_results: [optional_tool_results], status: "completed" | "processing" | "error", created_at: timestamp }} on success
  • on failure

schema()

tags()

to_json()

to_tool()

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()