omniai-openai 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3afb339ec2a0e69d5a268fd134aae4119e3140ccad493f22d7db43b817145a4
-  data.tar.gz: f49c3cfd25228e49555981cc93e05e6702d3ce4edde9fa07277bc68c83312361
+  metadata.gz: 32b555cd7f80abb2cc11a12986a0a8df15e5c1d9b6d31113f5e00b47174f4ec6
+  data.tar.gz: 81046a31442f6f2b1a1eb5d37723deefbb82cf7c145907ae0bb72db738e09080
 SHA512:
-  metadata.gz: 4455db3523b81301793b936528312394cb0f98b8f51ad7a49f5f6fe5811c2969dcaf679649deb0cb90bfec5fdf5838f3ba6444eea645d560ceaaaf96b9c15f5f
-  data.tar.gz: 804f70fd6067cba057aaa7dbbe7d65f5edaa389e5315fb4a107f154fbafa1139d33ad637439e8b838036767c02e4e2cfed0d69c43c0a36cb805bb4dfe21eb907
+  metadata.gz: '0939f67a3bc54221fc1141b00ab8eb1c38323178da2c3c78057cd25a288df776397eb204c18f5425005a92f05556a67b28b902b6520716c359b7901a70d7e183'
+  data.tar.gz: 7611023c850321bec21b71dfb626b5c308905e55a1485d5c965d1e31f2e9ced8fa09929ada98eff681a933499e5735b88243c404cf7452c2fbf0aab3fd515606

data/README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/ksylvest/omniai-openai.svg?style=svg)](https://circleci.com/gh/ksylvest/omniai-openai)
 
-An OpenAI implementation of the [OmniAI](https://github.com/ksylvest/omniai) APIs.
+An OpenAI implementation of the [OmniAI](https://github.com/ksylvest/omniai) interface supporting ChatGPT, Whisper, Text-to-Voice, Voice-to-Text, and more. This library is community maintained.
 
 ## Installation
 
@@ -251,3 +251,186 @@ client.speak('A pessemistic pest exists amidst us.', format: OmniAI::OpenAI::Spe
 ```
 
 [OpenAI API Reference `format`](https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-response_format)
+
+## Files
+
+### Finding an File
+
+```ruby
+client.files.find(id: 'file_...')
+```
+
+### Listing all Files
+
+```ruby
+client.files.all
+```
+
+### Uploading a File
+
+```ruby
+file = client.files.build(io: File.open('...', 'wb'))
+file.save!
+```
+
+### Downloading a File
+
+```ruby
+file = client.files.find(id: 'file_...')
+File.open('...', 'wb') do |file|
+  file.content do |chunk|
+    file << chunk
+  end
+end
+```
+
+### Destroying a File
+
+```ruby
+client.files.destroy!('file_...')
+```
+
+## Assistants
+
+### Finding an Assistant
+
+```ruby
+client.assistants.find(id: 'asst_...')
+```
+
+### Listing all Assistants
+
+```ruby
+client.assistants.all
+```
+
+### Creating an Assistant
+
+```ruby
+assistant = client.assistants.build
+assistant.name = 'Ringo'
+assistant.model = OmniAI::OpenAI::Chat::Model::GPT_4
+assistant.description = 'The drummer for the Beatles.'
+assistant.save!
+```
+
+### Updating an Assistant
+
+```ruby
+assistant = client.assistants.find(id: 'asst_...')
+assistant.name = 'George'
+assistant.model = OmniAI::OpenAI::Chat::Model::GPT_4
+assistant.description = 'A guitarist for the Beatles.'
+assistant.save!
+```
+
+### Destroying an Assistant
+
+```ruby
+client.assistants.destroy!('asst_...')
+```
+
+## Threads
+
+### Finding a Thread
+
+```ruby
+client.threads.find(id: 'thread_...')
+```
+
+### Creating a Thread
+
+```ruby
+thread = client.threads.build
+thread.metadata = { user: 'Ringo' }
+thread.save!
+```
+
+### Updating a Thread
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+thread.metadata = { user: 'Ringo' }
+thread.save!
+```
+
+### Destroying a Threads
+
+```ruby
+client.threads.destroy!('thread_...')
+```
+
+### Messages
+
+#### Finding a Message
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+message = thread.messages.find(id: 'msg_...')
+message.save!
+```
+
+#### Listing all Messages
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+thread.messages.all
+```
+
+#### Creating a Message
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+message = thread.messages.build(role: 'user', content: 'Hello?')
+message.save!
+```
+
+#### Updating a Message
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+message = thread.messages.build(role: 'user', content: 'Hello?')
+message.save!
+```
+
+### Runs
+
+#### Finding a Run
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+run = thread.runs.find(id: 'run_...')
+run.save!
+```
+
+#### Listing all Runs
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+thread.runs.all
+```
+
+#### Creating a Run
+
+```ruby
+run = client.runs.find(id: 'thread_...')
+run = thread.runs.build
+run.metadata = { user: 'Ringo' }
+run.save!
+```
+
+#### Updating a Run
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+run = thread.messages.find(id: 'run_...')
+run.metadata = { user: 'Ringo' }
+run.save!
+```
+
+#### Cancelling a Run
+
+```ruby
+thread = client.threads.find(id: 'thread_...')
+run = thread.runs.cancel!(id: 'run_...')
+```

data/lib/omniai/openai/assistant.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI assistants implementation.
+    class Assistant
+      HEADERS = { 'OpenAI-Beta': 'assistants=v2' }.freeze
+
+      # @!attribute [rw] id
+      #   @return [String, nil]
+      attr_accessor :id
+
+      # @!attribute [rw] name
+      #   @return [String, nil]
+      attr_accessor :name
+
+      # @!attribute [rw] model
+      #   @return [String, nil]
+      attr_accessor :model
+
+      # @!attribute [rw] description
+      #   @return [String, nil]
+      attr_accessor :description
+
+      # @!attribute [rw] instructions
+      # @return [String, nil]
+      attr_accessor :instructions
+
+      # @!attribute [rw] metadata
+      #   @return [Hash]
+      attr_accessor :metadata
+
+      # @!attribute [rw] deleted
+      #   @return [Boolean, nil]
+      attr_accessor :deleted
+
+      # @!attribute [r] tools
+      #   @return [Array<Hash>, nil]
+      attr_accessor :tools
+
+      # @param client [OmniAI::OpenAI::Client] optional
+      # @param id [String]
+      # @param name [String]
+      # @param model [String]
+      # @param description [String, nil] optional
+      # @param instructions [String,nil] optional
+      # @param metadata [Hash] optional
+      def initialize(
+        client: Client.new,
+        id: nil,
+        name: nil,
+        model: nil,
+        description: nil,
+        instructions: nil,
+        metadata: {},
+        tools: []
+      )
+        @client = client
+        @id = id
+        @name = name
+        @model = model
+        @description = description
+        @instructions = instructions
+        @metadata = metadata
+        @tools = tools
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class.name} id=#{@id.inspect} name=#{@name.inspect} model=#{@model.inspect}>"
+      end
+
+      # @param id [String] required
+      # @param client [OmniAI::OpenAI::Client] optional
+      # @return [OmniAI::OpenAI::Assistant]
+      def self.find(id:, client: Client.new)
+        response = client.connection
+          .accept(:json)
+          .headers(HEADERS)
+          .get("/#{OmniAI::OpenAI::Client::VERSION}/assistants/#{id}")
+
+        raise HTTPError, response.flush unless response.status.ok?
+
+        parse(data: response.parse)
+      end
+
+      # @param limit [Integer] optional
+      # @param client [OmniAI::OpenAI::Client] optional
+      # @return [Array<OmniAI::OpenAI::Assistant>]
+      def self.all(limit: nil, client: Client.new)
+        response = client.connection
+          .accept(:json)
+          .headers(HEADERS)
+          .get("/#{OmniAI::OpenAI::Client::VERSION}/assistants", params: { limit: }.compact)
+
+        raise HTTPError, response.flush unless response.status.ok?
+
+        response.parse['data'].map { |data| parse(data:, client:) }
+      end
+
+      # @param id [String] required
+      # @param client [OmniAI::OpenAI::Client] optional
+      # @return [void]
+      def self.destroy!(id:, client: Client.new)
+        response = client.connection
+          .accept(:json)
+          .headers(HEADERS)
+          .delete("/#{OmniAI::OpenAI::Client::VERSION}/assistants/#{id}")
+
+        raise HTTPError, response.flush unless response.status.ok?
+
+        response.parse
+      end
+
+      # @raise [HTTPError]
+      # @return [OmniAI::OpenAI::Assistant]
+      def save!
+        response = @client.connection
+          .accept(:json)
+          .headers(HEADERS)
+          .post("/#{OmniAI::OpenAI::Client::VERSION}/assistants#{"/#{@id}" if @id}", json: payload)
+        raise HTTPError, response.flush unless response.status.ok?
+
+        parse(data: response.parse)
+        self
+      end
+
+      # @raise [OmniAI::Error]
+      # @return [OmniAI::OpenAI::Assistant]
+      def destroy!
+        raise OmniAI::Error, 'cannot destroy a non-persisted assistant' unless @id
+
+        data = self.class.destroy!(id: @id, client: @client)
+        @deleted = data['deleted']
+        self
+      end
+
+      private
+
+      class << self
+        private
+
+        # @param data [Hash] required
+        # @param client [OmniAI::OpenAI::Client] required
+        # @return [OmniAI::OpenAI::Assistant]
+        def parse(data:, client: Client.new)
+          new(
+            client:,
+            id: data['id'],
+            name: data['name'],
+            model: data['model'],
+            description: data['description'],
+            instructions: data['instructions'],
+            metadata: data['metadata'],
+            tools: data['tools']
+          )
+        end
+      end
+
+      # @param data [Hash] required
+      # @return [OmniAI::OpenAI::Assistant]
+      def parse(data:)
+        @id = data['id']
+        @name = data['name']
+        @model = data['model']
+        @description = data['description']
+        @instructions = data['instructions']
+        @metadata = data['metadata']
+        @tools = data['tools']
+      end
+
+      # @return [Hash]
+      def payload
+        {
+          name: @name,
+          model: @model,
+          description: @description,
+          instructions: @instructions,
+          metadata: @metadata,
+          tools: @tools,
+        }.compact
+      end
+    end
+  end
+end

data/lib/omniai/openai/assistants.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI scope for establishing assistants.
+    class Assistants
+      # @param client [OmniAI::OpenAI::Client] required
+      def initialize(client:)
+        @client = client
+      end
+
+      # @param id [String] required
+      def find(id:)
+        Assistant.find(id:, client: @client)
+      end
+
+      # @param limit [Integer] optional
+      def all(limit: nil)
+        Assistant.all(limit:, client: @client)
+      end
+
+      # @param id [String] required
+      def destroy!(id:)
+        Assistant.destroy!(id:, client: @client)
+      end
+
+      # @param name [String]
+      # @param model [String]
+      # @param description [String, nil] optional
+      # @param instructions [String,nil] optional
+      # @param metadata [Hash] optional
+      # @param tools [Array<Hash>] optional
+      def build(name: nil, description: nil, instructions: nil, model: Chat::Model, metadata: {}, tools: [])
+        Assistant.new(name:, model:, description:, instructions:, metadata:, tools:, client: @client)
+      end
+    end
+  end
+end

data/lib/omniai/openai/chat.rb

@@ -13,6 +13,8 @@ module OmniAI
         GPT_3_5_TURBO = 'gpt-3.5-turbo'
       end
 
+      DEFAULT_MODEL = Model::GPT_4O
+
       protected
 
       # @return [Hash]

data/lib/omniai/openai/client.rb

@@ -22,16 +22,19 @@ module OmniAI
     class Client < OmniAI::Client
       VERSION = 'v1'
 
-      # @param api_key [String] optional - defaults to `OmniAI::OpenAI.config.api_key`
-      # @param project_id [String] optional - defaults to `OmniAI::OpenAI.config.project`
-      # @param organization_id [String] optional - defaults to `OmniAI::OpenAI.config.organization`
-      # @param logger [Logger] optional - defaults to `OmniAI::OpenAI.config.logger`
+      # @param api_key [String, nil] optional - defaults to `OmniAI::OpenAI.config.api_key`
+      # @param host [String] optional - defaults to `OmniAI::OpenAI.config.host`
+      # @param project [String, nil] optional - defaults to `OmniAI::OpenAI.config.project`
+      # @param organization [String, nil] optional - defaults to `OmniAI::OpenAI.config.organization`
+      # @param logger [Logger, nil] optional - defaults to `OmniAI::OpenAI.config.logger`
+      # @param timeout [Integer, nil] optional - defaults to `OmniAI::OpenAI.config.timeout`
       def initialize(
         api_key: OmniAI::OpenAI.config.api_key,
+        host: OmniAI::OpenAI.config.host,
         organization: OmniAI::OpenAI.config.organization,
         project: OmniAI::OpenAI.config.project,
         logger: OmniAI::OpenAI.config.logger,
-        host: OmniAI::OpenAI.config.host
+        timeout: OmniAI::OpenAI.config.timeout
       )
         if api_key.nil? && host.eql?(Config::DEFAULT_HOST)
           raise(
@@ -40,7 +43,7 @@ module OmniAI
           )
         end
 
-        super(api_key:, host:, logger:)
+        super(api_key:, host:, logger:, timeout:)
 
         @organization = organization
         @project = project
@@ -49,7 +52,7 @@ module OmniAI
       # @return [HTTP::Client]
       def connection
         @connection ||= begin
-          http = HTTP.persistent(@host)
+          http = super
           http = http.auth("Bearer #{@api_key}") if @api_key
           http = http.headers('OpenAI-Organization': @organization) if @organization
           http = http.headers('OpenAI-Project': @project) if @project
@@ -66,7 +69,7 @@ module OmniAI
       # @param stream [Proc, nil] optional
       #
       # @return [OmniAI::Chat::Completion]
-      def chat(messages, model: Chat::Model::GPT_4O, temperature: nil, format: nil, stream: nil)
+      def chat(messages, model: Chat::DEFAULT_MODEL, temperature: nil, format: nil, stream: nil)
         Chat.process!(messages, model:, temperature:, format:, stream:, client: self)
       end
 
@@ -104,6 +107,21 @@ module OmniAI
       def speak(input, model: Speak::Model::TTS_1_HD, voice: Speak::Voice::ALLOY, speed: nil, format: nil, &)
         Speak.process!(input, model:, voice:, speed:, format:, client: self, &)
       end
+
+      # @return [OmniAI::OpenAI::Files]
+      def files
+        Files.new(client: self)
+      end
+
+      # @return [OmniAI::OpenAI::Assistants]
+      def assistants
+        Assistants.new(client: self)
+      end
+
+      # @return [OmniAI::OpenAI::Threads]
+      def threads
+        Threads.new(client: self)
+      end
     end
   end
 end

data/lib/omniai/openai/config.rb

@@ -2,21 +2,36 @@
 
 module OmniAI
   module OpenAI
-    # Configuration for managing the OpenAI `api_key` / `organization` / `project` / `logger`.
+    # Configuration for OpenAI.
     class Config < OmniAI::Config
-      attr_accessor :organization, :project, :chat_options, :transcribe_options, :speak_options
-
       DEFAULT_HOST = 'https://api.openai.com'
 
-      def initialize
-        super
-        @api_key = ENV.fetch('OPENAI_API_KEY', nil)
-        @organization = ENV.fetch('OPENAI_ORGANIZATION', nil)
-        @project = ENV.fetch('OPENAI_PROJECT', nil)
-        @host = ENV.fetch('OPENAI_HOST', DEFAULT_HOST)
-        @chat_options = {}
-        @transcribe_options = {}
-        @speak_options = {}
+      # @!attribute [rw] organization
+      #   @return [String, nil] passed as `OpenAI-Organization` if specified
+      attr_accessor :organization
+
+      # @!attribute [rw] project
+      #   @return [String, nil] passed as `OpenAI-Organization` if specified
+      attr_accessor :project
+
+      # @param api_key [String, nil] optional - defaults to `ENV['OPENAI_API_KEY']`
+      # @param host [String, nil] optional - defaults to ENV['OPENAI_HOST'] w/ fallback to `DEFAULT_HOST`
+      # @param organization [String, nil] optional - defaults to `ENV['OPENAI_ORGANIZATION']`
+      # @param project [String, nil] optional - defaults to `ENV['OPENAI_PROJECT']`
+      # @param logger [Logger, nil] optional
+      # @param timeout [Integer, Hash, nil] optional
+      def initialize(
+        api_key: ENV.fetch('OPENAI_API_KEY', nil),
+        host: ENV.fetch('OPENAI_HOST', DEFAULT_HOST),
+        organization: ENV.fetch('OPENAI_ORGANIZATION', nil),
+        project: ENV.fetch('OPENAI_PROJECT', nil),
+        logger: nil,
+        timeout: nil
+      )
+        super(api_key:, host:, logger:, timeout:)
+
+        @organization = organization
+        @project = project
       end
     end
   end