Skip to content

Chat with a model hosted on Azure OpenAI

Source: R/provider-azure.R
chat_azure.Rd

The Azure OpenAI server hosts a number of open source models as well as proprietary models from OpenAI.

Usage

chat_azure(
  endpoint = azure_endpoint(),
  deployment_id,
  api_version = NULL,
  system_prompt = NULL,
  turns = NULL,
  api_key = azure_key(),
  token = NULL,
  api_args = list(),
  echo = c("none", "text", "all")
)

Arguments

endpoint

Azure OpenAI endpoint url with protocol and hostname, i.e. https://{your-resource-name}.openai.azure.com. Defaults to using the value of the AZURE_OPENAI_ENDPOINT envinronment variable.

deployment_id

Deployment id for the model you want to use.

api_version

The API version to use.

system_prompt

A system prompt to set the behavior of the assistant.

turns

A list of turns to start the chat with (i.e., continuing a previous conversation). If not provided, the conversation begins from scratch. Do not provide non-NULL values for both turns and system_prompt.

Each message in the list should be a named list with at least role (usually system, user, or assistant, but tool is also possible). Normally there is also a content field, which is a string.

api_key

The API key to use for authentication. You generally should not supply this directly, but instead set the AZURE_OPENAI_API_KEY environment variable.

token

Azure token for authentication. This is typically not required for Azure OpenAI API calls, but can be used if your setup requires it.

api_args

Named list of arbitrary extra arguments appended to the body of every chat API call.

echo

One of the following options:

  • none: don't emit any output (default when running in a function).

  • text: echo text output as it streams in (default when running at the console).

  • all: echo all input and output.

Note this only affects the chat() method.

Value

A Chat object.