Package index • openaiapi

Setup

oai_set_api_key(): Set OpenAI API key
make_sandbox_env(): Create a sandbox environment for function tools

Responses

oai_create_model_response() oai_model_response() oai_get_model_response() oai_delete_model_response() oai_list_input_items(): Responses API
ModelResponse: ModelResponse R6 Class
ModelResponseStream: ModelResponseStream R6 Class

Conversations

oai_create_conversation() oai_get_conversation() oai_update_conversation() oai_delete_conversation() oai_list_conversation_items() oai_create_conversation_items() oai_retrieve_conversation_item() oai_delete_conversation_item(): Conversations API
Conversation: Conversation R6 Class

Models

oai_list_models() oai_retrieve_model() oai_delete_model(): Models API

Fine tuning

oai_create_fine_tuning_job() oai_list_fine_tuning_jobs() oai_list_fine_tuning_events() oai_list_fine_tuning_checkpoints() oai_get_fine_tuning_job() oai_cancel_fine_tuning(): Fine-tuning API
FineTuningJob: FineTuningJob R6 class

Embeddings

oai_create_embeddings(): Embeddings API
Embedding: R6 class representing an Embedding in the OpenAI API

Chat completions

oai_create_chat_completion() oai_get_chat_completion() oai_get_chat_messages() oai_list_chat_completions() oai_update_chat_completion() oai_delete_chat_completion(): Chat completion API
ChatCompletion: ChatCompletion R6 class
ChatCompletionStream: ChatCompletionStream R6 class

Assistants

Create and manage Assistants.

oai_create_assistant() oai_modify_assistant() oai_list_assistants() oai_retrieve_assistant() oai_delete_assistant(): Assistant API
Assistant: Assistant R6 class

Threads

oai_create_thread() oai_modify_thread() oai_retrieve_thread() oai_delete_thread(): Threads API
Thread: Thread R6 class

Messages

oai_create_message() oai_attachment() oai_list_messages() oai_retrieve_message() oai_modify_message() oai_delete_message(): A helper function for the attachment argument in oai_create_message() and Message objects.
Message: Message R6 class

Runs

oai_create_run() oai_create_thread_and_run() oai_list_runs() oai_list_run_steps() oai_retrieve_run() oai_modify_run() oai_cancel_run() oai_submit_tool_outputs() oai_tool_output() oai_retrieve_run_step(): Run API
Run RunStream: Run R6 class

Vector store

oai_create_vector_store() oai_list_vector_stores() oai_retrieve_vector_store() oai_modify_vector_store() oai_delete_vector_store() oai_search_vector_store(): Vector Store API
oai_create_vector_store_file() oai_list_vector_store_files() oai_retrieve_vector_store_file() oai_update_vector_store_file() oai_delete_vector_store_file(): Vector store files API
oai_create_vector_store_file_batch() oai_retrieve_vector_store_file_batch() oai_cancel_vector_store_file_batch() oai_list_vector_store_files_in_a_batch(): Vector store file batch API
VectorStore: R6 class for managing a Vector Store in the OpenAI API
VectorStoreFile: VectorStoreFile R6 class
VectorStoreFilesBatch: VectorStoreFilesBatch R6 class

Audio

oai_create_speech() oai_create_transcription() oai_create_translation(): Audio API
Transcription VerboseTranscription: Transcription object Represents a transcription response returned by model, based on the provided input.

Utils

Files

oai_upload_file() oai_list_files() oai_retrieve_file() oai_delete_file() oai_retrieve_file_content(): Files API
File: OpenAI File Interface

Helpers

oai_message() oai_thread() oai_tool_resource(): A helper function for message arguments
oai_function_tool() oai_function_tool_parameter(): Define a function tool