chat_portkey {ellmer} | R Documentation |
Chat with a model hosted on PortkeyAI
Description
PortkeyAI provides an interface (AI Gateway) to connect through its Universal API to a variety of LLMs providers with a single endpoint.
Authentication
API keys together with configurations of LLM providers are stored inside Portkey application.
Usage
chat_portkey(
system_prompt = NULL,
base_url = "https://api.portkey.ai/v1",
api_key = portkeyai_key(),
virtual_key = NULL,
model = NULL,
params = NULL,
api_args = list(),
echo = NULL
)
models_portkey(
base_url = "https://api.portkey.ai/v1",
api_key = portkeyai_key(),
virtual_key = NULL
)
Arguments
system_prompt |
A system prompt to set the behavior of the assistant. |
base_url |
The base URL to the endpoint; the default uses OpenAI. |
api_key |
API key to use for authentication. You generally should not supply this directly, but instead set the |
virtual_key |
A virtual identifier storing LLM provider's API key. See documentation. |
model |
The model to use for the chat (defaults to "gpt-4o").
We regularly update the default, so we strongly recommend explicitly specifying a model for anything other than casual use.
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.
See Also
Other chatbots:
chat_anthropic()
,
chat_aws_bedrock()
,
chat_azure_openai()
,
chat_cloudflare()
,
chat_cortex_analyst()
,
chat_databricks()
,
chat_deepseek()
,
chat_github()
,
chat_google_gemini()
,
chat_groq()
,
chat_huggingface()
,
chat_mistral()
,
chat_ollama()
,
chat_openai()
,
chat_openrouter()
,
chat_perplexity()
Examples
## Not run:
chat <- chat_portkey(virtual_key = Sys.getenv("PORTKEY_VIRTUAL_KEY"))
chat$chat("Tell me three jokes about statisticians")
## End(Not run)