llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.rag/RAG

RAG

org.llm4s.rag.RAG
See theRAG companion class
object RAG

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
RAG.type

Members list

Type members

Classlikes

final implicit class RAGConfigOps(config: RAGConfig) extends AnyVal

Extension method to build from config.

Extension method to build from config.

Attributes

Supertypes
class AnyVal
trait Matchable
class Any

Value members

Concrete methods

def build(config: RAGConfig, resolveEmbeddingProvider: String => Result[EmbeddingProviderConfig], resolveRerankerConfig: () => Result[Option[RerankProviderConfig]])(using ModelRegistryService, ProviderRegistry): Result[RAG]

Build a RAG pipeline from configuration.

Build a RAG pipeline from configuration.

config.embeddingProvider is resolved through the given org.llm4s.llmconnect.spi.ProviderRegistry - by default every provider on the classpath - so an embedding provider that ships in its own module is usable here with nothing in llm4s-rag edited, and one that is absent fails with the registry's "not registered" error.

Value parameters

resolveEmbeddingProvider

supplies the provider config for the resolved, canonical embedding provider id - typically from Llm4sConfig.embeddings().

Attributes

def builder(): RAGConfig

Create a RAG builder with default configuration.

Create a RAG builder with default configuration.

The result is a RAGConfig, not a RAG: turn it into one with .build, which is an extension supplied by RAGConfigOps and is not found unless import org.llm4s.rag.RAG.RAGConfigOps is in scope. build also needs a ModelRegistryService given (ProviderRegistry.default is a given already), and it takes only a using clause, so it is written .build, not .build().

Attributes

Implicits

Implicits

final implicit def RAGConfigOps(config: RAGConfig): RAGConfigOps

Extension method to build from config.

Extension method to build from config.

Attributes

Generated with