@sqlrooms/ai-rag / createRagTool

Function: createRagTool()

createRagTool(): OpenAssistantTool<ZodObject<{ query: ZodString; database: ZodOptional<ZodString>; topK: ZodDefault<ZodOptional<ZodNumber>>; }, $strip>, RagToolLlmResult, RagToolAdditionalData, unknown>

Create a RAG (Retrieval Augmented Generation) tool for AI.

This tool allows the AI to search through embedded documentation to find relevant context before answering questions.

Returns

OpenAssistantTool<ZodObject<{ query: ZodString; database: ZodOptional<ZodString>; topK: ZodDefault<ZodOptional<ZodNumber>>; }, $strip>, RagToolLlmResult, RagToolAdditionalData, unknown>

Example

const store = createRoomStore({
  slices: [
    createRagSlice({embeddingsDatabases: [...]}),
    createAiSlice({
      tools: {
        rag: createRagTool(),
      }
    })
  ]
});