Class: Langfuse::Embedding

Inherits:

BaseObservation

• Object
• BaseObservation
• Langfuse::Embedding

Includes:

ModelSetters

Defined in:

lib/langfuse/observations.rb

Overview

Observation for tracking embedding generation calls and vector operations.

Examples:

Block-based API

Langfuse.observe("generate-embeddings", as_type: :embedding) do |embedding|
  embedding.model = "text-embedding-ada-002"
  embedding.input = ["Ruby is a language", "Python is a language"]
  vectors = embedding_service.generate(embedding.input, model: embedding.model)
  embedding.update(
    output: vectors,
    usage_details: { prompt_tokens: 20, total_tokens: 20 }
  )
end

Stateful API

embedding = Langfuse.start_observation("vectorize", {
  model: "text-embedding-ada-002",
  input: "Convert this text to vector"
}, as_type: :embedding)
vector = embedding_api.create(embedding.input, model: embedding.model)
embedding.update(
  output: vector,
  usage_details: { prompt_tokens: 10, total_tokens: 10 }
)
embedding.end

Instance Attribute Summary

Attributes inherited from BaseObservation

#otel_span, #otel_tracer, #type

Instance Method Summary

• #initialize(otel_span, otel_tracer, attributes: nil) ⇒ Embedding constructor

  A new instance of Embedding.

• #update(attrs) ⇒ self

Methods included from ModelSetters

#model=, #model_parameters=, #usage=, #usage_details=

Methods inherited from BaseObservation

#current_span, #end, #event, #id, #input=, #level=, #metadata=, #output=, #score_trace, #start_observation, #trace_id, #trace_url, #update_trace

Constructor Details

#initialize(otel_span, otel_tracer, attributes: nil) ⇒ Embedding

Returns a new instance of Embedding.

Parameters:

• otel_span (OpenTelemetry::SDK::Trace::Span) —

  The underlying OTel span

• otel_tracer (OpenTelemetry::SDK::Trace::Tracer) —

  The OTel tracer

• attributes (Hash, Types::EmbeddingAttributes, nil) (defaults to: nil) —

  Optional initial attributes

# File 'lib/langfuse/observations.rb', line 658

def initialize(otel_span, otel_tracer, attributes: nil)
  super(otel_span, otel_tracer, attributes: attributes, type: OBSERVATION_TYPES[:embedding])
end

Instance Method Details

#update(attrs) ⇒ self

Parameters:

• attrs (Hash, Types::EmbeddingAttributes) —

  Embedding attributes to set

Returns:

• (self)

# File 'lib/langfuse/observations.rb', line 664

def update(attrs)
  update_observation_attributes(attrs)
  self
end