API for ellmer
Chat with Large Language Models

Global functions
.check_function_args Source code
.onLoad Source code
.rlang_as_friendly_type Source code
.rlang_check_is_string Source code
.rlang_purrr_args_recycle Source code
.rlang_purrr_index Source code
.rlang_purrr_map_mold Source code
.rlang_purrr_probe Source code
.rlang_stop_unexpected_typeof Source code
.stop_not_number Source code
AssistantPartialTurn Man page
AssistantTurn Man page
Chat Man page
Content Man page
ContentImage Man page
ContentImageInline Man page
ContentImageRemote Man page
ContentPDF Man page
ContentText Man page
ContentThinking Man page
ContentToolRequest Man page
ContentToolResult Man page
Provider Man page
Summary.ellmer_dollars Source code
SystemTurn Man page
ToolDef Man page
Turn Man page
Type Man page
TypeArray Man page
TypeBasic Man page
TypeEnum Man page
TypeIgnore Man page
TypeJsonSchema Man page
TypeObject Man page
UserTurn Man page
`[.ellmer_dollars` Source code
`[.ellmer_prompt` Source code
`[[.ellmer_dollars` Source code
`append<-` Source code
`paste<-` Source code
accumulate Source code
accumulate_right Source code
anthropic_key Source code
anthropic_key_exists Source code
api_key_param Source code
append_turns Source code
as_bedrock_cache_point Source code
as_chat Source code
as_content Source code
as_controller Source code
as_credentials Source code
as_otel_message Source code
as_user_turn Source code
as_user_turns Source code
async_generator_method Source code
async_method Source code
aws_creds_cache Source code
azure_endpoint Source code
backoff_default Source code
base64_enc Source code
batch_chat Man page Source code
batch_chat_completed Man page Source code
batch_chat_structured Man page Source code
batch_chat_text Man page Source code
bedrock_cache_point Source code
cache_control Source code
cat_line Source code
cat_word_wrap Source code
chat Man page Source code
chat_anthropic Man page Source code
chat_anthropic_test Source code
chat_aws_bedrock Man page Source code
chat_aws_bedrock_test Source code
chat_azure_openai Man page Source code
chat_azure_openai_test Source code
chat_claude Man page
chat_cloudflare Man page Source code
chat_cloudflare_test Source code
chat_databricks Man page Source code
chat_deepseek Man page Source code
chat_github Man page Source code
chat_google_gemini Man page Source code
chat_google_gemini_test Source code
chat_google_vertex Man page Source code
chat_groq Man page Source code
chat_huggingface Man page Source code
chat_huggingface_test Source code
chat_lmstudio Man page Source code
chat_lmstudio_test Source code
chat_mistral Man page Source code
chat_mistral_test Source code
chat_ollama Man page Source code
chat_ollama_test Source code
chat_openai Man page Source code
chat_openai_compatible Man page Source code
chat_openai_compatible_test Source code
chat_openai_test Source code
chat_openrouter Man page Source code
chat_openrouter_test Source code
chat_perform Source code
chat_perplexity Man page Source code
chat_portkey Man page Source code
chat_portkey_test Source code
chat_posit Man page Source code
chat_snowflake Man page Source code
chat_vllm Man page Source code
chat_vllm_test Source code
check_arg Source code
check_args Source code
check_arguments Source code
check_bool Source code
check_call Source code
check_character Source code
check_closure Source code
check_credentials Source code
check_data_frame Source code
check_echo Source code
check_environment Source code
check_finish_reason Source code
check_formula Source code
check_function Source code
check_function2 Source code
check_has_batch_support Source code
check_is_ellmer_object Source code
check_logical Source code
check_name Source code
check_number_decimal Source code
check_number_whole Source code
check_openrouter_error Source code
check_recorded Source code
check_recorded_class Source code
check_string Source code
check_symbol Source code
check_tool Source code
check_tools Source code
check_turn Source code
claude_file_delete Man page Source code
claude_file_download Man page Source code
claude_file_get Man page Source code
claude_file_list Man page Source code
claude_file_upload Man page Source code
claude_tool_web_fetch Man page Source code
claude_tool_web_search Man page Source code
cli_escape Source code
cloudflare_account Source code
cloudflare_key Source code
color_role Source code
compact Source code
content_image_file Man page Source code
content_image_plot Man page Source code
content_image_url Man page Source code
content_pdf_file Man page Source code
content_pdf_url Man page Source code
content_text Source code
content_types Source code
contents_html Man page
contents_markdown Man page
contents_record Man page Source code
contents_replay Man page Source code
contents_text Man page
convert_from_type Source code
counter Source code
create_tool_def Man page Source code
credentials_cache Source code
databricks_cli_token Source code
databricks_config_field Source code
databricks_user_agent Source code
databricks_workspace Source code
deepseek_key Source code
default_azure_credentials Source code
default_databricks_credentials Source code
default_google_credentials Source code
default_posit_credentials Source code
default_snowflake_credentials Source code
defer Source code
deferred_method_transform Source code
desc_label Source code
desc_na Source code
desc_range Source code
desc_unique Source code
describe_column Source code
detect Source code
detect_index Source code
df_schema Man page Source code
discard Source code
dollars Source code
dots_named Source code
echo_non_text_contents Source code
ellmer Man page
ellmer-package Man page
ellmer_output Source code
ellmer_prompt Source code
ellmer_req_credentials Source code
ellmer_req_robustify Source code
ellmer_req_user_agent Source code
ellmer_user_agent Source code
emitter Source code
eval_vignette Source code
every Source code
expand_content_if_needed Source code
expand_tool_value Source code
expand_tool_values Source code
extract_comments Source code
extract_comments_and_signature Source code
extract_custom_id Source code Source code
extract_data Source code
extract_tool_requests Source code
find_comments_start Source code
find_index Source code
first_positive Source code
form_file Source code
format.ellmer_dollars Source code
gemini_client Source code
gemini_download_file Source code
gemini_extract_index Source code
gemini_normalize_result Source code
gemini_prepare_batch_body Source code
gemini_to_snake_case Source code
gemini_upload_file Source code
gen_async_promise_all Source code
generator_method Source code
get_help_text Source code
get_signature Source code
get_token_cost Source code
github_key Source code
google_location Source code
google_oauth_reset Source code
google_tool_web_fetch Man page Source code
google_tool_web_search Man page Source code
google_upload Man page Source code
google_upload_file Source code
google_upload_init Source code
google_upload_send Source code
google_upload_status Source code
google_upload_wait Source code
groq_key Source code
guess_mime_type Source code
has_claude_structured_output Source code
has_connect_viewer_token Source code
has_cost Source code
has_credentials Man page Source code
has_lmstudio Source code
has_ollama Source code
help_to_text Source code
hf_key Source code
imap Source code
inst_path Source code
interpolate Man page Source code
interpolate_file Man page Source code
interpolate_package Man page Source code
invoke_tool Source code
is_assistant_turn Source code
is_chat Source code
is_claude_model Source code
is_dev_package Source code
is_file_accessible Source code
is_hosted_session Source code
is_list_of_recorded_objects Source code
is_list_of_s7_objects Source code
is_openai_reasoning Source code
is_partial_turn Source code
is_prompt Source code
is_recorded_object Source code
is_replaying Source code
is_snapshot Source code
is_system_turn Source code
is_testing Source code
is_tool_request Source code
is_tool_result Source code
is_tool_result_turn Source code
is_user_turn Source code
is_whitespace Source code
keep Source code
key_exists Source code
key_get Source code
last_request_json Source code
last_response_json Source code
list_c Source code
list_to_atomic Source code
live_browser Man page Source code
live_console Man page Source code
lmstudio_credentials Source code
local_tokens Source code
locate_aws_credentials Source code
log_tokens Source code
log_turn Source code
log_turns Source code
map Source code
map2 Source code
map2_chr Source code
map2_dbl Source code
map2_int Source code
map2_lgl Source code
map_chr Source code
map_dbl Source code
map_if Source code
map_int Source code
map_lgl Source code
map_tokens Source code
match_prices Source code
match_tools Source code
maybe_echo_tool Source code
maybe_on_tool_request Source code
merge_any_or_empty Source code
merge_append Source code
merge_candidate_lists Source code
merge_content_text Source code
merge_dicts Source code
merge_identical Source code
merge_last Source code
merge_lists Source code
merge_objects Source code
merge_optional Source code
merge_parts Source code
mistral_key Source code
models_anthropic Man page
models_aws_bedrock Man page Source code
models_claude Man page Source code
models_deepseek Man page Source code
models_github Man page Source code
models_google_gemini Man page Source code
models_google_vertex Man page Source code
models_groq Man page Source code
models_lmstudio Man page Source code
models_mistral Man page Source code
models_ollama Man page Source code
models_openai Man page Source code
models_portkey Man page Source code
models_posit Man page Source code
models_vllm Man page Source code
modify_list Source code
multi_convert Source code
negate Source code
new_id Source code
new_tool_result Source code
normalize_turns Source code
obj_type_friendly Source code
obj_type_oo Source code
ollama_credentials Source code
ollama_model_capabilities Source code
ollama_model_details Source code
openai_download_file Source code
openai_json_fallback Source code
openai_key Source code
openai_key_exists Source code
openai_tool_web_search Man page Source code
openai_upload Source code
openrouter_key Source code
otel_chat_input Source code
oxford_comma Source code
parallel_chat Man page Source code
parallel_chat_structured Man page Source code
parallel_chat_text Man page Source code
parallel_turns Source code
param_model Source code
params Man page Source code
parse_data_url Source code
parse_json Source code
parse_ms Source code
paste_c Source code
paws_credentials Source code
perplexity_key Source code
pmap Source code
portkey_key Source code
posit_error_body Source code
posit_gateway_url Source code
posit_oauth_client Source code
posit_oauth_reset Source code
prepare_sink Source code
prettify Source code
pretty_json Source code
pretty_ms Source code
pretty_sec Source code
print.Chat Source code
print.ellmer_dollars Source code
print.ellmer_output Source code
print.ellmer_prompt Source code
print_json Source code
prop_bool Source code
prop_list_of Source code
prop_number_decimal Source code
prop_number_whole Source code
prop_redacted Source code
prop_string Source code
provider_aws_bedrock Source code
provider_hash Source code
read_file Source code
read_ndjson Source code
reasoning_content_field Source code
record_chat_otel_span_output Source code
record_chat_otel_span_status Source code
record_tool_otel_span_error Source code
recorded_class_info Source code
recorded_object Source code
reduce Source code
reduce_right Source code
replay Source code
request_anthropic_file Source code
request_summary Source code
safely Source code
set_default Source code
setup_active_promise_otel_span Source code
show_image Source code
silence_r_cmd_check_note Source code
sink_prefix Source code
sink_wordwrap Source code
skip_if_no_lmstudio Source code
skip_if_no_ollama Source code
snowflake_account Source code
snowflake_credentials_exist Source code
snowflake_keypair_cache Source code
snowflake_keypair_token Source code
snowflake_url Source code
some Source code
span_recording Source code
split_spaces Source code
standardise_params Source code
stop_input_type Source code
str_flatten Source code
str_trunc Source code
stream_controller Man page Source code
stream_text Source code
support_badge Source code
test_provider Source code
to_json Source code
token_usage Man page Source code
tokens Source code
tokens_row Source code
tool Man page Source code
tool_annotations Man page Source code
tool_error_string Source code
tool_errored Source code
tool_otel_response Source code
tool_reject Man page Source code
tool_request_args Source code
tool_results_as_turn Source code
tool_string Source code
tool_string_preview Source code
tracer_enabled Source code
transform_user_agent Source code
transpose Source code
trim Source code
turn_contents_expand Source code
turn_contents_preview Source code
turn_cost Source code
turn_failed Source code
turn_get_tool_errors Source code
turn_has_tool_request Source code
turn_split_tool_results Source code
type_array Man page Source code
type_boolean Man page Source code
type_enum Man page Source code
type_from_schema Man page Source code
type_has_additional_properties Source code
type_ignore Man page Source code
type_integer Man page Source code
type_needs_wrapper Source code
type_number Man page Source code
type_object Man page Source code
type_string Man page Source code
unique_pdf_name Source code
unique_tool_name Source code
unrowname Source code
user_turn Source code
uses_tool_structured_output Source code
vcr_example_end Source code
vcr_example_start Source code
vec_type_friendly Source code
vertex_url Source code
vllm_key Source code
walk Source code
warn_tool_errors Source code
with_otel_record Source code
workbench_databricks_token Source code
workbench_snowflake_token Source code
wrap_type_if_needed Source code
ellmer documentation built on July 14, 2026, 1:07 a.m.