Creates an ellmer-compatible tool that searches a ragnar document store. This tool can be used with ReAct modules or registered with ellmer Chat objects for agentic document retrieval.
Arguments
- store
A ragnar store created with
ragnar::ragnar_store_create().- k
Number of documents to retrieve per search (default 5).
- name
Tool name (default "search_knowledge").
- description
Tool description for the LLM.
Examples
if (FALSE) { # \dontrun{
# Create a ragnar store from documents
library(ragnar)
store <- ragnar_store_create(
documents = my_docs,
embedding_fn = embed_openai()
)
# Create a search tool
search_tool <- ragnar_tool(store, k = 3)
# Use with ReAct module
react_mod <- module(
signature("question -> answer"),
type = "react",
tools = list(search_tool)
)
# Or register with ellmer Chat
chat <- ellmer::chat_openai()
chat$register_tool(search_tool)
} # }
