Package 'gemini.R'

Add history for chating context

Description

Add history for chating context

Usage

addHistory(history, role = NULL, item = NULL)

Arguments

history	The history of chat
role	The role of chat: "user" or "model"
item	The item of chat: "prompt" or "output"

Value

The history of chat

---

Generate text from text with Gemini

Description

Generate text from text with Gemini

Usage

gemini(prompt, model = "1.5-flash", temperature = 0.5, maxOutputTokens = 1024)

Arguments

prompt	The prompt to generate text from
model	The model to use. Options are '1.5-flash', '1.5-pro', '1.0-pro' and '2.0-flash-exp'. Default is '1.5-flash' see https://ai.google.dev/gemini-api/docs/models/gemini
temperature	The temperature to use. Default is 0.5 value should be between 0 and 2 see https://ai.google.dev/gemini-api/docs/models/generative-models#model-parameters
maxOutputTokens	The maximum number of tokens to generate. Default is 1024 and 100 tokens correspond to roughly 60-80 words.

Value

Generated text

See Also

https://ai.google.dev/docs/gemini_api_overview#text_input

Examples

## Not run: 
library(gemini.R)
setAPI("YOUR_API_KEY")
gemini("Explain dplyr's mutate function")

## End(Not run)

---

Analyze audio using Gemini

Description

This function sends audio to the Gemini API and returns a text description.

Usage

gemini_audio(
  audio = NULL,
  prompt = "Describe this audio",
  model = "1.5-flash",
  temperature = 0.5,
  maxOutputTokens = 1024
)

Arguments

audio	Path to the audio file (default: uses a sample file). Must be an MP3.
prompt	A string describing what to do with the audio.
model	The Gemini model to use ("1.5-flash" or "1.5-pro", "2.0-flash-exp"). Defaults to "1.5-flash".
temperature	Controls the randomness of the generated text (0-2). Defaults to 0.5.
maxOutputTokens	The maximum number of tokens in the generated text. Defaults to 1024.

Value

A character vector containing the Gemini API's response.

Examples

## Not run: 
library(gemini.R)
setAPI("YOUR_API_KEY")
gemini_image(audio = system.file("docs/reference/helloworld.mp3", package = "gemini.R"))

## End(Not run)

---

Multi-turn conversations (chat)

Description

Generate text from text with Gemini

Usage

gemini_chat(
  prompt,
  history = list(),
  model = "1.5-flash",
  temperature = 0.5,
  maxOutputTokens = 1024
)

Arguments

prompt	The prompt to generate text from
history	history object to keep track of the conversation
model	The model to use. Options are '1.5-flash', '1.5-pro', '1.0-pro' and '2.0-flash-exp'. Default is '1.5-flash' see https://ai.google.dev/gemini-api/docs/models/gemini
temperature	The temperature to use. Default is 0.5 value should be between 0 and 2 see https://ai.google.dev/gemini-api/docs/models/generative-models#model-parameters
maxOutputTokens	The maximum number of tokens to generate. Default is 1024 and 100 tokens correspond to roughly 60-80 words.

Value

Generated text

See Also

https://ai.google.dev/docs/gemini_api_overview#chat

Examples

## Not run: 
library(gemini.R)
setAPI("YOUR_API_KEY")

chats <- gemini_chat("Pretend you're a snowman and stay in character for each")
print(chats$outputs)

chats <- gemini_chat("What's your favorite season of the year?", chats$history)
print(chats$outputs)

chats <- gemini_chat("How do you think about summer?", chats$history)
print(chats$outputs)

## End(Not run)

---

Generate text from text and image with Gemini

Description

Generate text from text and image with Gemini

Usage

gemini_image(
  image = NULL,
  prompt = "Explain this image",
  model = "1.5-flash",
  temperature = 0.5,
  maxOutputTokens = 1024,
  type = "png"
)

Arguments

image	The image to generate text
prompt	The prompt to generate text, Default is "Explain this image"
model	The model to use. Options are '1.5-flash', '1.5-pro' and '2.0-flash-exp'. Default is '1.5-flash' see https://ai.google.dev/gemini-api/docs/models/gemini
temperature	The temperature to use. Default is 0.5 value should be between 0 and 2 see https://ai.google.dev/gemini-api/docs/models/generative-models#model-parameters
maxOutputTokens	The maximum number of tokens to generate. Default is 1024 and 100 tokens correspond to roughly 60-80 words.
type	The type of image. Options are 'png', 'jpeg', 'webp', 'heic', 'heif'. Default is 'png'

Value

Generated text

See Also

https://ai.google.dev/docs/gemini_api_overview#text_image_input

Examples

## Not run: 
library(gemini.R)
setAPI("YOUR_API_KEY")
gemini_image(image = system.file("docs/reference/figures/image.png", package = "gemini.R"))

## End(Not run)

---

Generate Roxygen Documentation

Description

Generates Roxygen2 documentation for an R function based on the currently selected code.

Usage

gen_docs(prompt = NULL)

Arguments

prompt

A character string specifying additional instructions for the LLM. Defaults to a prompt requesting Roxygen2 documentation without the original code.

Value

A character string containing the generated Roxygen2 documentation.

---

Generates unit test code for an R function.

Description

Generates unit test code for an R function.

Usage

gen_tests(prompt = NULL)

Arguments

prompt

A character string specifying the prompt for the Gemini model. If NULL, a default prompt is used.

Value

#' A character string containing the generated unit test code.

---