chat4R_streaming: chat4R_streaming: Interact with GPT-4o (default) with...

In chatAI4R: Chat-Based Interactive Artificial Intelligence for R

chat4R_streaming: Interact with GPT-4o (default) with streaming using OpenAI API and set system context

Description

This function uses the OpenAI API to interact with the GPT-4o model (default) and generates responses based on user input with streaming data back to R. In this function, currently, "gpt-4o-mini", "gpt-4o", and "gpt-4-turbo" can be selected as OpenAI's LLM model. Additionally, a system message can be provided to set the context.

Usage

chat4R_streaming(
  content,
  Model = "gpt-4o-mini",
  temperature = 1,
  system_set = "",
  api_key = Sys.getenv("OPENAI_API_KEY")
)

Arguments

content	A string containing the user's input message.
Model	A string specifying the GPT model to use (default: "gpt-4o-mini").
temperature	A numeric value controlling the randomness of the model's output (default: 1).
system_set	A string containing the system message to set the context. If provided, it will be added as the first message in the conversation. Default is an empty string.
api_key	A string containing the user's OpenAI API key. Defaults to the value of the environment variable "OPENAI_API_KEY".

Details

Chat4R Function with Streaming and System Context

Value

A data frame containing the response from the GPT model (streamed to the console).

Author(s)

Satoshi Kume

Examples

## Not run: 
  Sys.setenv(OPENAI_API_KEY = "Your API key")

  # Without system_set
  chat4R_streaming(content = "What is the capital of France?")

  # With system_set provided
  chat4R_streaming(
    content = "What is the capital of France?",
    system_set = "You are a helpful assistant."
  )

## End(Not run)

chatAI4R documentation built on April 4, 2025, 1:06 a.m.