Package: openaiRtools 0.2.2

Chaoyang Luo

openaiRtools: R Client for the 'OpenAI' API

Complete R implementation of OpenAI Python SDK. Provides full compatibility with OpenAI API including chat completions, embeddings, images, audio, fine-tuning, and model management.

Authors:Chaoyang Luo [aut, cre]

openaiRtools_0.2.2.tar.gz
openaiRtools_0.2.2.zip(r-4.7-any)openaiRtools_0.2.2.zip(r-4.6-any)openaiRtools_0.2.2.zip(r-4.5-any)
openaiRtools_0.2.2.tgz(r-4.6-any)openaiRtools_0.2.2.tgz(r-4.5-any)
openaiRtools_0.2.2.tar.gz(r-4.7-any)openaiRtools_0.2.2.tar.gz(r-4.6-any)
openaiRtools_0.2.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
openaiRtools/json (API)

# Install 'openaiRtools' in R:

install.packages('openaiRtools', repos = c('https://xiaoluolorn.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/xiaoluolorn/openair/issues

On CRAN:

4.00 score 2 scripts 237 downloads 91 exports 14 dependencies

Last updated from:a1dff1dfc9. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel	OK	126
source / vignettes	OK	210
linux-release	OK	130
macos-release	OK	176
macos-oldrel	OK	167
windows-devel	OK	64
windows-release	OK	80
windows-oldrel	OK	86
wasm-release	OK	91

Exports:add_upload_part AssistantsClient AudioClient AudioTranscriptionsClient AudioTranslationsClient BatchClient cancel_batch cancel_fine_tuning_job cancel_response cancel_run cancel_upload ChatClient ChatCompletionsClient ChatCompletionsMessagesClient complete_upload CompletionsClient create_assistant create_batch create_chat_completion create_completion create_embedding create_fine_tuning_job create_image create_image_edit create_image_variation create_message create_moderation create_multimodal_message create_response create_run create_speech create_thread create_transcription create_translation create_upload create_vector_store delete_assistant delete_file delete_model delete_response delete_thread delete_vector_store EmbeddingsClient FilesClient FineTuningCheckpointsClient FineTuningClient FineTuningJobsClient image_from_file image_from_plot image_from_url ImagesClient list_assistants list_batches list_files list_fine_tuning_checkpoints list_fine_tuning_events list_fine_tuning_jobs list_messages list_models list_vector_stores MessagesClient ModelsClient ModerationsClient OpenAI OpenAIAPIError OpenAIConnectionError OpenAIError ResponsesClient retrieve_assistant retrieve_batch retrieve_file retrieve_file_content retrieve_fine_tuning_job retrieve_model retrieve_response retrieve_run retrieve_thread retrieve_vector_store RunsClient RunStepsClient SpeechClient StreamIterator text_content ThreadsClient update_assistant update_thread upload_file UploadsClient VectorStoreFileBatchesClient VectorStoreFilesClient VectorStoresClient

Dependencies:askpass cli curl glue httr2 jsonlite lifecycle magrittr openssl R6 rlang sys vctrs withr

Introduction to openaiRtools

Rendered fromintroduction.Rmdusingknitr::rmarkdown

Last update: 2026-03-02
Started: 2026-02-28

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Upload a File Part (Convenience Function)	add_upload_part
Assistants Client (Beta)	AssistantsClient
Audio Client	AudioClient
Audio Transcriptions Client	AudioTranscriptionsClient
Audio Translations Client	AudioTranslationsClient
Batch Client	BatchClient
Cancel a Batch Job (Convenience Function)	cancel_batch
Cancel a Fine-tuning Job (Convenience Function)	cancel_fine_tuning_job
Cancel a Streaming Response (Convenience Function)	cancel_response
Cancel a Run (Convenience Function)	cancel_run
Cancel a Multipart Upload (Convenience Function)	cancel_upload
Chat Completions Client	ChatClient
Chat Completions Interface	ChatCompletionsClient
Chat Completions Messages Client	ChatCompletionsMessagesClient
Complete a Multipart Upload (Convenience Function)	complete_upload
Completions Client (Legacy)	CompletionsClient
Create an Assistant (Convenience Function)	create_assistant
Create a Batch Job (Convenience Function)	create_batch
Create a Chat Completion (Convenience Function)	create_chat_completion
Create a Legacy Text Completion (Convenience Function)	create_completion
Create Text Embeddings (Convenience Function)	create_embedding
Create a Fine-tuning Job (Convenience Function)	create_fine_tuning_job
Generate an Image from Text (Convenience Function)	create_image
Edit an Image with DALL-E (Convenience Function)	create_image_edit
Create Image Variations with DALL-E (Convenience Function)	create_image_variation
Add a Message to a Thread (Convenience Function)	create_message
Check Content for Policy Violations (Convenience Function)	create_moderation
Build a Multimodal User Message (Text + Images)	create_multimodal_message
Create a Response (Convenience Function)	create_response
Create a Run (Convenience Function)	create_run
Convert Text to Speech (Convenience Function)	create_speech
Create a Thread (Convenience Function)	create_thread
Transcribe Audio to Text (Convenience Function)	create_transcription
Translate Audio to English Text (Convenience Function)	create_translation
Create a Multipart Upload Session (Convenience Function)	create_upload
Create a Vector Store (Convenience Function)	create_vector_store
Delete an Assistant (Convenience Function)	delete_assistant
Delete an Uploaded File (Convenience Function)	delete_file
Delete a Fine-Tuned Model (Convenience Function)	delete_model
Delete a Stored Response (Convenience Function)	delete_response
Delete a Thread (Convenience Function)	delete_thread
Delete a Vector Store (Convenience Function)	delete_vector_store
Embeddings Client	EmbeddingsClient
Files Client	FilesClient
Fine-tuning Checkpoints Client	FineTuningCheckpointsClient
Fine-tuning Client	FineTuningClient
Fine-tuning Jobs Client	FineTuningJobsClient
Create Image Content from a Local File	image_from_file
Create Image Content from an R Plot Object	image_from_plot
Create Image Content from a URL	image_from_url
Images Client	ImagesClient
List Assistants (Convenience Function)	list_assistants
List Batch Jobs (Convenience Function)	list_batches
List Uploaded Files (Convenience Function)	list_files
List Fine-tuning Checkpoints (Convenience Function)	list_fine_tuning_checkpoints
List Fine-tuning Events (Convenience Function)	list_fine_tuning_events
List Fine-tuning Jobs (Convenience Function)	list_fine_tuning_jobs
List Messages in a Thread (Convenience Function)	list_messages
List Available Models (Convenience Function)	list_models
List Vector Stores (Convenience Function)	list_vector_stores
Messages Client	MessagesClient
Models Client	ModelsClient
Moderations Client	ModerationsClient
Helper Functions for Multimodal Content	multimodal
OpenAI Client Class	OpenAI
OpenAI API Error	OpenAIAPIError
OpenAI Connection Error	OpenAIConnectionError
Responses Client	ResponsesClient
Retrieve an Assistant (Convenience Function)	retrieve_assistant
Retrieve a Batch Job (Convenience Function)	retrieve_batch
Retrieve File Metadata (Convenience Function)	retrieve_file
Retrieve File Content (Convenience Function)	retrieve_file_content
Retrieve a Fine-tuning Job (Convenience Function)	retrieve_fine_tuning_job
Retrieve a Model (Convenience Function)	retrieve_model
Retrieve a Response (Convenience Function)	retrieve_response
Retrieve a Run (Convenience Function)	retrieve_run
Retrieve a Thread (Convenience Function)	retrieve_thread
Retrieve a Vector Store (Convenience Function)	retrieve_vector_store
Runs Client	RunsClient
Run Steps Client	RunStepsClient
Speech Client (Text-to-Speech)	SpeechClient
Stream Iterator Class	StreamIterator
Create a Text Content Part	text_content
Threads Client (Beta)	ThreadsClient
Update an Assistant (Convenience Function)	update_assistant
Update a Thread (Convenience Function)	update_thread
Upload a File (Convenience Function)	upload_file
Uploads Client	UploadsClient
Vector Store File Batches Client	VectorStoreFileBatchesClient
Vector Store Files Client	VectorStoreFilesClient
Vector Stores Client (Beta)	VectorStoresClient