# Chat with Large Language Models

## Documentation for package ‘ellmer’ version 0.4.2

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D G I L M O P S T U

## -- A --

AssistantPartialTurn | A user, assistant, or system turn
AssistantTurn | A user, assistant, or system turn

## -- B --

batch_chat | Submit multiple chats in one batch
batch_chat_completed | Submit multiple chats in one batch
batch_chat_structured | Submit multiple chats in one batch
batch_chat_text | Submit multiple chats in one batch

## -- C --

Chat | The Chat object
chat | Chat with any provider
chat_anthropic | Chat with an Anthropic Claude model
chat_aws_bedrock | Chat with an AWS bedrock model
chat_azure_openai | Chat with a model hosted on Azure OpenAI
chat_claude | Chat with an Anthropic Claude model
chat_cloudflare | Chat with a model hosted on CloudFlare
chat_databricks | Chat with a model hosted on Databricks
chat_deepseek | Chat with a model hosted on DeepSeek
chat_github | Chat with a model hosted on the GitHub model marketplace
chat_google_gemini | Chat with a Google Gemini or Vertex AI model
chat_google_vertex | Chat with a Google Gemini or Vertex AI model
chat_groq | Chat with a model hosted on Groq
chat_huggingface | Chat with a model hosted on Hugging Face Serverless Inference API
chat_lmstudio | Chat with a local LM Studio model
chat_mistral | Chat with a model hosted on Mistral's La Platforme
chat_ollama | Chat with a local Ollama model
chat_openai | Chat with an OpenAI model
chat_openai_compatible | Chat with an OpenAI-compatible model
chat_openrouter | Chat with one of the many models hosted on OpenRouter
chat_perplexity | Chat with a model hosted on perplexity.ai
chat_portkey | Chat with a model hosted on PortkeyAI
chat_posit | Chat with a model hosted by Posit AI
chat_snowflake | Chat with a model hosted on Snowflake
chat_vllm | Chat with a model hosted by vLLM
claude_file_delete | Upload, downloand, and manage files for Claude
claude_file_download | Upload, downloand, and manage files for Claude
claude_file_get | Upload, downloand, and manage files for Claude
claude_file_list | Upload, downloand, and manage files for Claude
claude_file_upload | Upload, downloand, and manage files for Claude
claude_tool_web_fetch | Claude web fetch tool
claude_tool_web_search | Claude web search tool
Content | Content types received from and sent to a chatbot
ContentImage | Content types received from and sent to a chatbot
ContentImageInline | Content types received from and sent to a chatbot
ContentImageRemote | Content types received from and sent to a chatbot
ContentPDF | Content types received from and sent to a chatbot
contents_html | Format contents into a textual representation
contents_markdown | Format contents into a textual representation
contents_text | Format contents into a textual representation
ContentText | Content types received from and sent to a chatbot
ContentThinking | Content types received from and sent to a chatbot
ContentToolRequest | Content types received from and sent to a chatbot
ContentToolResult | Content types received from and sent to a chatbot
content_image_file | Encode images for chat input
content_image_plot | Encode images for chat input
content_image_url | Encode images for chat input
content_pdf_file | Encode PDFs content for chat input
content_pdf_url | Encode PDFs content for chat input
create_tool_def | Create metadata for a tool

## -- D --

df_schema | Describe the schema of a data frame, suitable for sending to an LLM

## -- G --

google_tool_web_fetch | Google URL fetch tool
google_tool_web_search | Google web search (grounding) tool
google_upload | Upload a file to gemini

## -- I --

interpolate | Helpers for interpolating data into prompts
interpolate_file | Helpers for interpolating data into prompts
interpolate_package | Helpers for interpolating data into prompts

## -- L --

live_browser | Open a live chat application
live_console | Open a live chat application

## -- M --

models_anthropic | Chat with an Anthropic Claude model
models_aws_bedrock | Chat with an AWS bedrock model
models_claude | Chat with an Anthropic Claude model
models_deepseek | Chat with a model hosted on DeepSeek
models_github | Chat with a model hosted on the GitHub model marketplace
models_google_gemini | Chat with a Google Gemini or Vertex AI model
models_google_vertex | Chat with a Google Gemini or Vertex AI model
models_groq | Chat with a model hosted on Groq
models_lmstudio | Chat with a local LM Studio model
models_mistral | Chat with a model hosted on Mistral's La Platforme
models_ollama | Chat with a local Ollama model
models_openai | Chat with an OpenAI model
models_portkey | Chat with a model hosted on PortkeyAI
models_posit | Chat with a model hosted by Posit AI
models_vllm | Chat with a model hosted by vLLM

## -- O --

openai_tool_web_search | OpenAI web search tool

## -- P --

parallel_chat | Submit multiple chats in parallel
parallel_chat_structured | Submit multiple chats in parallel
parallel_chat_text | Submit multiple chats in parallel
params | Standard model parameters
Provider | A chatbot provider

## -- S --

stream_controller | Create a stream controller
SystemTurn | A user, assistant, or system turn

## -- T --

token_usage | Report on token usage in the current session
tool | Define a tool
ToolDef | Define a tool
tool_annotations | Tool annotations
tool_reject | Reject a tool call
Turn | A user, assistant, or system turn
Type | Type definitions for function calling and structured data extraction.
TypeArray | Type definitions for function calling and structured data extraction.
TypeBasic | Type definitions for function calling and structured data extraction.
TypeEnum | Type definitions for function calling and structured data extraction.
TypeIgnore | Type definitions for function calling and structured data extraction.
TypeJsonSchema | Type definitions for function calling and structured data extraction.
TypeObject | Type definitions for function calling and structured data extraction.
type_array | Type specifications
type_boolean | Type specifications
type_enum | Type specifications
type_from_schema | Type specifications
type_ignore | Type specifications
type_integer | Type specifications
type_number | Type specifications
type_object | Type specifications
type_string | Type specifications

## -- U --

UserTurn | A user, assistant, or system turn