Chat with Azure OpenAI
Arguments
- endpoint
Azure OpenAI endpoint url with protocol and hostname, i.e.
https://{your-resource-name}.openai.azure.com
- 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 bothturns
andsystem_prompt
.Each message in the list should be a named list with at least
role
(usuallysystem
,user
, orassistant
, buttool
is also possible). Normally there is also acontent
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
OPENAI_API_KEY
environment variable.- api_args
Named list of arbitrary extra arguments passed to 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.