Skip to content
This repository has been archived by the owner on Nov 9, 2023. It is now read-only.
/ openapi_client Public archive

Automatically generated gem for the OpenAI APIs

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

kolide/openapi_client

BranchesTags

Repository files navigation

openapi_client

OpenapiClient - 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.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://help.openai.com/

Rebuilding the API

If there is a new version of the OpenAI API Spec, you will need to rebuild this wrapper. You must first have the openapi-generator tool installed.

On a mac:

brew install openapi-generator

Then rebuild the wrapper code:

openapi-generator generate -i https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml \
  -g ruby \
  --skip-validate-spec

NOTE: This will overwrite this very README file so you will likely want to revert or merge any changes that are made.

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-1.0.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_client', '~> 1.0.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_client', :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_client'

# Setup authorization
OpenapiClient.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 = OpenapiClient::AssistantApi.new
assistant_id = 'assistant_id_example' # String | The ID of the assistant to modify.
modify_assistant_request = OpenapiClient::ModifyAssistantRequest.new # ModifyAssistantRequest | 

begin
  #Modifies an assistant.
  result = api_instance.modify_assistant(assistant_id, modify_assistant_request)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling AssistantApi->modify_assistant: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
OpenapiClient::AssistantApi modify_assistant POST /assistants/{assistant_id} Modifies an assistant.
OpenapiClient::AssistantsApi cancel_run POST /threads/{thread_id}/runs/{run_id}/cancel Cancels a run that is in_progress.
OpenapiClient::AssistantsApi create_assistant POST /assistants Create an assistant with a model and instructions.
OpenapiClient::AssistantsApi create_assistant_file POST /assistants/{assistant_id}/files Create an assistant file by attaching a File to an assistant.
OpenapiClient::AssistantsApi create_message POST /threads/{thread_id}/messages Create a message.
OpenapiClient::AssistantsApi create_run POST /threads/{thread_id}/runs Create a run.
OpenapiClient::AssistantsApi create_thread POST /threads Create a thread.
OpenapiClient::AssistantsApi create_thread_and_run POST /threads/runs Create a thread and run it in one request.
OpenapiClient::AssistantsApi delete_assistant DELETE /assistants/{assistant_id} Delete an assistant.
OpenapiClient::AssistantsApi delete_assistant_file DELETE /assistants/{assistant_id}/files/{file_id} Delete an assistant file.
OpenapiClient::AssistantsApi delete_thread DELETE /threads/{thread_id} Delete a thread.
OpenapiClient::AssistantsApi get_assistant GET /assistants/{assistant_id} Retrieves an assistant.
OpenapiClient::AssistantsApi get_assistant_file GET /assistants/{assistant_id}/files/{file_id} Retrieves an AssistantFile.
OpenapiClient::AssistantsApi get_message GET /threads/{thread_id}/messages/{message_id} Retrieve a message.
OpenapiClient::AssistantsApi get_message_file GET /threads/{thread_id}/messages/{message_id}/files/{file_id} Retrieves a message file.
OpenapiClient::AssistantsApi get_run GET /threads/{thread_id}/runs/{run_id} Retrieves a run.
OpenapiClient::AssistantsApi get_run_step GET /threads/{thread_id}/runs/{run_id}/steps/{step_id} Retrieves a run step.
OpenapiClient::AssistantsApi get_thread GET /threads/{thread_id} Retrieves a thread.
OpenapiClient::AssistantsApi list_assistant_files GET /assistants/{assistant_id}/files Returns a list of assistant files.
OpenapiClient::AssistantsApi list_assistants GET /assistants Returns a list of assistants.
OpenapiClient::AssistantsApi list_message_files GET /threads/{thread_id}/messages/{message_id}/files Returns a list of message files.
OpenapiClient::AssistantsApi list_messages GET /threads/{thread_id}/messages Returns a list of messages for a given thread.
OpenapiClient::AssistantsApi list_run_steps GET /threads/{thread_id}/runs/{run_id}/steps Returns a list of run steps belonging to a run.
OpenapiClient::AssistantsApi list_runs GET /threads/{thread_id}/runs Returns a list of runs belonging to a thread.
OpenapiClient::AssistantsApi modify_message POST /threads/{thread_id}/messages/{message_id} Modifies a message.
OpenapiClient::AssistantsApi modify_run POST /threads/{thread_id}/runs/{run_id} Modifies a run.
OpenapiClient::AssistantsApi modify_thread POST /threads/{thread_id} Modifies a thread.
OpenapiClient::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.
OpenapiClient::AudioApi create_speech POST /audio/speech Generates audio from the input text.
OpenapiClient::AudioApi create_transcription POST /audio/transcriptions Transcribes audio into the input language.
OpenapiClient::AudioApi create_translation POST /audio/translations Translates audio into English.
OpenapiClient::ChatApi create_chat_completion POST /chat/completions Creates a model response for the given chat conversation.
OpenapiClient::CompletionsApi create_completion POST /completions Creates a completion for the provided prompt and parameters.
OpenapiClient::EditsApi create_edit POST /edits Creates a new edit for the provided input, instruction, and parameters.
OpenapiClient::EmbeddingsApi create_embedding POST /embeddings Creates an embedding vector representing the input text.
OpenapiClient::FilesApi create_file POST /files Upload a file that can be used across various endpoints/features. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files for can be a maximum of 512MB. 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.
OpenapiClient::FilesApi delete_file DELETE /files/{file_id} Delete a file.
OpenapiClient::FilesApi download_file GET /files/{file_id}/content Returns the contents of the specified file.
OpenapiClient::FilesApi list_files GET /files Returns a list of files that belong to the user's organization.
OpenapiClient::FilesApi retrieve_file GET /files/{file_id} Returns information about a specific file.
OpenapiClient::FineTunesApi cancel_fine_tune POST /fine-tunes/{fine_tune_id}/cancel Immediately cancel a fine-tune job.
OpenapiClient::FineTunesApi create_fine_tune POST /fine-tunes Creates a job that fine-tunes a specified 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
OpenapiClient::FineTunesApi list_fine_tune_events GET /fine-tunes/{fine_tune_id}/events Get fine-grained status updates for a fine-tune job.
OpenapiClient::FineTunesApi list_fine_tunes GET /fine-tunes List your organization's fine-tuning jobs
OpenapiClient::FineTunesApi retrieve_fine_tune GET /fine-tunes/{fine_tune_id} Gets info about the fine-tune job. Learn more about fine-tuning
OpenapiClient::FineTuningApi cancel_fine_tuning_job POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel Immediately cancel a fine-tune job.
OpenapiClient::FineTuningApi create_fine_tuning_job POST /fine_tuning/jobs Creates a job that fine-tunes a specified 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
OpenapiClient::FineTuningApi list_fine_tuning_events GET /fine_tuning/jobs/{fine_tuning_job_id}/events Get status updates for a fine-tuning job.
OpenapiClient::FineTuningApi list_paginated_fine_tuning_jobs GET /fine_tuning/jobs List your organization's fine-tuning jobs
OpenapiClient::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
OpenapiClient::ImagesApi create_image POST /images/generations Creates an image given a prompt.
OpenapiClient::ImagesApi create_image_edit POST /images/edits Creates an edited or extended image given an original image and a prompt.
OpenapiClient::ImagesApi create_image_variation POST /images/variations Creates a variation of a given image.
OpenapiClient::ModelsApi delete_model DELETE /models/{model} Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
OpenapiClient::ModelsApi list_models GET /models Lists the currently available models, and provides basic information about each one such as the owner and availability.
OpenapiClient::ModelsApi retrieve_model GET /models/{model} Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
OpenapiClient::ModerationsApi create_moderation POST /moderations Classifies if text violates OpenAI's Content Policy

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: Bearer authentication

About

Automatically generated gem for the OpenAI APIs

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages