Repository files navigation

The goal of gptstudio is for R programmers to easily incorporate use oflarge language models (LLMs) into their project workflows. These modelsappear to be a step change in our use of text for knowledge work, butyou should carefully consider ethical implications of using thesemodels.

For further addins, tailored for R developers, also see the sisterpackage:gpttools

install.packages("gptstudio")

To get a bug fix or to use a feature from the development version, youcan install the development version of this package from GitHub.

# install.packages("pak")pak::pak("MichelNivard/gptstudio")

To get started, you must first set up an API service. The package isconfigured to work with several AI service providers, allowing forflexibility and choice based on your specific needs. The defaultconfiguration is set to use OpenAI’s services. To use it you need:

1. Make an OpenAI account.Sign up here.

2. Create an OpenAI APIkey to use with thepackage.

3. Set the API key up in Rstudio. See the section below on configuringthe API key.

To interact with the OpenAI API, it’s required to have a validOPENAI_API_KEY environment variable. Here are the steps to configureit.

You can establish this environment variable globally by including it inyour project’s .Renviron file. This approach ensures that theenvironment variable persists across all sessions as the Shiny app runsin the background.

Here is a set of commands to open the .Renviron file for modification:

require(usethis)edit_r_environ()

For a persistent setting that loads every time you launch this project,add the following line to .Renviron, replacing"<APIKEY>" with youractual API key:

OPENAI_API_KEY="<APIKEY>"

Caution: If you’re using version control systems like GitHub orGitLab, remember to include .Renviron in your .gitignore file to preventexposing your API key!

Important Note: OpenAI API will not function without valid paymentdetails entered into your OpenAI account. This is a restriction imposedby OpenAI and is unrelated to this package.

While OpenAI is the default and currently considered one of the mostrobust options,gptstudio is also compatible with other AI serviceproviders. These includeAnthropic,HuggingFace,Google AIStudio,AzureOpenAI,andPerplexity.You can select any of these providers based on your preference orspecific requirements. You can also run local models withOllama.This requires more setup but at the benefit of not sharing your datawith any third party.

To use an alternative provider, you will need to obtain the relevant APIkey or access credentials from the chosen provider and configure themsimilarly.

This privacy notice is applicable to the R package that uses popularlanguage models like gpt-4 turbo and claude-3.5. By using this package,you agree to adhere to the privacy terms and conditions set by the APIservice.

When using this R package, any text or code you highlight/select withyour cursor, or the prompt you enter within the built-in applications,will be sent to the selected AI service provider (e.g., OpenAI,Anthropic, HuggingFace, Google AI Studio, Azure OpenAI) as part of anAPI request. This data sharing is governed by the privacy notice, rules,and exceptions that you agreed to with the respective service providerwhen creating an account.

We cannot guarantee the security of the data you send via the API to anyAI service provider, nor can we provide details on how each serviceprocesses or uses your data. However, these providers often state thatthey use prompts and results to enhance their AI models, as outlined intheir terms of use. Be sure to review the terms of use of the respectiveAI service provider directly.

The R package is designed to share only the text or code that youspecifically highlight/select or include in a prompt through ourbuilt-in applications. No other elements of your R environment will beshared unless you turn those features on. It is your responsibility toensure that you do not accidentally share sensitive data with any AIservice provider.

IMPORTANT: To maintain the privacy of your data, do not highlight,include in a prompt, or otherwise upload any sensitive data, code, ortext that should remain confidential.

Please note that the gptstudio project is released with aContributorCode ofConduct.By contributing to this project, you agree to abide by its terms.