llmflow (version 3.0.2)

retrieve_docs: Retrieve and Format R Function Documentation for LLM Consumption

Description

Retrieve and Format R Function Documentation for LLM Consumption

Usage

retrieve_docs(
  chat_obj,
  prompt,
  schema = package_function_schema(),
  schema_strict = TRUE,
  skip_undocumented = TRUE,
  use_llm_fallback = FALSE,
  example_count = 2,
  warn_skipped = TRUE
)

Value

Formatted documentation string

Arguments

chat_obj

LLM chat client object

prompt

Task description

schema

JSON schema (default: package_function_schema())

schema_strict

Strict schema validation

skip_undocumented

Skip functions without docs

use_llm_fallback

Use LLM to generate examples

example_count

Number of examples per function

warn_skipped

Show warning for skipped functions