R Client for the 'OpenAI' API

---

Documentation for package ‘openaiRtools’ version 0.2.2

• DESCRIPTION file.
• User guides, package vignettes and other documentation.

Help Pages

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