start_chat: Start a new chat session

In TheOpenAIR: Integrate 'OpenAI' Large Language Models into Your 'R' Workflows

Start a new chat session

Description

This function starts a new chat session by initializing a messages object with an initial system message, creating a new log environment to store the messages, and adding the messages object to the log environment.

Usage

start_chat(
  initial_role = "system",
  initial_content = "You are a helpful assistant.",
  show = FALSE,
  chatlog_id = NULL
)

Arguments

initial_role	A character string representing the role issueing the initial content (per default: "system")
initial_content	A character string representing the initial message from the system
show	Logical, if TRUE, the current chat log is displayed via View(). Default is FALSE.
chatlog_id	A character string representing the ID of this conversation. Per default, this will be set automatically.

Value

A character string indicating the name of the log environment created for the chat session.

Examples

# Start a new chat session with the default system message
chatlog_id <- start_chat()

# Start a new chat session with a custom system message
chatlog_id <- start_chat("How can I assist you today?")

TheOpenAIR documentation built on April 27, 2023, 5:10 p.m.