Class: Langfuse::Span

Inherits:
Object
  • Object
show all
Extended by:
SpanWrappers
Includes:
PartialUpdates
Defined in:
lib/langfuse/span.rb

Constant Summary

Constants included from SpanWrappers

Langfuse::SpanWrappers::TYPES

Constants included from PartialUpdates

PartialUpdates::UPDATE_IDENTITY_FIELDS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SpanWrappers

define_span_wrappers

Constructor Details

#initialize(client:, trace_id:, id: nil, name: nil, start_time: nil, end_time: nil, input: nil, output: nil, metadata: nil, level: nil, status_message: nil, parent_observation_id: nil, version: nil, as_type: nil, **kwargs) ⇒ Span

Returns a new instance of Span.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/langfuse/span.rb', line 11

def initialize(client:, trace_id:, id: nil, name: nil, start_time: nil, end_time: nil,
               input: nil, output: nil, metadata: nil, level: nil, status_message: nil,
               parent_observation_id: nil, version: nil, as_type: nil, **kwargs)
  @client = client
  @id = id || Utils.generate_id
  @trace_id = trace_id
  @name = name
  @start_time = start_time
  @end_time = end_time
  @input = input
  @output = output
  @metadata = metadata || {}
  @level = level
  @status_message = status_message
  @parent_observation_id = parent_observation_id
  @version = version
  @as_type = validate_as_type(as_type)
  @kwargs = kwargs

  # Create the span
  create_span
end

Instance Attribute Details

#as_type ⇒ Object (readonly)

Returns the value of attribute as_type.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def as_type
  @as_type
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def client
  @client
end

#end_time ⇒ Object (readonly)

Returns the value of attribute end_time.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def end_time
  @end_time
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def id
  @id
end

#input ⇒ Object (readonly)

Returns the value of attribute input.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def input
  @input
end

#level ⇒ Object (readonly)

Returns the value of attribute level.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def level
  @level
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def name
  @name
end

#output ⇒ Object (readonly)

Returns the value of attribute output.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def output
  @output
end

#parent_observation_id ⇒ Object (readonly)

Returns the value of attribute parent_observation_id.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def parent_observation_id
  @parent_observation_id
end

#start_time ⇒ Object (readonly)

Returns the value of attribute start_time.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def start_time
  @start_time
end

#status_message ⇒ Object (readonly)

Returns the value of attribute status_message.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def status_message
  @status_message
end

#trace_id ⇒ Object (readonly)

Returns the value of attribute trace_id.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def trace_id
  @trace_id
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



7
8
9
 
# File 'lib/langfuse/span.rb', line 7

def version
  @version
end

Instance Method Details

#embedding(name: nil, start_time: nil, end_time: nil, input: nil, output: nil, model: nil, usage: nil, metadata: nil, level: nil, status_message: nil, version: nil, **kwargs) ⇒ Object

Create a child embedding observation



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/langfuse/span.rb', line 139

def embedding(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
              model: nil, usage: nil, metadata: nil, level: nil, status_message: nil,
              version: nil, **kwargs)
  merged_metadata = (metadata || {}).merge(
    { model: model, usage: usage }.compact
  )
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: merged_metadata.empty? ? nil : merged_metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::EMBEDDING,
    **kwargs
  )
end

#end(output: nil, end_time: nil, **kwargs) ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'lib/langfuse/span.rb', line 56

def end(output: nil, end_time: nil, **kwargs)
  @end_time = end_time || Utils.current_timestamp
  @output = output unless output.nil?
  @kwargs.merge!(kwargs)

  track_changes({ end_time: @end_time, output: output }, kwargs.keys)
  update_span
  self
end

#event(name:, start_time: nil, input: nil, output: nil, metadata: nil, level: nil, status_message: nil, version: nil, **kwargs) ⇒ Object

Create a child event



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/langfuse/span.rb', line 115

def event(name:, start_time: nil, input: nil, output: nil, metadata: nil,
          level: nil, status_message: nil, version: nil, **kwargs)
  @client.event(
    trace_id: @trace_id,
    name: name,
    start_time: start_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    parent_observation_id: @id,
    version: version,
    **kwargs
  )
end

#generation(name: nil, start_time: nil, end_time: nil, completion_start_time: nil, model: nil, model_parameters: nil, input: nil, output: nil, usage: nil, usage_details: nil, cost_details: nil, prompt: nil, metadata: nil, level: nil, status_message: nil, version: nil, **kwargs) ⇒ Object

Create a child generation



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/langfuse/span.rb', line 87

def generation(name: nil, start_time: nil, end_time: nil, completion_start_time: nil,
               model: nil, model_parameters: nil, input: nil, output: nil, usage: nil,
               usage_details: nil, cost_details: nil, prompt: nil,
               metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  @client.generation(
    trace_id: @trace_id,
    name: name,
    start_time: start_time,
    end_time: end_time,
    completion_start_time: completion_start_time,
    model: model,
    model_parameters: model_parameters,
    input: input,
    output: output,
    usage: usage,
    usage_details: usage_details,
    cost_details: cost_details,
    prompt: prompt,
    metadata: metadata,
    level: level,
    status_message: status_message,
    parent_observation_id: @id,
    version: version,
    **kwargs
  )
end

#get_url ⇒ Object 



172
173
174
 
# File 'lib/langfuse/span.rb', line 172

def get_url
  "#{@client.host}/trace/#{@trace_id}?observation=#{@id}"
end

#score(name:, value:, data_type: nil, comment: nil, **kwargs) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/langfuse/span.rb', line 160

def score(name:, value:, data_type: nil, comment: nil, **kwargs)
  @client.score(
    trace_id: @trace_id,
    observation_id: @id,
    name: name,
    value: value,
    data_type: data_type,
    comment: comment,
    **kwargs
  )
end

#span(name: nil, start_time: nil, end_time: nil, input: nil, output: nil, metadata: nil, level: nil, status_message: nil, version: nil, as_type: nil, **kwargs) ⇒ Object

Create a child span



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/langfuse/span.rb', line 67

def span(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
         metadata: nil, level: nil, status_message: nil, version: nil, as_type: nil, **kwargs)
  @client.span(
    trace_id: @trace_id,
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    parent_observation_id: @id,
    version: version,
    as_type: as_type,
    **kwargs
  )
end

#to_dict ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/langfuse/span.rb', line 176

def to_dict
  data = {
    id: @id,
    trace_id: @trace_id,
    name: @name,
    start_time: @start_time,
    end_time: @end_time,
    input: @input,
    output: @output,
    metadata: @metadata,
    level: @level,
    status_message: @status_message,
    parent_observation_id: @parent_observation_id,
    version: @version
  }
  data[:type] = @as_type if @as_type
  data.merge(@kwargs).compact
end

#update(name: nil, end_time: nil, input: nil, output: nil, metadata: nil, level: nil, status_message: nil, version: nil, **kwargs) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/langfuse/span.rb', line 34

def update(name: nil, end_time: nil, input: nil, output: nil, metadata: nil,
           level: nil, status_message: nil, version: nil, **kwargs)
  @name = name unless name.nil?
  @end_time = end_time unless end_time.nil?
  @input = input unless input.nil?
  @output = output unless output.nil?
  @metadata.merge!(metadata) if metadata
  @level = level unless level.nil?
  @status_message = status_message unless status_message.nil?
  @version = version unless version.nil?
  @kwargs.merge!(kwargs)

  track_changes(
    { name: name, end_time: end_time, input: input, output: output,
      metadata: metadata, level: level, status_message: status_message,
      version: version },
    kwargs.keys
  )
  update_span
  self
end