openapi_openai

OpenApiOpenAIClient - the Ruby gem for the OpenAI API

The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 2.0.0
Package version: 1.1.0
Generator version: 7.4.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/oapicf/openapi-openai

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_openai.gemspec

Then either install the gem locally:

gem install ./openapi_openai-1.1.0.gem

(for development, run gem install --dev ./openapi_openai-1.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'openapi_openai', '~> 1.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'openapi_openai', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'openapi_openai'

# Setup authorization
OpenApiOpenAIClient.configure do |config|
  # Configure Bearer authorization: ApiKeyAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = OpenApiOpenAIClient::AssistantsApi.new
thread_id = 'thread_id_example' # String | The ID of the thread to which this run belongs.
run_id = 'run_id_example' # String | The ID of the run to cancel.

begin
  #Cancels a run that is `in_progress`.
  result = api_instance.cancel_run(thread_id, run_id)
  p result
rescue OpenApiOpenAIClient::ApiError => e
  puts "Exception when calling AssistantsApi->cancel_run: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.openai.com/v1

Class	Method	HTTP request	Description
OpenApiOpenAIClient::AssistantsApi	cancel_run	POST /threads/thread_id/runs/run_id/cancel	Cancels a run that is `in_progress`.
OpenApiOpenAIClient::AssistantsApi	create_assistant	POST /assistants	Create an assistant with a model and instructions.
OpenApiOpenAIClient::AssistantsApi	create_assistant_file	POST /assistants/assistant_id/files	Create an assistant file by attaching a File to an assistant.
OpenApiOpenAIClient::AssistantsApi	create_message	POST /threads/thread_id/messages	Create a message.
OpenApiOpenAIClient::AssistantsApi	create_run	POST /threads/thread_id/runs	Create a run.
OpenApiOpenAIClient::AssistantsApi	create_thread	POST /threads	Create a thread.
OpenApiOpenAIClient::AssistantsApi	create_thread_and_run	POST /threads/runs	Create a thread and run it in one request.
OpenApiOpenAIClient::AssistantsApi	delete_assistant	DELETE /assistants/assistant_id	Delete an assistant.
OpenApiOpenAIClient::AssistantsApi	delete_assistant_file	DELETE /assistants/assistant_id/files/file_id	Delete an assistant file.
OpenApiOpenAIClient::AssistantsApi	delete_thread	DELETE /threads/thread_id	Delete a thread.
OpenApiOpenAIClient::AssistantsApi	get_assistant	GET /assistants/assistant_id	Retrieves an assistant.
OpenApiOpenAIClient::AssistantsApi	get_assistant_file	GET /assistants/assistant_id/files/file_id	Retrieves an AssistantFile.
OpenApiOpenAIClient::AssistantsApi	get_message	GET /threads/thread_id/messages/message_id	Retrieve a message.
OpenApiOpenAIClient::AssistantsApi	get_message_file	GET /threads/thread_id/messages/message_id/files/file_id	Retrieves a message file.
OpenApiOpenAIClient::AssistantsApi	get_run	GET /threads/thread_id/runs/run_id	Retrieves a run.
OpenApiOpenAIClient::AssistantsApi	get_run_step	GET /threads/thread_id/runs/run_id/steps/step_id	Retrieves a run step.
OpenApiOpenAIClient::AssistantsApi	get_thread	GET /threads/thread_id	Retrieves a thread.
OpenApiOpenAIClient::AssistantsApi	list_assistant_files	GET /assistants/assistant_id/files	Returns a list of assistant files.
OpenApiOpenAIClient::AssistantsApi	list_assistants	GET /assistants	Returns a list of assistants.
OpenApiOpenAIClient::AssistantsApi	list_message_files	GET /threads/thread_id/messages/message_id/files	Returns a list of message files.
OpenApiOpenAIClient::AssistantsApi	list_messages	GET /threads/thread_id/messages	Returns a list of messages for a given thread.
OpenApiOpenAIClient::AssistantsApi	list_run_steps	GET /threads/thread_id/runs/run_id/steps	Returns a list of run steps belonging to a run.
OpenApiOpenAIClient::AssistantsApi	list_runs	GET /threads/thread_id/runs	Returns a list of runs belonging to a thread.
OpenApiOpenAIClient::AssistantsApi	modify_assistant	POST /assistants/assistant_id	Modifies an assistant.
OpenApiOpenAIClient::AssistantsApi	modify_message	POST /threads/thread_id/messages/message_id	Modifies a message.
OpenApiOpenAIClient::AssistantsApi	modify_run	POST /threads/thread_id/runs/run_id	Modifies a run.
OpenApiOpenAIClient::AssistantsApi	modify_thread	POST /threads/thread_id	Modifies a thread.
OpenApiOpenAIClient::AssistantsApi	submit_tool_ouputs_to_run	POST /threads/thread_id/runs/run_id/submit_tool_outputs	When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
OpenApiOpenAIClient::AudioApi	create_speech	POST /audio/speech	Generates audio from the input text.
OpenApiOpenAIClient::AudioApi	create_transcription	POST /audio/transcriptions	Transcribes audio into the input language.
OpenApiOpenAIClient::AudioApi	create_translation	POST /audio/translations	Translates audio into English.
OpenApiOpenAIClient::ChatApi	create_chat_completion	POST /chat/completions	Creates a model response for the given chat conversation.
OpenApiOpenAIClient::CompletionsApi	create_completion	POST /completions	Creates a completion for the provided prompt and parameters.
OpenApiOpenAIClient::EmbeddingsApi	create_embedding	POST /embeddings	Creates an embedding vector representing the input text.
OpenApiOpenAIClient::FilesApi	create_file	POST /files	Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files. Please contact us if you need to increase these storage limits.
OpenApiOpenAIClient::FilesApi	delete_file	DELETE /files/file_id	Delete a file.
OpenApiOpenAIClient::FilesApi	download_file	GET /files/file_id/content	Returns the contents of the specified file.
OpenApiOpenAIClient::FilesApi	list_files	GET /files	Returns a list of files that belong to the user's organization.
OpenApiOpenAIClient::FilesApi	retrieve_file	GET /files/file_id	Returns information about a specific file.
OpenApiOpenAIClient::FineTuningApi	cancel_fine_tuning_job	POST /fine_tuning/jobs/fine_tuning_job_id/cancel	Immediately cancel a fine-tune job.
OpenApiOpenAIClient::FineTuningApi	create_fine_tuning_job	POST /fine_tuning/jobs	Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. Learn more about fine-tuning
OpenApiOpenAIClient::FineTuningApi	list_fine_tuning_events	GET /fine_tuning/jobs/fine_tuning_job_id/events	Get status updates for a fine-tuning job.
OpenApiOpenAIClient::FineTuningApi	list_fine_tuning_job_checkpoints	GET /fine_tuning/jobs/fine_tuning_job_id/checkpoints	List checkpoints for a fine-tuning job.
OpenApiOpenAIClient::FineTuningApi	list_paginated_fine_tuning_jobs	GET /fine_tuning/jobs	List your organization's fine-tuning jobs
OpenApiOpenAIClient::FineTuningApi	retrieve_fine_tuning_job	GET /fine_tuning/jobs/fine_tuning_job_id	Get info about a fine-tuning job. Learn more about fine-tuning
OpenApiOpenAIClient::ImagesApi	create_image	POST /images/generations	Creates an image given a prompt.
OpenApiOpenAIClient::ImagesApi	create_image_edit	POST /images/edits	Creates an edited or extended image given an original image and a prompt.
OpenApiOpenAIClient::ImagesApi	create_image_variation	POST /images/variations	Creates a variation of a given image.
OpenApiOpenAIClient::ModelsApi	delete_model	DELETE /models/model	Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
OpenApiOpenAIClient::ModelsApi	list_models	GET /models	Lists the currently available models, and provides basic information about each one such as the owner and availability.
OpenApiOpenAIClient::ModelsApi	retrieve_model	GET /models/model	Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
OpenApiOpenAIClient::ModerationsApi	create_moderation	POST /moderations	Classifies if text is potentially harmful.