Jido.AI.Signal.ToolResult (Jido AI v2.3.0)

Signal for tool execution completion.

Summary

Returns this signal definition as metadata.

Returns the configured data content type, if present.

dataschema()

Returns the configured data schema URI, if present.

default_source()

Returns the default CloudEvents source for this signal module.

Returns the extension policy for this signal module.

Builds a validated Jido.Signal from signal data.

Builds a validated Jido.Signal or raises when validation fails.

schema()

Returns the field schema used to validate signal data.

to_json()

Returns this signal definition as metadata.

type()

Returns the CloudEvents type emitted by this signal module.

Validates data against this signal module's schema.

@spec __signal_metadata__() :: map()

Returns this signal definition as metadata.

@spec datacontenttype() :: String.t() | nil

Returns the configured data content type, if present.

@spec dataschema() :: String.t() | nil

Returns the configured data schema URI, if present.

@spec default_source() :: String.t() | nil

Returns the default CloudEvents source for this signal module.

@spec extension_policy() :: map()

Returns the extension policy for this signal module.

@spec new(
  map(),
  keyword()
) :: {:ok, Jido.Signal.t()} | {:error, term()}

Builds a validated Jido.Signal from signal data.

@spec new!(
  map(),
  keyword()
) :: Jido.Signal.t() | no_return()

Builds a validated Jido.Signal or raises when validation fails.

@spec schema() :: keyword(keyword())

Returns the field schema used to validate signal data.

@spec to_json() :: map()

Returns this signal definition as metadata.

@spec type() :: String.t()

Returns the CloudEvents type emitted by this signal module.

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

Validates data against this signal module's schema.