Unified Interface for AI Model Providers

Documentation for package ‘aisdk’ version 1.4.10

Help Pages

aisdk: AI SDK for R

-- A --

Agent	Agent Class
AgentRegistry	AgentRegistry Class
agent_evals	Performance & Benchmarking: Agent Evals
agent_library	Agent Library: Built-in Agent Specialists
agent_registry	Agent Registry: Agent Storage and Lookup
aisdk	aisdk: AI SDK for R
analyze_image	Analyze Image
AnthropicProvider	Anthropic Provider Class
api_diagnostics	API Diagnostics
ask_ai	Ask aisdk About Recent R Context
as_preview_text	Render a Compact Preview String
auth_hook	Human-in-the-Loop Authorization
auto_fix	Autonomous Data Science Pipelines

-- C --

cache	Caching System
cache_tool	Cache Tool
call_object_accessor	Call an Object Accessor by Candidate Function Names
capability_models	Capability Model Routes
ChatSession	ChatSession Class
check_api	Connect and Diagnose API Reachability
check_ast_safety	Check AST Safety
check_sdk_compatibility	Check SDK Version Compatibility
clear_capability_model	Clear Capability Model
clear_error_context	Clear Error Context for ask_ai()
collect_ai_context	Collect Context for 'ask_ai()'
compat	Compatibility Layer: Feature Flags and Migration Support
Computer	Computer Class
config_model	Model Configuration Files
console	Console Chat: Interactive REPL
console_agent	Console Agent: Intelligent Terminal Assistant
console_chat	Start Console Chat
console_confirm	Console Confirmation Prompt
console_input	Console Text Input
console_menu	Console Interactive Menu
content_blocks	Provider-Neutral Content Blocks
content_image	Create Image Content
content_text	Create Text Content
context	Context Management
context_budget	Adaptive Context Budget Helpers
context_collectors	Context State Collectors
context_get	Get Session Context by Handle
context_management	Context Management Configuration
context_search	Search Session Context
core_api	Core API: High-Level Functions
core_object	Core Object API: Structured Output Generation
create_agent	Create an Agent
create_agent_registry	Create an Agent Registry
create_anthropic	Create Anthropic Provider
create_ask_user_tool	Create an ask_user Tool
create_capture_renderer	Create a capturing agent-output renderer
create_chat_session	Create a Chat Session
create_coder_agent	Create a CoderAgent
create_computer_tools	Create Computer Tools
create_console_agent	Create Console Agent
create_console_tools	Create Console Tools
create_context_management_config	Create Context Management Configuration
create_context_query_tools	Create Context Query Tools
create_custom_provider	Create a custom provider
create_data_agent	Create a DataAgent
create_default_semantic_adapter_registry	Create the Default Semantic Adapter Registry
create_embeddings	Create Embeddings
create_env_agent	Create an EnvAgent
create_file_agent	Create a FileAgent
create_gemini	Create Gemini Provider
create_hooks	Create Hooks
create_null_renderer	Create a null (no-op) agent-output renderer
create_openai	Create OpenAI Provider
create_permission_hook	Create Permission Hook
create_planner_agent	Create a PlannerAgent
create_r_code_tool	Create R Code Interpreter Tool
create_r_context_tools	Create R Context Tools
create_r_introspect_tools	Create R Introspection Tools
create_sandbox_system_prompt	Create Sandbox System Prompt
create_schema_from_func	Create Schema from Function
create_semantic_adapter	Create a Semantic Adapter
create_semantic_adapter_registry	Create a Semantic Adapter Registry
create_session	Create Session (Compatibility Wrapper)
create_shared_session	Create a Shared Session
create_skill_architect_agent	Create a SkillArchitect Agent
create_skill_registry	Create a Skill Registry
create_skill_tools	Create Skill Tools
create_standard_registry	Create Standard Agent Registry
create_telemetry	Create Telemetry
create_visualizer_agent	Create a VisualizerAgent
create_z_ggtree	Create Schema for ggtree Function

-- D --

default_skill_roots

Default Skill Roots

-- E --

edit_image	Edit Images
EmbeddingModelV1	Embedding Model V1 (Abstract Base Class)
enable_api_tests	Check if API tests should be enabled
execute_tool_calls	Execute Tool Calls
expect_llm_pass	Expect LLM Pass
expect_no_hallucination	Expect No Hallucination
expect_tool_selection	Expect Tool Selection
extension_runtime	Console Extension Runtime
extract_from_image	Extract Structured Data From Image

-- F --

fetch_api_models	Fetch available models from API provider
fix_json	JSON Utilities

-- G --

GeminiProvider	Gemini Provider Class
GenerateImageResult	Generate Image Result
GenerateResult	Generate Result
generate_image	Generate Images
generate_object	Core Object API: Structured Output Generation
generate_text	Generate Text
get_anthropic_base_url	Get Anthropic base URL from environment
get_anthropic_model	Get Anthropic model name from environment
get_anthropic_model_id	Get Anthropic model ID from environment
get_capability_model	Get Capability Model
get_context_management_config	Get Context Management Configuration
get_default_registry	Get Default Registry
get_memory	Get or Create Global Memory
get_model	Get Default Model
get_model_info	Get Full Model Info
get_model_options	Get Default Model Runtime Options
get_openai_base_url	Get OpenAI Base URL from environment
get_openai_embedding_model	Get OpenAI Embedding Model from environment
get_openai_model	Get OpenAI Model from environment
get_openai_model_id	Get OpenAI Model ID from environment
get_or_create_semantic_adapter_registry	Get or Create a Semantic Adapter Registry
get_r_context	Get R Context
get_r_documentation	Get R Documentation
get_r_source	Get R Source

-- H --

has_api_key	Check if specific provider key is available
HookHandler	Hook Handler
hooks	Hooks System
hypothesis_fix_verify	Hypothesis-Fix-Verify Loop

-- I --

ImageModelV1	Image Model V1 (Abstract Base Class)
image_api	Image APIs
input_image	Create Input Image Block
input_text	Create Input Text Block
inspect_r_function	Inspect an R Function
inspect_r_object	Inspect a Live R Object
is_semantic_class	Check Whether an Object Belongs to a Semantic Class

-- L --

LanguageModelV1	Language Model V1 (Abstract Base Class)
list_capability_models	List Capability Models
list_context_handles	List Available Context Handles
list_models	List Models for Provider
list_r_objects	List Live R Objects
load_chat_session	Load a Chat Session

-- M --

Middleware	Middleware (Base Class)
migrate_pattern	Migrate Legacy Code
model	Model Shortcut
model_defaults	Default Model Configuration
multimodal	Multimodal Helpers

-- O --

ObjectStrategy	Object Strategy
object_peek	Peek at a Live R Object
OpenAIProvider	OpenAI Provider Class
openai_code_interpreter_tool	OpenAI built-in code_interpreter tool
openai_computer_use_tool	OpenAI built-in computer_use tool
openai_file_search_tool	OpenAI built-in file_search tool
openai_hosted_mcp_tool	OpenAI hosted MCP tool
openai_web_search_tool	OpenAI built-in web_search tool
OutputStrategy	Output Strategy Interface

-- P --

print.GenerateObjectResult	Print GenerateObjectResult
print.z_schema	Print Method for z_schema
print_migration_guide	Print Migration Guide
ProjectMemory	Project Memory Class
project_memory	Project Memory System
ProviderRegistry	Provider Registry
provider_custom	Custom Provider Factory

-- R --

register_provider	Register a Provider Factory
reload_env	Reload project-level environment variables
render_text	Render Markdown Text
request_authorization	Request User Authorization (HITL)
resolve_model_for_capability	Resolve Model For Capability
resolve_r_binding	Resolve an R Binding
run_state	Run State Helpers
r_context_tools	R Context Tools
r_introspect_tools	R Introspection Tools for Autonomous Debugging

-- S --

safe_eval	Safe Eval with Timeout
safe_parse_json	Safe JSON Parser
safe_to_json	Safe Serialization to JSON
sandbox	R-Native Programmatic Sandbox
SandboxManager	SandboxManager Class
scan_skills	Scan for Skills
schema	Schema DSL: Lightweight JSON Schema Generator
schema_generator	Schema Generator
schema_to_json	Convert Schema to JSON
sdk_clear_protected_vars	Reset the Variable Registry
sdk_feature	Get Feature Flag
sdk_get_var_metadata	Get Metadata for a Protected Variable
sdk_is_var_locked	Check if a Variable is Locked
sdk_list_features	List Feature Flags
sdk_protect_var	Protect a Variable from Agent Modification
sdk_reset_features	Reset Feature Flags
sdk_set_feature	Set Feature Flag
sdk_unprotect_var	Unprotect a Variable
semantic_adapter	Semantic Adapter Runtime
session	Session Management: Stateful Chat Sessions
session_event_store	Console Session Event Store
set_capability_model	Set Capability Model
set_context_management_config	Set Context Management Configuration
set_model	Set Default Model
SharedSession	SharedSession Class
shared_session	SharedSession: Enhanced Multi-Agent Session Management
Skill	Skill Class
SkillRegistry	SkillRegistry Class
skill_registry	Skill Registry: Scan and Manage Skills
spec_model	Specification Layer: Model Interfaces
stdlib_agents	Standard Agent Library: Built-in Specialist Agents
strategy	Output Strategy System
stream_image	Stream Image Generation
stream_text	Stream Text
sub_session_query	Run a Bounded Child Session

-- T --

Telemetry	Telemetry Class
Tool	Tool Class
tool	Create a Tool

-- U --

update_renviron	Update .Renviron with new values
utils_capture	Capture R Console Output
utils_http	Utilities: HTTP and Retry Logic
utils_ids	Utilities: Stable IDs
utils_json	JSON Utilities
utils_middleware	Utilities: Middleware System
utils_registry	Utilities: Provider Registry

-- V --

variable_registry

Variable Registry

-- W --

walk_ast	Walk an Abstract Syntax Tree
wrap_language_model	Wrap Language Model with Middleware

-- Z --

z_any	Create Any Schema
z_array	Create Array Schema
z_boolean	Create Boolean Schema
z_dataframe	Create Dataframe Schema
z_describe	Describe Schema
z_empty_object	Create Empty Object Schema
z_enum	Create Enum Schema
z_integer	Create Integer Schema
z_number	Create Number Schema
z_object	Create Object Schema
z_string	Create String Schema