Man pages for aisdk
Unified Interface for AI Model Providers

agentAgent Class
agent_evalsPerformance & Benchmarking: Agent Evals
agent_libraryAgent Library: Built-in Agent Specialists
agent_registryAgent Registry: Agent Storage and Lookup
AgentRegistryAgentRegistry Class
aisdk-packageaisdk: AI SDK for R
analyze_imageAnalyze Image
analyze_tool_failuresAnalyze Tool Failures
annotate_model_capabilitiesAnnotate model capabilities based on ID
AnthropicLanguageModelAnthropic Language Model Class
AnthropicProviderAnthropic Provider Class
api_diagnosticsAPI Diagnostics
ask_aiAsk aisdk About Recent R Context
as_preview_textRender a Compact Preview String
auth_hookHuman-in-the-Loop Authorization
auto_fixAutonomous Data Science Pipelines
AUTO_FIX_SYSTEM_PROMPTSystem Prompt for Auto-Fix
build_console_system_promptBuild Console System Prompt
build_fix_promptBuild Fix Prompt
cacheCaching System
cache_toolCache Tool
call_object_accessorCall an Object Accessor by Candidate Function Names
capability_modelsCapability Model Routes
CaptureRendererCapturing Agent Output Renderer
capture_r_executionCapture the output, messages, and value of evaluating an...
capture_tracebackCapture Traceback
ChatSessionChatSession Class
check_apiConnect and Diagnose API Reachability
check_ast_safetyCheck AST Safety
check_sdk_compatibilityCheck SDK Version Compatibility
clear_capability_modelClear Capability Model
clear_error_contextClear Error Context for ask_ai()
collect_ai_contextCollect Context for 'ask_ai()'
compatCompatibility Layer: Feature Flags and Migration Support
computerComputer Class
config_modelModel Configuration Files
consoleConsole Chat: Interactive REPL
console_agentConsole Agent: Intelligent Terminal Assistant
console_appConsole App State Helpers
console_chatStart Console Chat
console_check_tool_failuresDisabled Console Tool Failure Prompt
console_confirmConsole Confirmation Prompt
console_frameConsole Frame Helpers
console_inputConsole Text Input
console_menuConsole Interactive Menu
console_personaConsole Persona Helpers
console_setupConsole Setup Helpers
console_utilsConsole Utility Functions
content_blocksProvider-Neutral Content Blocks
content_imageCreate Image Content
content_textCreate Text Content
content_translationContent Translation Helpers
contextContext Management
context_budgetAdaptive Context Budget Helpers
context_collectorsContext State Collectors
context_getGet Session Context by Handle
context_managementContext Management Configuration
context_searchSearch Session Context
core_apiCore API: High-Level Functions
core_objectCore Object API: Structured Output Generation
create_agentCreate an Agent
create_agent_registryCreate an Agent Registry
create_anthropicCreate Anthropic Provider
create_ask_user_toolCreate an ask_user Tool
create_auto_skill_registryBuild a skill registry by auto-discovering skills under a...
create_capture_rendererCreate a capturing agent-output renderer
create_chat_sessionCreate a Chat Session
create_coder_agentCreate a CoderAgent
create_computer_toolsCreate Computer Tools
create_console_agentCreate Console Agent
create_console_toolsCreate Console Tools
create_context_management_configCreate Context Management Configuration
create_context_query_toolsCreate Context Query Tools
create_custom_providerCreate a custom provider
create_data_agentCreate a DataAgent
create_default_semantic_adapter_registryCreate the Default Semantic Adapter Registry
create_delegate_toolCreate a Delegate Tool for an Agent
create_embeddingsCreate Embeddings
create_env_agentCreate an EnvAgent
create_file_agentCreate a FileAgent
create_geminiCreate Gemini Provider
create_hooksCreate Hooks
create_invalid_tool_handlerCreate Invalid Tool Handler
create_null_rendererCreate a null (no-op) agent-output renderer
create_openaiCreate OpenAI Provider
create_permission_hookCreate Permission Hook
create_planner_agentCreate a PlannerAgent
create_r_code_toolCreate R Code Interpreter Tool
create_r_context_toolsCreate R Context Tools
create_r_introspect_toolsCreate R Introspection Tools
create_sandbox_system_promptCreate Sandbox System Prompt
create_schema_from_funcCreate Schema from Function
create_semantic_adapterCreate a Semantic Adapter
create_semantic_adapter_registryCreate a Semantic Adapter Registry
create_sessionCreate Session (Compatibility Wrapper)
create_shared_sessionCreate a Shared Session
create_skill_architect_agentCreate a SkillArchitect Agent
create_skill_registryCreate a Skill Registry
create_skill_toolsCreate Skill Tools
create_standard_registryCreate Standard Agent Registry
create_stream_rendererCreate a Stream Renderer (cli / terminal backend)
create_telemetryCreate Telemetry
create_visualizer_agentCreate a VisualizerAgent
create_z_ggtreeCreate Schema for ggtree Function
debug_logDebug Log Helper
default_skill_rootsDefault Skill Roots
deprecation_warningDeprecation Warning Helper
describe_semantic_objectDescribe an Object Semantically
dot-sdk_featuresSDK Feature Flags
edit_imageEdit Images
EmbeddingModelV1Embedding Model V1 (Abstract Base Class)
enable_api_testsCheck if API tests should be enabled
execute_tool_callsExecute Tool Calls
expect_llm_passExpect LLM Pass
expect_no_hallucinationExpect No Hallucination
expect_tool_selectionExpect Tool Selection
extension_runtimeConsole Extension Runtime
extract_code_from_responseExtract Code from LLM Response
extract_from_imageExtract Structured Data From Image
fetch_api_modelsFetch available models from API provider
find_closest_matchFind Closest Match
find_toolFind Tool by Name
format_captured_executionFormat a captured execution result as text
GeminiImageModelGemini Image Model Class
GeminiLanguageModelGemini Language Model Class
GeminiProviderGemini Provider Class
generate_fixGenerate Fix
generate_hypothesisGenerate Hypothesis
generate_imageGenerate Images
GenerateImageResultGenerate Image Result
generate_model_docsGenerate Document Strings for Models
GenerateResultGenerate Result
generate_stable_idGenerate a stable, content-derived identifier
generate_textGenerate Text
generate_verification_hypothesisGenerate Verification Hypothesis
get_anthropic_base_urlGet Anthropic base URL from environment
get_anthropic_modelGet Anthropic model name from environment
get_anthropic_model_idGet Anthropic model ID from environment
get_capability_modelGet Capability Model
get_context_management_configGet Context Management Configuration
get_default_registryGet Default Registry
get_last_error_for_toolGet Last Error for Tool
get_memoryGet or Create Global Memory
get_modelGet Default Model
get_model_infoGet Full Model Info
get_model_optionsGet Default Model Runtime Options
get_openai_base_urlGet OpenAI Base URL from environment
get_openai_embedding_modelGet OpenAI Embedding Model from environment
get_openai_modelGet OpenAI Model from environment
get_openai_model_idGet OpenAI Model ID from environment
get_or_create_semantic_adapter_registryGet or Create a Semantic Adapter Registry
get_param_docsLook up a function's parameter documentation
get_r_contextGet R Context
get_r_documentationGet R Documentation
get_r_sourceGet R Source
get_semantic_adapter_registryGet a Semantic Adapter Registry
get_semantic_workflow_hintGet a Semantic Workflow Hint
has_api_keyCheck if specific provider key is available
HookHandlerHook Handler
hooksHooks System
hypothesis_fix_verifyHypothesis-Fix-Verify Loop
image_apiImage APIs
image_modelImage Model Utilities
ImageModelV1Image Model V1 (Abstract Base Class)
input_imageCreate Input Image Block
input_textCreate Input Text Block
inspect_r_functionInspect an R Function
inspect_r_objectInspect a Live R Object
is_semantic_classCheck Whether an Object Belongs to a Semantic Class
LanguageModelV1Language Model V1 (Abstract Base Class)
list_capability_modelsList Capability Models
list_context_handlesList Available Context Handles
list_get_exactExact (non-partial) list element lookup by name
list_modelsList Models for Provider
list_r_objectsList Live R Objects
load_chat_sessionLoad a Chat Session
load_models_configLoad Models Configuration
map_anthropic_chunkMap native Anthropic SSE event to aggregator calls
map_openai_chunkMap OpenAI SSE chunk to aggregator calls
MiddlewareMiddleware (Base Class)
migrate_patternMigrate Legacy Code
modelModel Shortcut
model_defaultsDefault Model Configuration
multimodalMultimodal Helpers
normalize_content_blocksNormalize content into a list of content blocks
object_peekPeek at a Live R Object
ObjectStrategyObject Strategy
openai_code_interpreter_toolOpenAI built-in code_interpreter tool
openai_computer_use_toolOpenAI built-in computer_use tool
OpenAIEmbeddingModelOpenAI Embedding Model
openai_file_search_toolOpenAI built-in file_search tool
openai_hosted_mcp_toolOpenAI hosted MCP tool
OpenAIImageModelOpenAI Image Model
OpenAILanguageModelOpenAI Language Model Class
OpenAIProviderOpenAI Provider Class
OpenAIResponsesLanguageModelOpenAI Responses Language Model Class
openai_web_search_toolOpenAI built-in web_search tool
OutputStrategyOutput Strategy Interface
parse_tool_argumentsParse Tool Arguments
post_multipart_to_apiPost Multipart to API with Retry
post_to_apiPost to API with Retry
print.GenerateObjectResultPrint GenerateObjectResult
print_migration_guidePrint Migration Guide
print.z_schemaPrint Method for z_schema
project_memoryProject Memory System
ProjectMemoryProject Memory Class
provider_anthropicAnthropic Provider
provider_customCustom Provider Factory
provider_geminiGemini Provider
provider_openaiOpenAI Provider
ProviderRegistryProvider Registry
r_context_toolsR Context Tools
register_json_coercionRegister a JSON coercion handler
register_providerRegister a Provider Factory
register_semantic_adapterRegister a Semantic Adapter
register_semantic_workflow_hintRegister a Semantic Workflow Hint
reload_envReload project-level environment variables
RendererAgent Output Renderer (UI-agnostic contract)
render_textRender Markdown Text
repair_json_stringRepair JSON String
repair_tool_callRepair Tool Call
request_authorizationRequest User Authorization (HITL)
resolve_console_startup_modelResolve the startup model from runtime defaults and...
resolve_model_for_capabilityResolve Model For Capability
resolve_r_bindingResolve an R Binding
r_eval_subprocessRun R code in an isolated subprocess with safety layers
r_introspect_toolsR Introspection Tools for Autonomous Debugging
run_stateRun State Helpers
safe_evalSafe Eval with Timeout
safe_parse_jsonSafe JSON Parser
safe_to_jsonSafe Serialization to JSON
sandboxR-Native Programmatic Sandbox
SandboxManagerSandboxManager Class
scan_skillsScan for Skills
schemaSchema DSL: Lightweight JSON Schema Generator
schema_generatorSchema Generator
schema_to_jsonConvert Schema to JSON
schema_to_listConvert Schema to Plain List
sdk_clear_protected_varsReset the Variable Registry
sdk_featureGet Feature Flag
sdk_get_var_metadataGet Metadata for a Protected Variable
sdk_is_var_lockedCheck if a Variable is Locked
sdk_list_featuresList Feature Flags
sdk_protect_varProtect a Variable from Agent Modification
sdk_reset_featuresReset Feature Flags
sdk_set_featureSet Feature Flag
sdk_unprotect_varUnprotect a Variable
semantic_adapterSemantic Adapter Runtime
semantic_render_inspectionRender a detailed semantic inspection of an object
semantic_render_summaryRender a semantic summary of an object
sessionSession Management: Stateful Chat Sessions
session_event_storeConsole Session Event Store
set_capability_modelSet Capability Model
set_context_management_configSet Context Management Configuration
set_modelSet Default Model
shared_sessionSharedSession: Enhanced Multi-Agent Session Management
SharedSessionSharedSession Class
should_show_thinkingCheck if thinking content should be shown
skillSkill Class
skill_registrySkill Registry: Scan and Manage Skills
SkillRegistrySkillRegistry Class
spec_modelSpecification Layer: Model Interfaces
sse_aggregatorSSE Stream Aggregator
SSEAggregatorSSEAggregator R6 Class
stdlib_agentsStandard Agent Library: Built-in Specialist Agents
strategyOutput Strategy System
stream_anthropicStream from Anthropic API
stream_from_apiStream from API
stream_imageStream Image Generation
stream_rendererStream Renderer: Enhanced CLI output
stream_responses_apiStream from Responses API
stream_textStream Text
sub_session_queryRun a Bounded Child Session
summarize_objectSummarize Object
telemetryTelemetry Class
toolTool Class
tool_factoryCreate a Tool
tool_result_messageCreate Tool Result Message
to_snake_caseConvert to Snake Case
translate_message_contentTranslate content blocks into a provider-specific payload
trim_context_previewTrim text to a short preview for context display
update_provider_modelsUpdate Provider Models
update_renvironUpdate .Renviron with new values
utils_astAST Safety Analysis
utils_captureCapture R Console Output
utils_cliCLI Utils: Markdown and Tool Rendering
utils_envEnvironment Configuration Utilities
utils_httpUtilities: HTTP and Retry Logic
utils_idsUtilities: Stable IDs
utils_jsonJSON Utilities
utils_middlewareUtilities: Middleware System
utils_modelsModel List Management Utilities
utils_models_updateModel Synchronization Utilities
utils_registryUtilities: Provider Registry
validate_model_messagesValidate messages against a model's multimodal capabilities
validate_semantic_actionValidate a semantic action against an object
variable_registryVariable Registry
walk_astWalk an Abstract Syntax Tree
wrap_language_modelWrap Language Model with Middleware
z_anyCreate Any Schema
z_any_objectSchema builder for an object with arbitrary keys
z_arrayCreate Array Schema
z_booleanCreate Boolean Schema
z_dataframeCreate Dataframe Schema
z_describeDescribe Schema
z_empty_objectCreate Empty Object Schema
z_enumCreate Enum Schema
z_integerCreate Integer Schema
z_numberCreate Number Schema
z_objectCreate Object Schema
z_stringCreate String Schema
aisdk documentation built on May 29, 2026, 9:07 a.m.