chat_snowflake {ellmer} | R Documentation |
Chat with a model hosted on Snowflake
Description
The Snowflake provider allows you to interact with LLM models available through the Cortex LLM REST API.
Authentication
chat_snowflake()
picks up the following ambient Snowflake credentials:
A static OAuth token defined via the
SNOWFLAKE_TOKEN
environment variable.Key-pair authentication credentials defined via the
SNOWFLAKE_USER
andSNOWFLAKE_PRIVATE_KEY
(which can be a PEM-encoded private key or a path to one) environment variables.Posit Workbench-managed Snowflake credentials for the corresponding
account
.Viewer-based credentials on Posit Connect. Requires the connectcreds package.
Known limitations
Note that Snowflake-hosted models do not support images or tool calling.
See chat_cortex_analyst()
to chat with the Snowflake Cortex Analyst rather
than a general-purpose model.
Usage
chat_snowflake(
system_prompt = NULL,
account = snowflake_account(),
credentials = NULL,
model = NULL,
params = NULL,
api_args = list(),
echo = c("none", "output", "all")
)
Arguments
system_prompt |
A system prompt to set the behavior of the assistant. |
account |
A Snowflake account identifier,
e.g. |
credentials |
A list of authentication headers to pass into
|
model |
The model to use for the chat (defaults to "claude-3-7-sonnet"). We regularly update the default, so we strongly recommend explicitly specifying a model for anything other than casual use. |
params |
Common model parameters, usually created by |
api_args |
Named list of arbitrary extra arguments appended to the body
of every chat API call. Combined with the body object generated by ellmer
with |
echo |
One of the following options:
Note this only affects the |
Value
A Chat object.
Examples
chat <- chat_snowflake()
chat$chat("Tell me a joke in the form of a SQL query.")