omniai-openai 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a95f906f1bf54382e8ace7ae6b1622ad22d2502a23c4804038b1ca66ff43086
-  data.tar.gz: 6694a63f7f76e2d41220a18e2ea852a19e956a8258761b71e9a0ec747197c9a9
+  metadata.gz: 7cb12222b6c13b368f2f25d55c66ff57e98114830a32bdd54ee82947aaf38674
+  data.tar.gz: 7600584957b977be573321a25a995f720fde9e9112fdd3e1b8676ce3d75461e0
 SHA512:
-  metadata.gz: c19cd98191bd1826f24af180bcf87e96670fc162c6555bf368e4eda9305cdf5fa465585c74764d55481181752f563a581b09e3b1583220df70d9b227861a51d8
-  data.tar.gz: b6eb2fdeb33dcf4dda02f2b608e13ae3cc29c687b0c9eb31bdecaf72d07548b0201c68efe3e40cd754b368d2b2f84813e5eeb207878dbc6355fe4a67a8308f3e
+  metadata.gz: 75f8bdbfff09e789058e15bf962efcbbe0146b3e522e5efc701ca1303ef734b68f6d19094502c2e8fd89f5db213687b6c5001967e3dfd1b46eaab060b4c4e4c0
+  data.tar.gz: 5b206397432e32277bda4767bad41707699607cf93e9a396570cbe78ab668f42b5c34c75f99d26d93cccd042b9c08359a899a4f375fabae7fc6c55a587515550

data/README.md

@@ -251,3 +251,204 @@ 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
+
+#### Using a File
+
+```ruby
+file = client.files.build(io: File.open('demo.pdf', 'wb'))
+file.save!
+```
+
+#### Using a Path
+
+```ruby
+file = client.files.build(io: 'demo.pdf'))
+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!
+```
+
+#### Polling a Run
+
+```ruby
+run.terminated? # false
+run.poll!
+run.terminated? # true
+run.status # 'cancelled' / 'failed' / 'completed' / 'expired'
+```
+
+#### 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: OmniAI::Chat::DEFAULT_MODEL,
+        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

@@ -69,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
 
@@ -107,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/file.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI file implementation.
+    class File
+      # @!attribute [rw] id
+      #   @return [String, nil]
+      attr_accessor :id
+
+      # @!attribute [rw] bytes
+      #   @return [Integer, nil]
+      attr_accessor :bytes
+
+      # @!attribute [rw] filename
+      #   @return [String, nil]
+      attr_accessor :filename
+
+      # @!attribute [rw] purpose
+      #   @return [String, nil]
+      attr_accessor :purpose
+
+      # @!attribute [rw] deleted
+      #   @return [Boolean, nil]
+      attr_accessor :deleted
+
+      module Purpose
+        ASSISTANTS = 'assistants'
+      end
+
+      # @param client [OmniAI::OpenAI::Client] optional
+      # @param io [IO] optional
+      # @param id [String] optional
+      # @param bytes [Integer] optional
+      # @param filename [String] optional
+      # @param purpose [String] optional
+      def initialize(
+        client: Client.new,
+        io: nil,
+        id: nil,
+        bytes: nil,
+        filename: nil,
+        purpose: Purpose::ASSISTANTS
+      )
+        @client = client
+        @io = io
+        @id = id
+        @bytes = bytes
+        @filename = filename
+        @purpose = purpose
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class.name} id=#{@id.inspect} filename=#{@filename.inspect}>"
+      end
+
+      # @raise [OmniAI::Error]
+      # @yield [String]
+      def content(&)
+        raise OmniAI::Error, 'cannot fetch content without ID' unless @id
+
+        response = @client.connection
+          .get("/#{OmniAI::OpenAI::Client::VERSION}/files/#{@id}/content")
+
+        raise HTTPError, response.flush unless response.status.ok?
+
+        response.body.each(&)
+      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)
+          .get("/#{OmniAI::OpenAI::Client::VERSION}/files/#{id}")
+
+        raise HTTPError, response.flush unless response.status.ok?
+
+        parse(data: response.parse)
+      end
+
+      # @param client [OmniAI::OpenAI::Client] optional
+      # @return [Array<OmniAI::OpenAI::File>]
+      def self.all(client: Client.new)
+        response = client.connection
+          .accept(:json)
+          .get("/#{OmniAI::OpenAI::Client::VERSION}/files")
+
+        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 [Hash]
+      def self.destroy!(id:, client: Client.new)
+        response = client.connection
+          .accept(:json)
+          .delete("/#{OmniAI::OpenAI::Client::VERSION}/files/#{id}")
+
+        raise HTTPError, response.flush unless response.status.ok?
+
+        response.parse
+      end
+
+      # @raise [HTTPError]
+      # @return [OmniAI::OpenAI::Assistant]
+      def save!
+        raise OmniAI::Error, 'cannot save a file without IO' unless @io
+
+        response = @client.connection
+          .accept(:json)
+          .post("/#{OmniAI::OpenAI::Client::VERSION}/files", form: 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 w/o ID' unless @id
+
+        data = self.class.destroy!(id: @id, client: @client)
+        @deleted = data['deleted']
+        self
+      end
+
+      private
+
+      # @return [Hash]
+      def payload
+        {
+          file: HTTP::FormData::File.new(@io),
+          purpose: @purpose,
+        }
+      end
+
+      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'],
+            bytes: data['bytes'],
+            filename: data['filename'],
+            purpose: data['purpose']
+          )
+        end
+      end
+
+      # @param data [Hash] required
+      # @return [OmniAI::OpenAI::Assistant]
+      def parse(data:)
+        @id = data['id']
+        @bytes = data['bytes']
+        @filename = data['filename']
+        @purpose = data['purpose']
+      end
+    end
+  end
+end

data/lib/omniai/openai/files.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module OpenAI
+    # An OpenAI scope for establishing files.
+    class Files
+      # @param client [OmniAI::OpenAI::Client] required
+      def initialize(client:)
+        @client = client
+      end
+
+      # @raise [OmniAI::Error]
+      #
+      # @param id [String] required
+      #
+      # @return [OmniAI::OpenAI::File]
+      def find(id:)
+        File.find(id:, client: @client)
+      end
+
+      # @raise [OmniAI::Error]
+      #
+      # @return [Array<OmniAI::OpenAI::File>]
+      def all
+        File.all(client: @client)
+      end
+
+      # @raise [OmniAI::Error]
+      #
+      # @param id [String] required
+      def destroy!(id:)
+        File.destroy!(id:, client: @client)
+      end
+
+      # @param io [IO] optional
+      # @param purpose [String] optional
+      #
+      # @return [OmniAI::OpenAI::File]
+      def build(io: nil, purpose: File::Purpose::ASSISTANTS)
+        File.new(io:, purpose:, client: @client)
+      end
+    end
+  end
+end