GenAI (version 0.2.0)

chat.history.save: Chat History Save

Description

This function saves a chat history along with a generative AI object as a JSON file.

Usage

chat.history.save(genai.object, file.name)

Value

If successful, the chat history will be saved as a JSON file in your current or specified directory.

Arguments

genai.object

A generative AI object containing necessary and correct information.

file.name

A character string representing the name of the JSON file for the chat history.

Details

Providing accurate and valid information for each argument is crucial for successful chat generation by the generative AI model. If any parameter is incorrect, the function responds with an error message based on the API feedback. To view all supported generative AI models, use the function available.models.

See Also

GenAI - R Package "GenAI" Documentation

Live Demo in Colab

Examples

if (FALSE) {
# Assuming there is a GenAI object named 'genai.model' supporting this
# function, please refer to the "Live Demo in Colab" above for real
# examples. The following examples are just some basic guidelines.

# Method 1 (recommended): use the pipe operator "%>%"
genai.model %>%
  chat.history.save(file.name = "saved_history")

# Method 2: use the reference operator "$"
genai.model$chat.history.save(file.name = "saved_history")

# Method 3: use the function chat.history.save() directly
chat.history.save(genai.object = genai.model,
                  file.name = "saved_history")
}