Class: Langfuse::Span

Inherits:
Object
  • Object
show all
Defined in:
lib/langfuse/span.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/langfuse/span.rb', line 7

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.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def as_type
  @as_type
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def client
  @client
end

#end_time ⇒ Object (readonly)

Returns the value of attribute end_time.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def end_time
  @end_time
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def id
  @id
end

#input ⇒ Object (readonly)

Returns the value of attribute input.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def input
  @input
end

#level ⇒ Object (readonly)

Returns the value of attribute level.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def level
  @level
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def name
  @name
end

#output ⇒ Object (readonly)

Returns the value of attribute output.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def output
  @output
end

#parent_observation_id ⇒ Object (readonly)

Returns the value of attribute parent_observation_id.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def parent_observation_id
  @parent_observation_id
end

#start_time ⇒ Object (readonly)

Returns the value of attribute start_time.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def start_time
  @start_time
end

#status_message ⇒ Object (readonly)

Returns the value of attribute status_message.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def status_message
  @status_message
end

#trace_id ⇒ Object (readonly)

Returns the value of attribute trace_id.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def trace_id
  @trace_id
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



3
4
5
 
# File 'lib/langfuse/span.rb', line 3

def version
  @version
end

Instance Method Details

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

Create a child agent observation



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/langfuse/span.rb', line 120

def agent(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
          metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::AGENT,
    **kwargs
  )
end

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

Create a child chain observation



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

def chain(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
          metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::CHAIN,
    **kwargs
  )
end

#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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/langfuse/span.rb', line 192

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 



46
47
48
49
50
51
52
53
 
# File 'lib/langfuse/span.rb', line 46

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

  update_span
  self
end

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

Create a child evaluator observation



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/langfuse/span.rb', line 214

def evaluator(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
              metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::EVALUATOR,
    **kwargs
  )
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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/langfuse/span.rb', line 100

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, metadata: nil, level: nil, status_message: nil, version: nil, **kwargs) ⇒ Object

Create a child generation



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/langfuse/span.rb', line 76

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,
               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,
    metadata: metadata,
    level: level,
    status_message: status_message,
    parent_observation_id: @id,
    version: version,
    **kwargs
  )
end

#get_url ⇒ Object 



260
261
262
 
# File 'lib/langfuse/span.rb', line 260

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

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

Create a child guardrail observation



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/langfuse/span.rb', line 232

def guardrail(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
              metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::GUARDRAIL,
    **kwargs
  )
end

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

Create a child retriever observation



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

def retriever(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
              metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::RETRIEVER,
    **kwargs
  )
end

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



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/langfuse/span.rb', line 249

def score(name:, value:, data_type: nil, comment: nil, **kwargs)
  @client.score(
    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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/langfuse/span.rb', line 56

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 



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/langfuse/span.rb', line 264

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

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

Create a child tool observation



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

def tool(name: nil, start_time: nil, end_time: nil, input: nil, output: nil,
         metadata: nil, level: nil, status_message: nil, version: nil, **kwargs)
  span(
    name: name,
    start_time: start_time,
    end_time: end_time,
    input: input,
    output: output,
    metadata: metadata,
    level: level,
    status_message: status_message,
    version: version,
    as_type: ObservationType::TOOL,
    **kwargs
  )
end

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/langfuse/span.rb', line 30

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

  update_span
  self
end