One-line registration of the ggpaintr docs tool on an existing
ellmer Chat object. The tool wraps
ptr_llm_topic() so the LLM can pull focused, runnable examples
on demand instead of loading every topic into the system prompt.
Arguments
- chat
An ellmer
Chatobject (fromellmer::chat_anthropic(),ellmer::chat_openai(), etc.).- tool_name
String. The name the LLM will call the tool under. Defaults to
"ggpaintr_docs"; override if it would collide with another tool you already registered.
Details
The set of valid topic names is snapshotted at registration time
using ptr_llm_topics(), so the LLM cannot request a topic that
does not exist. If you upgrade ggpaintr in the same session and new
topics are added, call this again on a fresh chat.
This function does not set the chat's system prompt. Pass
ptr_llm_primer() to the system_prompt = argument of your
chat_*() constructor so the model knows when to reach for the tool.
Examples
if (interactive()) {
library(ellmer)
chat <- chat_anthropic(system_prompt = ptr_llm_primer())
ptr_llm_register(chat)
chat$chat("Build a Shiny app where the user picks X and Y columns from mtcars.")
}