View Source Rag.Ai.Provider behaviour (rag v0.2.3)

Behaviour for providers of AI capabilities.

Summary

embedding()

response()

Generates embeddings for texts.

Generates a text for prompt.

new(attrs)

Creates a new provider struct.

@type embedding() :: [number()]

@type response() :: String.t() | Enumerable.t()

@callback generate_embeddings(
  provider :: struct(),
  texts :: [String.t()],
  opts :: keyword()
) :: {:ok, [embedding()]} | {:error, any()}

Generates embeddings for texts.

@callback generate_text(
  provider :: struct(),
  prompt :: String.t(),
  opts :: keyword()
) :: {:ok, response()} | {:error, any()}

Generates a text for prompt.

@callback new(attrs :: map()) :: struct()

Creates a new provider struct.