https://github.com/sumidu/openaiassistant

https://github.com/sumidu/openaiassistant

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sumidu/openaiassistant
• Owner: Sumidu
• License: other
• Created: 2024-02-18T19:10:58.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-05-14T16:20:29.000Z (8 months ago)
• Last Synced: 2024-11-16T23:02:56.465Z (2 months ago)
• Language: R
• Homepage: https://sumidu.github.io/openaiassistant/
• Size: 3.88 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# openaiassistant

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![pkgdown](https://github.com/Sumidu/openaiassistant/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/Sumidu/openaiassistant/actions/workflows/pkgdown.yaml)

[![R-CMD-check](https://github.com/Sumidu/openaiassistant/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Sumidu/openaiassistant/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/Sumidu/openaiassistant/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Sumidu/openaiassistant?branch=main)

The goal of openaiassistant is to provide access to the assistants API of OpenAI.

The package is low effort and not yet fully tested.

## Installation

You can install the development version of openaiassistant like so:

``` r

remotes::install_github("sumidu/openaiassistant")

```

## Example Usage

This is a basic example which shows you how to use the assistants API.

It expects that you set the environment variable "OPENAI_API_KEY" to your OpenAI API Key.

This can be done by the following code in R:

```r 

Sys.setenv(OPENAI_API_KEY = "yourkeyhere")

```

This is the example.

```r

library(openaiassistant)

## Check if API Key is set

check_token()

# Create a new assistant

assistant_name <- "Nordisch Jarvis"

instructions <- 

  paste("This is an assistant that answers as briefly as possible.",

    "Ideally one word only.")

assistant <-

  assistant_create(

    assistant_name,

    instructions,

    model = "gpt-4-turbo-preview"

  )

# create a new thread

thread <- thread_create()

message <-

  thread_add_message(thread, "What is the Queen of the Hanse?")

# create a run with this question

run <- assistant_run(assistant, thread)

# wait for completion

while (is_active(run)) {

  run <- run_retrieve(run, thread)

  Sys.sleep(5)

}

# retrieve the messages

messages <- thread_retrieve_messages(thread)

# print the result

print(get_last_message(messages))

#> [1] "Lübeck"

# delete everything

res_thread <- thread_delete(thread$id)

res_assistant <- assistant_delete(assistant$id)

```