Enum Outcome 

pub enum Outcome {
    Value(Value),
    Chat(Box<Chat>),
    Agent(Box<Chat>),
    Message(Box<Message>),
    ToolCall(ToolCall),
    Answer(Answer),
    Judgment(Box<Judgment>),
    Embedding(Box<Embedding>),
    Transcription(Box<Transcription>),
    Ocr(Box<Ocr>),
    Rerank(Box<Rerank>),
    Moderation(Box<Moderation>),
    ModerationResult(ModerationResult),
    Tokenization(Tokenization),
    ServerToolCall(ServerToolCall),
    Image(Box<Image>),
    Video(Box<Video>),
    Speech(Box<Speech>),
    Attachment(Attachment),
    List(Vec<Outcome>),
    Map(Vec<(String, Outcome)>),
    Other(Box<dyn Any + Send + Sync>),
}

What perform returned. Ruby returns any object; the port names the kinds it can evaluate. Outcome::Agent is a chat an agent built (Agent.new.chat), kept apart only so evidence can tell they were an agent’s, which Ruby normalizes to the same data as the chat.

Variants

Value(Value)

JSON data: strings, numbers, booleans, null, arrays, objects.

Chat(Box<Chat>)

Agent(Box<Chat>)

Message(Box<Message>)

ToolCall(ToolCall)

Answer(Answer)

Judgment(Box<Judgment>)

Embedding(Box<Embedding>)

Transcription(Box<Transcription>)

Ocr(Box<Ocr>)

Rerank(Box<Rerank>)

Moderation(Box<Moderation>)

ModerationResult(ModerationResult)

Tokenization(Tokenization)

ServerToolCall(ServerToolCall)

Image(Box<Image>)

Video(Box<Video>)

Speech(Box<Speech>)

Attachment(Attachment)

List(Vec<Outcome>)

An array of outcomes ([agent, { second: chat }]).

Map(Vec<(String, Outcome)>)

An object whose values are outcomes.

Other(Box<dyn Any + Send + Sync>)

Any other type; it needs an adapter.

Implementations

impl Outcome

pub fn other<T: Any + Send + Sync>(value: T) -> Outcome

Any other type, converted by an adapter declared for it.

pub fn chat(&self) -> Option<&Chat>

The returned chat (or the agent’s chat), when perform returned one.

pub fn value(&self) -> Option<&Value>

The returned JSON value, when perform returned plain data.

pub fn is_agent(&self) -> bool

result.is_a?(RubyLLM::Agent).

Trait Implementations

impl Debug for Outcome

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for Outcome

fn from(v: &str) -> Outcome

Converts to this type from the input type.

impl From<Answer> for Outcome

fn from(v: Answer) -> Outcome

Converts to this type from the input type.

impl From<Attachment> for Outcome

fn from(v: Attachment) -> Outcome

Converts to this type from the input type.

impl From<Chat> for Outcome

fn from(v: Chat) -> Outcome

Converts to this type from the input type.

impl From<Embedding> for Outcome

fn from(v: Embedding) -> Outcome

Converts to this type from the input type.

impl From<Image> for Outcome

fn from(v: Image) -> Outcome

Converts to this type from the input type.

impl From<Judgment> for Outcome

fn from(v: Judgment) -> Outcome

Converts to this type from the input type.

impl From<Message> for Outcome

fn from(v: Message) -> Outcome

Converts to this type from the input type.

impl From<Moderation> for Outcome

fn from(v: Moderation) -> Outcome

Converts to this type from the input type.

impl From<ModerationResult> for Outcome

fn from(v: ModerationResult) -> Outcome

Converts to this type from the input type.

impl From<Ocr> for Outcome

fn from(v: Ocr) -> Outcome

Converts to this type from the input type.

impl From<Rerank> for Outcome

fn from(v: Rerank) -> Outcome

Converts to this type from the input type.

impl From<Speech> for Outcome

fn from(v: Speech) -> Outcome

Converts to this type from the input type.

impl From<String> for Outcome

fn from(v: String) -> Outcome

Converts to this type from the input type.

impl From<Tokenization> for Outcome

fn from(v: Tokenization) -> Outcome

Converts to this type from the input type.

impl From<ToolCall> for Outcome

fn from(v: ToolCall) -> Outcome

Converts to this type from the input type.

impl From<Transcription> for Outcome

fn from(v: Transcription) -> Outcome

Converts to this type from the input type.

impl From<Value> for Outcome

fn from(v: Value) -> Outcome

Converts to this type from the input type.

impl From<Vec<Outcome>> for Outcome

fn from(v: Vec<Outcome>) -> Outcome

Converts to this type from the input type.

impl From<Video> for Outcome

fn from(v: Video) -> Outcome

Converts to this type from the input type.