Package: oaii 0.5.0

oaii: 'OpenAI' API R Interface

A comprehensive set of helpers that streamline data transmission and processing, making it effortless to interact with the 'OpenAI' API.

Authors:Cezary Kuran [aut, cre]

oaii_0.5.0.tar.gz
oaii_0.5.0.zip(r-4.5)oaii_0.5.0.zip(r-4.4)oaii_0.5.0.zip(r-4.3)
oaii_0.5.0.tgz(r-4.4-any)oaii_0.5.0.tgz(r-4.3-any)
oaii_0.5.0.tar.gz(r-4.5-noble)oaii_0.5.0.tar.gz(r-4.4-noble)
oaii_0.5.0.tgz(r-4.4-emscripten)oaii_0.5.0.tgz(r-4.3-emscripten)
oaii.pdf |oaii.html✨
oaii/json (API)

# Install 'oaii' in R:
install.packages('oaii', repos = c('https://cezarykuran.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/cezarykuran/oaii/issues

On CRAN:

1.48 score 1 scripts 172 downloads 76 exports 12 dependencies

Last updated 8 months agofrom:2d6f4e762b. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 10 2024
R-4.5-winOKOct 10 2024
R-4.5-linuxOKOct 10 2024
R-4.4-winOKOct 10 2024
R-4.4-macOKOct 10 2024
R-4.3-winOKOct 10 2024
R-4.3-macOKOct 10 2024

Exports:api_get_keyapi_set_keyassistants_create_assistant_requestassistants_create_file_requestassistants_delete_assistant_requestassistants_list_asistants_requestassistants_modify_assistant_requestassistants_retrieve_assistant_requestaudio_speech_requestaudio_transcription_requestaudio_translation_requestbrowseable_audiochat_fetch_messageschat_requestcompletions_fetch_textcompletions_requestcsv_to_dialog_dfdf_col_dt_formatdf_col_obj_implodedf_exclude_coldf_null_replacedf_order_by_coldialog_dfdialog_df_to_csvembeddings_create_requestembeddings_object_requestfeedbackfiles_delete_requestfiles_fetch_listfiles_list_requestfiles_retrieve_content_requestfiles_retrieve_requestfiles_upload_requestfine_tuning_cancel_job_requestfine_tuning_create_job_requestfine_tuning_events_list_requestfine_tuning_fetch_events_listfine_tuning_fetch_jobs_listfine_tuning_fetch_retrived_jobfine_tuning_jobs_list_requestfine_tuning_retrive_job_requestimages_edit_requestimages_fech_setimages_generator_requestimages_merge_setsimages_variation_requestis_browseableis_errormerge_dialog_dfmessages_create_message_requestmessages_list_message_files_requestmessages_list_messages_requestmessages_modify_message_requestmessages_retrieve_message_file_requestmessages_retrieve_message_requestmodels_delete_requestmodels_fetch_listmodels_list_requestmodels_retrieve_requestmoderation_create_requestrequestruns_cancel_run_requestruns_create_run_requestruns_create_thread_and_run_requestruns_list_run_steps_requestruns_list_runs_requestruns_modify_run_requestruns_retrieve_run_requestruns_retrieve_run_step_requestruns_submit_tool_outputs_requestset_loggerthreads_create_thread_requestthreads_delete_thread_requestthreads_modify_thread_requestthreads_retrieve_thread_requesttimestap_dt_str

Dependencies:askpassbackportsbase64enccheckmatecurlhttrjsonlitemagrittrmimeopensslR6sys

Readme and manuals

Help Manual

Help pageTopics
Get the OpenAI API key from environment variableapi_get_key
Store the OpenAI API key as environment variableapi_set_key
Create "uploaded file" objectapi_upload_file
API assistants: create assistantassistants_create_assistant_request
API assistants: create assistant fileassistants_create_file_request
API assistants: delete assistant fileassistants_delete_assistant_file_request
API assistants: delete assistantassistants_delete_assistant_request
API assistants: list assistantsassistants_list_asistants_request
API assistants: modify assistantassistants_modify_assistant_request
API assistants: retrieve assistant fileassistants_retrieve_assistant_file_request
API assistants: retrieve assistantassistants_retrieve_assistant_request
API audio: text to speech requestaudio_speech_request
API audio: speech to text (transcryption)audio_transcription_request
API audio: translate audio file into English textaudio_translation_request
Create browseable HTML audiobrowseable_audio
Fetch messages from response contentchat_fetch_messages
API chat: send create (chat) requestchat_request
Fetch completions text from response contentcompletions_fetch_text
API completions: create requestcompletions_request
Read csv file as dialog data.framecsv_to_dialog_df
Replace unix timestamp column(s) to formated dt stringdf_col_dt_format
Change to string nested lists in a given data.framedf_col_obj_implode
Remove columns from data.framedf_exclude_col
Replace all NULL values in given data.framedf_null_replace
Sort data.frame by column namedf_order_by_col
Create dialog data.framedialog_df
Save dialog data.frame as csv filedialog_df_to_csv
API embeddings: create embeddingsembeddings_create_request
API embeddings: get embedding objectembeddings_object_request
Feedback - ask chat and receive replyfeedback
API files: delete file requestfiles_delete_request
Extract files list as data.frame from response objectfiles_fetch_list
API files: get list requestfiles_list_request
API files: retrieve content requestfiles_retrieve_content_request
API files: retrieve file requestfiles_retrieve_request
API files: upload requestfiles_upload_request
API fine-tuning: cancel fine-tuning job requestfine_tuning_cancel_job_request
API fine-tuning: create job (model) requestfine_tuning_create_job_request
API fine-tuning: list events requestfine_tuning_events_list_request
API fine-tuning: job list from response objectfine_tuning_fetch_events_list
API fine-tuning: extract fine-tuning jobs list from response objectfine_tuning_fetch_jobs_list
API fine-tuning: fetch retrived job object from response objectfine_tuning_fetch_retrived_job
API fine-tuning: list jobs requestfine_tuning_jobs_list_request
API fine-tuning: retrieve fine-tuning job requestfine_tuning_retrive_job_request
API images: edit requestimages_edit_request
Fetch image set from response contentimages_fech_set
API images: create (generator) requestimages_generator_request
Merge image set/setsimages_merge_sets
API images: create image variation requestimages_variation_request
Test if RStudio Viewer (build in browser) is availableis_browseable
Test if object belongs to "error" classis_error
Test if x is a image setis_image_set
Merge multiple dialog data.framemerge_dialog_df
API messages: create messagemessages_create_message_request
API messages: list message filesmessages_list_message_files_request
API messages: list messagesmessages_list_messages_request
API messages: modify messagemessages_modify_message_request
API messages: retrieve message filemessages_retrieve_message_file_request
API messages: retrieve messagemessages_retrieve_message_request
API models: delete model requestmodels_delete_request
Extract models from response objectmodels_fetch_list
API models: list requestmodels_list_request
API models: retrieve model requestmodels_retrieve_request
API moderations: create moderationmoderation_create_request
Class oaii_content_audio print S3 methodprint.oaii_content_audio
Class oaii_content_audio_aac print S3 methodprint.oaii_content_audio_aac
Class oaii_content_audio_flac print S3 methodprint.oaii_content_audio_flac
Class oaii_content_audio_mp3 print S3 methodprint.oaii_content_audio_mp3
Class oaii_content_audio_opus print S3 methodprint.oaii_content_audio_opus
Class oaii_content_images print S3 methodprint.oaii_content_images
print S3 method for oaii_files_df classprint.oaii_files_df
print S3 method for oaii_fine_tuning_events_df classprint.oaii_fine_tuning_events_df
print S3 method for oaii_fine_tuning_job classprint.oaii_fine_tuning_job
print S3 method for oaii_fine_tuning_jobs_df classprint.oaii_fine_tuning_jobs_df
print S3 method for oaii_models_df classprint.oaii_models_df
Class oaii_res_se print S3 methodprint.oaii_res_se
API requestrequest
API runs: cancel a runruns_cancel_run_request
API runs: create runruns_create_run_request
API runs: create thread and runruns_create_thread_and_run_request
API runs: list run stepsruns_list_run_steps_request
API runs: list runsruns_list_runs_request
API runs: modify runruns_modify_run_request
API runs: retrieve runruns_retrieve_run_request
API runs: retrieve run stepruns_retrieve_run_step_request
API runs: submit tool outputs to runruns_submit_tool_outputs_request
Set log functions used by `oaii` packageset_logger
API threads: create threadthreads_create_thread_request
API threads: delete threadthreads_delete_thread_request
API threads: modify threadthreads_modify_thread_request
API threads: retrieve threadthreads_retrieve_thread_request
Convert unix timestamp to formated date/time stringtimestap_dt_str