Class: Phronomy::VectorStore::Embeddings::Base

Inherits:

Object

• Object
• Phronomy::VectorStore::Embeddings::Base

Defined in:

lib/phronomy/vector_store/embeddings/base.rb

Overview

Abstract interface for embedding adapters.

Concrete implementations must override #embed and return a vector as an Array<Float>.

Direct Known Subclasses

RubyLLMEmbeddings

Instance Method Summary

• #embed(text, cancellation_token = nil) ⇒ Array<Float>

  Embed the given text and return a vector representation.

• #embed_async(text, cancellation_token = nil, timeout: nil) ⇒ OffloadPool::PendingOperation

  Submits an #embed call to OffloadPool and returns an OffloadPool::PendingOperation.

Instance Method Details

#embed(text, cancellation_token = nil) ⇒ Array<Float>

Embed the given text and return a vector representation.

Parameters:

• text (String) —

  the text to embed

• cancellation_token (Phronomy::Concurrency::CancellationToken, nil) (defaults to: nil) —

  optional; raises CancellationError when cancelled

Returns:

• (Array<Float>) —

  the embedding vector

Raises:

• (NotImplementedError)

# File 'lib/phronomy/vector_store/embeddings/base.rb', line 17

def embed(text, cancellation_token = nil)
  cancellation_token&.raise_if_cancelled!
  raise NotImplementedError, "#{self.class}#embed is not implemented"
end

#embed_async(text, cancellation_token = nil, timeout: nil) ⇒ OffloadPool::PendingOperation

Submits an #embed call to OffloadPool and returns an OffloadPool::PendingOperation.

Parameters:

• text (String)
• cancellation_token (Phronomy::Concurrency::CancellationToken, nil) (defaults to: nil)
• timeout (Numeric, nil) (defaults to: nil) —

  seconds before the operation is abandoned

Returns:

• (OffloadPool::PendingOperation)

# File 'lib/phronomy/vector_store/embeddings/base.rb', line 30

def embed_async(text, cancellation_token = nil, timeout: nil)
  Phronomy::Runtime.instance.offload.submit(
    timeout: timeout,
    cancellation_token: cancellation_token,
    on_full: :raise
  ) do
    embed(text, cancellation_token)
  end
end