TheOpenAIR (version 0.1.0)

chat: Start or continue a chat conversation

Description

This function starts or continues a chat conversation by adding the user's message to the conversation. If the conversation does not exist, a new one will be initiated. The response can be displayed in the console, returned as a character vector, or returned as a full response object from the ChatGPT API.

Usage

chat(
  message,
  chatlog_id = ".__CURRENTCHAT__",
  output = "message_to_console",
  ...
)

Value

Depending on the value of the 'output' argument, this function returns one of the following: * "message_to_console": a message containing the response text is printed to the console (default). * "message": the response text as a character vector. * "response_object": the full response object from the ChatGPT API.

Arguments

message

A character string representing the message to be added to the chat conversation.

chatlog_id

A character string representing the ID of the chat conversation to start or continue. Default is ".__CURRENTCHAT__".

output

A character string indicating the output format of the response. Default is "message_to_console". Valid options are "message_to_console", "message", or "response_object".

...

Additional arguments to be passed to the `chat_completion` function.

Author

Ulrich Matter [e-mail]

Examples

if (FALSE) {
# Start a new chat and print the response to the console
chat("What's the weather like today?")

# Continue the chat, but return the response as a character vector
response_text <- chat("What about tomorrow's weather?", output = "message")
}