View Source Rag.Generation (rag v0.2.3)

Functions to generate a response and helpers to work with a generation struct.

Summary

Types

context_builder_function()
context_sources_builder_function()
embedding()
prompt_builder_function()
provider()
response()
response_function()
t()

Represents a generation, the main datastructure in rag.

Functions

add_error(generation, error)

Appends an error to the existing list of errors.

build_context(generation, context_builder_function, opts \\ [])

Passes generation and opts to context_builder_function to determine the context. Then, puts the context in generation.context.

build_context_sources(generation, context_sources_builder_function, opts \\ [])

Passes generation and opts to context_sources_builder_function to determine the context sources. Then, puts the context sources in generation.context_sources.

build_prompt(generation, prompt_builder_function, opts \\ [])

Passes generation and opts to prompt_builder_function to determine the prompt. Then, puts the prompt in generation.prompt.

generate_response(generation, response_function_or_provider, opts \\ [])

Passes generation.prompt to response_function or provider to generate a response. If successful, puts the result in generation.response.

get_evaluation(generation, key)

Gets the evaluation at key in generation.evaluations.

get_retrieval_result(generation, key)

Gets the retrieval result at key in generation.retrieval_results.

halt(generation)

Sets halted? to true to skip all remaining operations.

new(query, opts \\ [])

Creates a new generation struct from a query.

put_context(generation, context)

Puts context in generation.context.

put_context_sources(generation, context_sources)

Puts context_sources in generation.context_sources.

put_evaluation(generation, key, evaluation)

Puts evaluation at key in generation.evaluations.

put_prompt(generation, prompt)

Puts prompt in generation.prompt.

put_query_embedding(generation, query_embedding)

Puts query_embedding in generation.query_embedding.

put_response(generation, response)

Puts response in generation.response.

put_retrieval_result(generation, key, retrieval_result)

Puts retrieval_result at key in generation.retrieval_results.

Types

context_builder_function()

@type context_builder_function() :: (t(), keyword() -> String.t())

context_sources_builder_function()

@type context_sources_builder_function() :: (t(), keyword() -> [String.t()])

embedding()

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

prompt_builder_function()

@type prompt_builder_function() :: (t(), keyword() -> String.t())

provider()

@type provider() :: struct()

response()

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

response_function()

@type response_function() :: (String.t(), keyword() -> response())

t()

@type t() :: %Rag.Generation{
  context: String.t() | nil,
  context_sources: [String.t()],
  errors: [any()],
  evaluations: %{optional(atom()) => any()},
  halted?: boolean(),
  prompt: String.t() | nil,
  query: String.t() | nil,
  query_embedding: embedding() | nil,
  ref: any(),
  response: response() | nil,
  retrieval_results: %{optional(atom()) => any()}
}

Represents a generation, the main datastructure in rag.

Functions

add_error(generation, error)

@spec add_error(t(), any()) :: t()

Appends an error to the existing list of errors.

build_context(generation, context_builder_function, opts \\ [])

@spec build_context(t(), context_builder_function(), keyword()) :: t()

Passes generation and opts to context_builder_function to determine the context. Then, puts the context in generation.context.

build_context_sources(generation, context_sources_builder_function, opts \\ [])

@spec build_context_sources(t(), context_sources_builder_function(), keyword()) :: t()

Passes generation and opts to context_sources_builder_function to determine the context sources. Then, puts the context sources in generation.context_sources.

build_prompt(generation, prompt_builder_function, opts \\ [])

@spec build_prompt(t(), prompt_builder_function(), keyword()) :: t()

Passes generation and opts to prompt_builder_function to determine the prompt. Then, puts the prompt in generation.prompt.

generate_response(generation, response_function_or_provider, opts \\ [])

@spec generate_response(t(), response_function() | provider(), keyword()) :: t()

Passes generation.prompt to response_function or provider to generate a response. If successful, puts the result in generation.response.

get_evaluation(generation, key)

@spec get_evaluation(t(), key :: atom()) :: any()

Gets the evaluation at key in generation.evaluations.

get_retrieval_result(generation, key)

@spec get_retrieval_result(t(), key :: atom()) :: any()

Gets the retrieval result at key in generation.retrieval_results.

halt(generation)

@spec halt(t()) :: t()

Sets halted? to true to skip all remaining operations.

new(query, opts \\ [])

@spec new(String.t(), opts :: keyword()) :: t()

Creates a new generation struct from a query.

put_context(generation, context)

@spec put_context(t(), context :: String.t()) :: t()

Puts context in generation.context.

put_context_sources(generation, context_sources)

@spec put_context_sources(t(), context_sources :: [String.t()]) :: t()

Puts context_sources in generation.context_sources.

put_evaluation(generation, key, evaluation)

@spec put_evaluation(t(), key :: atom(), evaluation :: any()) :: t()

Puts evaluation at key in generation.evaluations.

put_prompt(generation, prompt)

@spec put_prompt(t(), prompt :: String.t()) :: t()

Puts prompt in generation.prompt.

put_query_embedding(generation, query_embedding)

@spec put_query_embedding(t(), query_embedding :: [number()]) :: t()

Puts query_embedding in generation.query_embedding.

put_response(generation, response)

@spec put_response(t(), response :: response()) :: t()

Puts response in generation.response.

put_retrieval_result(generation, key, retrieval_result)

@spec put_retrieval_result(t(), key :: atom(), retrieval_result :: any()) :: t()

Puts retrieval_result at key in generation.retrieval_results.