ForestHub SDK 0.1.0
C++14 LLM SDK for PC and embedded platforms
Loading...
Searching...
No Matches
foresthub::rag Namespace Reference

Retrieval-augmented generation: retriever interface and query types. More...

Namespaces

namespace  remote
 HTTP-based RAG retriever implementation.

Classes

struct  QueryRequest
 Request parameters for a RAG similarity query. More...
struct  QueryResponse
 Response from a RAG query containing matching document chunks. More...
struct  QueryResult
 A single document chunk returned from a RAG query. More...
class  Retriever
 Abstract interface for document retrieval. More...

Functions

std::string FormatContext (const std::vector< QueryResult > &results)
 Format query results as XML context block for LLM prompt injection.

Detailed Description

Retrieval-augmented generation: retriever interface and query types.

Function Documentation

◆ FormatContext()

std::string foresthub::rag::FormatContext ( const std::vector< QueryResult > & results)
inline

Format query results as XML context block for LLM prompt injection.

Output format:

<context>
<source id="1">chunk content</source>
<source id="2">chunk content</source>
</context>
Parameters
resultsVector of query results to format.
Returns
XML-formatted context string, or empty string if results are empty.