Class: Langfuse::ItemResult

Inherits:

Object

• Object
• Langfuse::ItemResult

Defined in:

lib/langfuse/item_result.rb

Overview

Result of processing a single item in an experiment run

Captures the task output, associated trace, evaluations, and any errors for one dataset item or data hash processed by ExperimentRunner.

Examples:

Successful result

result.success?     # => true
result.output       # => "Hello Alice!"
result.evaluations  # => [#<Evaluation name="relevance" value=0.9>]

Failed result

result.failed?        # => true
result.error.message  # => "API timeout"

Instance Attribute Summary

• #error ⇒ DatasetItemClient, ... readonly
• #evaluations ⇒ DatasetItemClient, ... readonly
• #item ⇒ DatasetItemClient, ... readonly
• #observation_id ⇒ DatasetItemClient, ... readonly
• #output ⇒ DatasetItemClient, ... readonly
• #trace_id ⇒ DatasetItemClient, ... readonly

Instance Method Summary

• #failed? ⇒ Boolean

  True if the task raised an error.

• #initialize(item:, output: nil, trace_id: nil, observation_id: nil, evaluations: [], error: nil) ⇒ ItemResult constructor

  A new instance of ItemResult.

• #success? ⇒ Boolean

  True if the task completed without error.

Constructor Details

#initialize(item:, output: nil, trace_id: nil, observation_id: nil, evaluations: [], error: nil) ⇒ ItemResult

Returns a new instance of ItemResult.

Parameters:

• item (DatasetItemClient, ExperimentItem) —

  the input item

• output (Object, nil) (defaults to: nil) —

  task output

• trace_id (String, nil) (defaults to: nil) —

  trace ID from the observed execution

• observation_id (String, nil) (defaults to: nil) —

  observation (span) ID from the observed execution

• evaluations (Array<Evaluation>) (defaults to: []) —

  item-level evaluation results

• error (StandardError, nil) (defaults to: nil) —

  error if the task failed

# File 'lib/langfuse/item_result.rb', line 32

def initialize(item:, output: nil, trace_id: nil, observation_id: nil, evaluations: [], error: nil)
  @item = item
  @output = output
  @trace_id = trace_id
  @observation_id = observation_id
  @evaluations = evaluations
  @error = error
end

Instance Attribute Details

#error ⇒ DatasetItemClient, ... (readonly)

Returns:

• (DatasetItemClient, ExperimentItem) —

  the original input item

• (Object, nil) —

  task output, nil on failure

• (String, nil) —

  trace ID for the task execution

• (String, nil) —

  observation (span) ID for the task execution

• (Array<Evaluation>) —

  item-level evaluation results

• (StandardError, nil) —

  error raised during task execution

# File 'lib/langfuse/item_result.rb', line 24

def error
  @error
end

#evaluations ⇒ DatasetItemClient, ... (readonly)

Returns:

• (DatasetItemClient, ExperimentItem) —

  the original input item

• (Object, nil) —

  task output, nil on failure

• (String, nil) —

  trace ID for the task execution

• (String, nil) —

  observation (span) ID for the task execution

• (Array<Evaluation>) —

  item-level evaluation results

• (StandardError, nil) —

  error raised during task execution

# File 'lib/langfuse/item_result.rb', line 24

def evaluations
  @evaluations
end

#item ⇒ DatasetItemClient, ... (readonly)

Returns:

• (DatasetItemClient, ExperimentItem) —

  the original input item

• (Object, nil) —

  task output, nil on failure

• (String, nil) —

  trace ID for the task execution

• (String, nil) —

  observation (span) ID for the task execution

• (Array<Evaluation>) —

  item-level evaluation results

• (StandardError, nil) —

  error raised during task execution

# File 'lib/langfuse/item_result.rb', line 24

def item
  @item
end

#observation_id ⇒ DatasetItemClient, ... (readonly)

Returns:

• (DatasetItemClient, ExperimentItem) —

  the original input item

• (Object, nil) —

  task output, nil on failure

• (String, nil) —

  trace ID for the task execution

• (String, nil) —

  observation (span) ID for the task execution

• (Array<Evaluation>) —

  item-level evaluation results

• (StandardError, nil) —

  error raised during task execution

# File 'lib/langfuse/item_result.rb', line 24

def observation_id
  @observation_id
end

#output ⇒ DatasetItemClient, ... (readonly)

Returns:

• (DatasetItemClient, ExperimentItem) —

  the original input item

• (Object, nil) —

  task output, nil on failure

• (String, nil) —

  trace ID for the task execution

• (String, nil) —

  observation (span) ID for the task execution

• (Array<Evaluation>) —

  item-level evaluation results

• (StandardError, nil) —

  error raised during task execution

# File 'lib/langfuse/item_result.rb', line 24

def output
  @output
end

#trace_id ⇒ DatasetItemClient, ... (readonly)

Returns:

• (DatasetItemClient, ExperimentItem) —

  the original input item

• (Object, nil) —

  task output, nil on failure

• (String, nil) —

  trace ID for the task execution

• (String, nil) —

  observation (span) ID for the task execution

• (Array<Evaluation>) —

  item-level evaluation results

• (StandardError, nil) —

  error raised during task execution

# File 'lib/langfuse/item_result.rb', line 24

def trace_id
  @trace_id
end

Instance Method Details

#failed? ⇒ Boolean

Returns true if the task raised an error.

Returns:

• (Boolean) —

  true if the task raised an error

# File 'lib/langfuse/item_result.rb', line 45

def failed? = !success?

#success? ⇒ Boolean

Returns true if the task completed without error.

Returns:

• (Boolean) —

  true if the task completed without error

# File 'lib/langfuse/item_result.rb', line 42

def success? = error.nil?