asimov 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71726c0c67788a649dc1c01ca5763ab13d41f31118d6f8b093795a3a92e0ca8
-  data.tar.gz: 5d5eb6dd51099aadf9418ff1c11c7ea6688a06a5e07b5a39bd376a48538ac79a
+  metadata.gz: 7d49b0bc867c3e318501548e7fcf45a3dd48bc469b05f959b5839144e3f9d472
+  data.tar.gz: 1193a9a5eea75c3d3b57d09ca10ccd5e50ee01d44ecce648c985ac2bcfd5cded
 SHA512:
-  metadata.gz: b20449b89964c2b2b77de68726aef47bc09e65871ba04c80ad2f607e58bc5b6322ff6106c801f01ef68377056a55010d74e6481f883ad57793eca5366a438acd
-  data.tar.gz: fdfe13acb265341e7c568874a8696ce520b6da8fbdc77ae694b3ba56deb97d44a65aac82935a3ad3f356258aa0375358349540c17cd54bfd0f9a3a746d40b807
+  metadata.gz: 349259c93c833021ebfc46f7912f8c36109dc51693c3828972d263282f514adee94b5416d9e89c2dc1cc1d868d01cabce20ef1df01e83279eac80d156b1ded61
+  data.tar.gz: 67deac4b3306ffdc5ab36aa49b7ab66093dc4938131b3264ce2ef2cd6a628840cd04d3474f39fe7bc1f70dc5c0d9dba7bd136c28c46c58b776ff2494ae825030

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [1.1.0] - 2023-03-01
+
+### Added
+
+- Made API base URI configurable to support services that proxy API calls (like Helicone)
+- Added support for the chat and audio endpoints
+
 ## [1.0.0] - 2023-01-24
 
 This version has complete coverage of the OpenAI API (except for stream: true behavior), has

data/Gemfile

@@ -3,9 +3,11 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
+  gem "faker"
   gem "rake", "~> 13.0"
   gem "rspec", "~> 3.12"
   gem "rubocop", "~> 1.44"
+  gem "rubocop-performance"
   gem "rubocop-rake"
   gem "rubocop-rspec"
   gem "simplecov", require: false

data/lib/asimov/api_v1/audio.rb

@@ -0,0 +1,52 @@
+require_relative "../utils/chat_messages_validator"
+
+module Asimov
+  module ApiV1
+    ##
+    # Class interface for API methods in the "/audio" URI subspace.
+    ##
+    class Audio < Base
+      RESOURCE = "audio".freeze
+
+      ##
+      # Creates a transcription request with the specified parameters.
+      #
+      # @param [String] model the model to use for the completion
+      # @param [Hash] parameters the set of parameters being passed to the API
+      ##
+      def create_transcription(file:, model:, parameters: {})
+        raise MissingRequiredParameterError.new(:model) unless model
+
+        rest_create_w_multipart_params(resource: [RESOURCE, "transcriptions"],
+                                       parameters:
+                                       open_file(parameters.merge({
+                                                                    file: file, model: model
+                                                                  })))
+      end
+
+      ##
+      # Creates a transcription request with the specified parameters.
+      #
+      # @param [String] model the model to use for the completion
+      # @param [Hash] parameters the set of parameters being passed to the API
+      ##
+      def create_translation(file:, model:, parameters: {})
+        raise MissingRequiredParameterError.new(:model) unless model
+
+        rest_create_w_multipart_params(resource: [RESOURCE, "translations"],
+                                       parameters:
+                                       open_file(parameters.merge({
+                                                                    file: file, model: model
+                                                                  })))
+      end
+
+      private
+
+      def open_file(parameters)
+        raise MissingRequiredParameterError.new(:file) unless parameters[:file]
+
+        parameters.merge(file: Utils::FileManager.open(parameters[:file]))
+      end
+    end
+  end
+end

data/lib/asimov/api_v1/base.rb

@@ -15,53 +15,67 @@ module Asimov
       extend Forwardable
       include HTTParty
 
-      base_uri "https://api.openai.com/v1"
-
       def initialize(client: nil)
         @client = client
       end
-      def_delegators :@client, :headers, :request_options
+      def_delegators :@client, :headers, :request_options, :openai_api_base
 
       ##
-      # Executes an HTTP DELETE on the specified path.
+      # Executes a REST index for the specified resource
       #
-      # @param [String] path the URI (when combined with the
-      # base_uri) against which the DELETE is executed.
+      # @param [String] resource the pluralized resource name
       ##
-      def http_delete(path:)
+      def rest_index(resource:)
+        wrap_response_with_error_handling do
+          self.class.get(
+            absolute_path("/#{Array(resource).join('/')}"),
+            { headers: headers }.merge!(request_options)
+          )
+        end
+      end
+
+      ##
+      # Executes a REST delete on the specified resource.
+      #
+      # @param [String] resource the pluralized resource name
+      # @param [String] id the id of the resource to delete
+      ##
+      def rest_delete(resource:, id:)
         wrap_response_with_error_handling do
           self.class.delete(
-            path,
+            absolute_path("/#{resource}/#{CGI.escape(id)}"),
             { headers: headers }.merge!(request_options)
           )
         end
       end
 
       ##
-      # Executes an HTTP GET on the specified path.
+      # Executes a REST get on the specified resource.
       #
-      # @param [String] path the URI (when combined with the
-      # base_uri) against which the GET is executed.
+      # @param [String] resource the pluralized resource name
+      # @param [String] id the id of the resource get
       ##
-      def http_get(path:)
+      def rest_get(resource:, id:)
         wrap_response_with_error_handling do
           self.class.get(
-            path,
+            absolute_path("/#{resource}/#{CGI.escape(id)}"),
             { headers: headers }.merge!(request_options)
           )
         end
       end
 
       ##
-      # Executes an HTTP POST with JSON-encoded parameters on the specified path.
+      # Executes a REST create with JSON-encoded parameters for the specified
+      # resource.
       #
-      # @param [String] path the URI (when combined with the
-      # base_uri) against which the POST is executed.
+      # @param [String] the resource to be created.
+      # @param [Hash] parameters the parameters to include with the request
+      # to create the resource
       ##
-      def json_post(path:, parameters:)
+      def rest_create_w_json_params(resource:, parameters:)
         wrap_response_with_error_handling do
           self.class.post(
-            path,
+            absolute_path("/#{Array(resource).join('/')}"),
             { headers: headers,
               body: parameters&.to_json }.merge!(request_options)
           )
@@ -69,15 +83,17 @@ module Asimov
       end
 
       ##
-      # Executes an HTTP POST with multipart encoded parameters on the specified path.
+      # Executes a REST create with multipart-encoded parameters for the specified
+      # resource.
       #
-      # @param [String] path the URI (when combined with the
-      # base_uri) against which the POST is executed.
+      # @param [String] the resource to be created.
+      # @param [Hash] parameters the optional parameters to include with the request
+      # to create the resource
       ##
-      def multipart_post(path:, parameters: nil)
+      def rest_create_w_multipart_params(resource:, parameters: nil)
         wrap_response_with_error_handling do
           self.class.post(
-            path,
+            absolute_path("/#{Array(resource).join('/')}"),
             { headers: headers("multipart/form-data"),
               body: parameters }.merge!(request_options)
           )
@@ -85,15 +101,14 @@ module Asimov
       end
 
       ##
-      # Executes an HTTP GET on the specified path, streaming the resulting body
+      # Executes an REST get on the specified path, streaming the resulting body
       # to the writer in case of success.
       #
-      # @param [String] path the URI (when combined with the
-      # base_uri) against which the POST is executed.
+      # @param [Array] resource the resource path elements as an array
       # @param [Writer] writer an object, typically a File, that responds to a `write` method
       ##
-      def http_streamed_download(path:, writer:)
-        self.class.get(path,
+      def rest_get_streamed_download(resource:, writer:)
+        self.class.get(absolute_path("/#{Array(resource).join('/')}"),
                        { headers: headers,
                          stream_body: true }.merge!(request_options)) do |fragment|
           fragment.code == 200 ? writer.write(fragment) : check_for_api_error(fragment)
@@ -105,6 +120,10 @@ module Asimov
 
       private
 
+      def absolute_path(path)
+        "#{openai_api_base}#{path}"
+      end
+
       def wrap_response_with_error_handling
         resp = begin
           yield

data/lib/asimov/api_v1/chat.rb

@@ -0,0 +1,29 @@
+require_relative "../utils/chat_messages_validator"
+
+module Asimov
+  module ApiV1
+    ##
+    # Class interface for API methods in the "/chat" URI subspace.
+    ##
+    class Chat < Base
+      RESOURCE = "chat".freeze
+
+      ##
+      # Creates a completion request with the specified parameters.
+      #
+      # @param [String] model the model to use for the completion
+      # @param [Hash] parameters the set of parameters being passed to the API
+      ##
+      def create_completions(model:, messages:, parameters: {})
+        raise MissingRequiredParameterError.new(:model) unless model
+        raise MissingRequiredParameterError.new(:messages) unless messages
+        raise StreamingResponseNotSupportedError if parameters[:stream]
+
+        messages = Utils::ChatMessagesValidator.validate_and_normalize(messages)
+        rest_create_w_json_params(resource: [RESOURCE, "completions"],
+                                  parameters: parameters.merge({ model: model,
+                                                                 messages: messages }))
+      end
+    end
+  end
+end

data/lib/asimov/api_v1/completions.rb

@@ -5,7 +5,7 @@ module Asimov
     ##
     class Completions < Base
       ##
-      # Calls the /completions POST endpoint with the specified parameters.
+      # Creates a completion request with the specified parameters.
       #
       # @param [String] model the model to use for the completion
       # @param [Hash] parameters the set of parameters being passed to the API
@@ -14,7 +14,8 @@ module Asimov
         raise MissingRequiredParameterError.new(:model) unless model
         raise StreamingResponseNotSupportedError if parameters[:stream]
 
-        json_post(path: "/completions", parameters: parameters.merge({ model: model }))
+        rest_create_w_json_params(resource: "completions",
+                                  parameters: parameters.merge({ model: model }))
       end
     end
   end

data/lib/asimov/api_v1/edits.rb

@@ -5,7 +5,7 @@ module Asimov
     ##
     class Edits < Base
       ##
-      # Calls the /edits POST endpoint with the specified parameters.
+      # Creates an edit resource with the specified parameters.
       #
       # @param [Hash] parameters the set of parameters being passed to the API
       ##
@@ -13,9 +13,9 @@ module Asimov
         raise MissingRequiredParameterError.new(:model) unless model
         raise MissingRequiredParameterError.new(:instruction) unless instruction
 
-        json_post(path: "/edits",
-                  parameters: parameters.merge({ model: model,
-                                                 instruction: instruction }))
+        rest_create_w_json_params(resource: "edits",
+                                  parameters: parameters.merge({ model: model,
+                                                                 instruction: instruction }))
       end
     end
   end

data/lib/asimov/api_v1/embeddings.rb

@@ -5,15 +5,21 @@ module Asimov
     ##
     class Embeddings < Base
       ##
-      # Calls the /embeddings POST endpoint with the specified parameters.
+      # Creates an embedding resource with the specified parameters.
       #
+      # @param [String] model the id for the model used to create the embedding
+      # @param [String] parameters the (optional) additional parameters being
+      # provided to inform embedding creation.
       # @param [Hash] parameters the set of parameters being passed to the API
       ##
       def create(model:, input:, parameters: {})
         raise MissingRequiredParameterError.new(:model) unless model
         raise MissingRequiredParameterError.new(:input) unless input
 
-        json_post(path: "/embeddings", parameters: parameters.merge({ model: model, input: input }))
+        rest_create_w_json_params(resource: "embeddings",
+                                  parameters: parameters.merge({
+                                                                 model: model, input: input
+                                                               }))
       end
     end
   end

data/lib/asimov/api_v1/files.rb

@@ -10,14 +10,14 @@ module Asimov
     # Class interface for API methods in the "/files" URI subspace.
     ##
     class Files < Base
-      URI_PREFIX = "/files".freeze
-      private_constant :URI_PREFIX
+      RESOURCE = "files".freeze
+      private_constant :RESOURCE
 
       ##
       # Lists files that have been uploaded to OpenAI
       ##
       def list
-        http_get(path: URI_PREFIX)
+        rest_index(resource: RESOURCE)
       end
 
       ##
@@ -32,8 +32,8 @@ module Asimov
 
         validate(file, purpose)
 
-        multipart_post(
-          path: URI_PREFIX,
+        rest_create_w_multipart_params(
+          resource: RESOURCE,
           parameters: parameters.merge(file: Utils::FileManager.open(file), purpose: purpose)
         )
       end
@@ -44,7 +44,7 @@ module Asimov
       # @param [String] file_id the id of the file to be retrieved
       ##
       def retrieve(file_id:)
-        http_get(path: "#{URI_PREFIX}/#{file_id}")
+        rest_get(resource: RESOURCE, id: file_id)
       end
 
       ##
@@ -53,7 +53,7 @@ module Asimov
       # @param [String] file_id the id of the file to be deleted
       ##
       def delete(file_id:)
-        http_delete(path: "#{URI_PREFIX}/#{file_id}")
+        rest_delete(resource: RESOURCE, id: file_id)
       end
 
       ##
@@ -65,7 +65,7 @@ module Asimov
       # as it is received from the API
       ##
       def content(file_id:, writer:)
-        http_streamed_download(path: "#{URI_PREFIX}/#{file_id}/content", writer: writer)
+        rest_get_streamed_download(resource: [RESOURCE, file_id, "content"], writer: writer)
       end
 
       private

data/lib/asimov/api_v1/finetunes.rb

@@ -4,14 +4,14 @@ module Asimov
     # Class interface for API methods in the "/fine-tunes" URI subspace.
     ##
     class Finetunes < Base
-      URI_PREFIX = "/fine-tunes".freeze
-      private_constant :URI_PREFIX
+      RESOURCE = "fine-tunes".freeze
+      private_constant :RESOURCE
 
       ##
       # Lists the set of fine-tuning jobs for this API key and (optionally) organization.
       ##
       def list
-        http_get(path: URI_PREFIX)
+        rest_index(resource: RESOURCE)
       end
 
       ##
@@ -23,7 +23,8 @@ module Asimov
       def create(training_file:, parameters: {})
         raise MissingRequiredParameterError.new(:training_file) unless training_file
 
-        json_post(path: URI_PREFIX, parameters: parameters.merge(training_file: training_file))
+        rest_create_w_json_params(resource: RESOURCE,
+                                  parameters: parameters.merge(training_file: training_file))
       end
 
       ##
@@ -32,7 +33,7 @@ module Asimov
       # @param [String] fine_tune_id the id of fine tuning job
       ##
       def retrieve(fine_tune_id:)
-        http_get(path: "#{URI_PREFIX}/#{fine_tune_id}")
+        rest_get(resource: RESOURCE, id: fine_tune_id)
       end
 
       ##
@@ -41,7 +42,7 @@ module Asimov
       # @param [String] fine_tune_id the id of fine tuning job
       ##
       def cancel(fine_tune_id:)
-        multipart_post(path: "#{URI_PREFIX}/#{fine_tune_id}/cancel")
+        rest_create_w_multipart_params(resource: [RESOURCE, fine_tune_id, "cancel"])
       end
 
       ##
@@ -50,7 +51,7 @@ module Asimov
       # @param [String] fine_tune_id the id of fine tuning job
       ##
       def list_events(fine_tune_id:)
-        http_get(path: "#{URI_PREFIX}/#{fine_tune_id}/events")
+        rest_index(resource: [RESOURCE, fine_tune_id, "events"])
       end
     end
   end

data/lib/asimov/api_v1/images.rb

@@ -6,8 +6,8 @@ module Asimov
     # Class interface for API methods in the "/images" URI subspace.
     ##
     class Images < Base
-      URI_PREFIX = "/images".freeze
-      private_constant :URI_PREFIX
+      RESOURCE = "images".freeze
+      private_constant :RESOURCE
 
       ##
       # Creates an image using the specified prompt.
@@ -18,8 +18,8 @@ module Asimov
       def create(prompt:, parameters: {})
         raise MissingRequiredParameterError.new(:prompt) unless prompt
 
-        json_post(path: "#{URI_PREFIX}/generations",
-                  parameters: parameters.merge({ prompt: prompt }))
+        rest_create_w_json_params(resource: [RESOURCE, "generations"],
+                                  parameters: parameters.merge({ prompt: prompt }))
       end
 
       ##
@@ -32,8 +32,11 @@ module Asimov
       def create_edit(image:, prompt:, parameters: {})
         raise MissingRequiredParameterError.new(:prompt) unless prompt
 
-        multipart_post(path: "#{URI_PREFIX}/edits",
-                       parameters: open_files(parameters.merge({ image: image, prompt: prompt })))
+        rest_create_w_multipart_params(resource: [RESOURCE, "edits"],
+                                       parameters: open_files(parameters.merge({
+                                                                                 image: image,
+                                                                                 prompt: prompt
+                                                                               })))
       end
 
       ##
@@ -44,8 +47,8 @@ module Asimov
       # @option parameters [String] :mask mask file name or a File-like object
       ##
       def create_variation(image:, parameters: {})
-        multipart_post(path: "#{URI_PREFIX}/variations",
-                       parameters: open_files(parameters.merge({ image: image })))
+        rest_create_w_multipart_params(resource: [RESOURCE, "variations"],
+                                       parameters: open_files(parameters.merge({ image: image })))
       end
 
       private
@@ -54,7 +57,7 @@ module Asimov
         raise MissingRequiredParameterError.new(:image) unless parameters[:image]
 
         parameters = parameters.merge(image: Utils::FileManager.open(parameters[:image]))
-        parameters.merge!(mask: Utils::FileManager.open(parameters[:mask])) if parameters[:mask]
+        parameters[:mask] = Utils::FileManager.open(parameters[:mask]) if parameters[:mask]
         parameters
       end
     end

data/lib/asimov/api_v1/models.rb

@@ -4,15 +4,15 @@ module Asimov
     # Class interface for API methods in the "/models" URI subspace.
     ##
     class Models < Base
-      URI_PREFIX = "/models".freeze
-      private_constant :URI_PREFIX
+      RESOURCE = "models".freeze
+      private_constant :RESOURCE
 
       ##
       # Lists the models accessible to this combination of OpenAI API
       # key and organization id.
       ##
       def list
-        http_get(path: URI_PREFIX)
+        rest_index(resource: RESOURCE)
       end
 
       ##
@@ -22,7 +22,7 @@ module Asimov
       # @param [String] model_id the id of the model to be retrieved
       ##
       def retrieve(model_id:)
-        http_get(path: "#{URI_PREFIX}/#{model_id}")
+        rest_get(resource: RESOURCE, id: model_id)
       end
 
       ##
@@ -32,7 +32,7 @@ module Asimov
       # @param [String] model_id the id of the model to be deleted
       ##
       def delete(model_id:)
-        http_delete(path: "#{URI_PREFIX}/#{model_id}")
+        rest_delete(resource: RESOURCE, id: model_id)
       end
     end
   end

data/lib/asimov/api_v1/moderations.rb

@@ -13,7 +13,8 @@ module Asimov
       def create(input:, parameters: {})
         raise MissingRequiredParameterError.new(:input) unless input
 
-        json_post(path: "/moderations", parameters: parameters.merge({ input: input }))
+        rest_create_w_json_params(resource: "moderations",
+                                  parameters: parameters.merge({ input: input }))
       end
     end
   end

data/lib/asimov/client.rb

@@ -3,6 +3,8 @@ require "httparty"
 require_relative "headers_factory"
 require_relative "utils/request_options_validator"
 require_relative "api_v1/base"
+require_relative "api_v1/audio"
+require_relative "api_v1/chat"
 require_relative "api_v1/completions"
 require_relative "api_v1/edits"
 require_relative "api_v1/embeddings"
@@ -20,7 +22,7 @@ module Asimov
   class Client
     extend Forwardable
 
-    attr_reader :api_key, :organization_id, :api_version, :request_options
+    attr_reader :api_key, :organization_id, :api_version, :request_options, :openai_api_base
 
     ##
     # Creates a new Asimov::Client. Includes several optional named parameters:
@@ -29,17 +31,36 @@ module Asimov
     #           defaults to the application-wide configuration
     # organization_id - The OpenAI organization identifier that this Asimov::Client instance
     #                   will use. If unspecified, defaults to the application-wide configuration.
+    # request_options - HTTParty request options that will be passed to the underlying network
+    #                   client.  Merges (and overrides) global configuration value.
+    # openai_api_base - Custom base URI for the API calls made by this client. Defaults to global
+    #            configuration value.
     ##
     def initialize(api_key: nil, organization_id: HeadersFactory::NULL_ORGANIZATION_ID,
-                   request_options: {})
+                   request_options: {}, openai_api_base: nil)
       @headers_factory = HeadersFactory.new(api_key,
                                             organization_id)
       @request_options = Asimov.configuration.request_options
                                .merge(Utils::RequestOptionsValidator.validate(request_options))
                                .freeze
+      initialize_openai_api_base(openai_api_base)
     end
     def_delegators :@headers_factory, :api_key, :organization_id, :headers
 
+    ##
+    # Use the audio method to access API calls in the /audio URI space.
+    ##
+    def audio
+      @audio ||= Asimov::ApiV1::Audio.new(client: self)
+    end
+
+    ##
+    # Use the chat method to access API calls in the /chat URI space.
+    ##
+    def chat
+      @chat ||= Asimov::ApiV1::Chat.new(client: self)
+    end
+
     ##
     # Use the completions method to access API calls in the /completions URI space.
     ##
@@ -95,5 +116,17 @@ module Asimov
     def moderations
       @moderations ||= Asimov::ApiV1::Moderations.new(client: self)
     end
+
+    private
+
+    def initialize_openai_api_base(openai_api_base)
+      @openai_api_base = openai_api_base || Asimov.configuration.openai_api_base
+      if @openai_api_base
+        @openai_api_base = HTTParty.normalize_base_uri(@openai_api_base)
+      else
+        raise Asimov::MissingBaseUriError,
+              "No API Base URI was provided for this client."
+      end
+    end
   end
 end

data/lib/asimov/configuration.rb

@@ -9,7 +9,9 @@ module Asimov
   class Configuration
     attr_accessor :api_key, :organization_id
 
-    attr_reader :request_options
+    attr_reader :request_options, :openai_api_base
+
+    DEFAULT_OPENAI_BASE_URI = "https://api.openai.com/v1".freeze
 
     ##
     # Initializes the Configuration object and resets it to default values.
@@ -25,6 +27,15 @@ module Asimov
       @api_key = nil
       @organization_id = nil
       @request_options = {}
+      @openai_api_base = DEFAULT_OPENAI_BASE_URI
+    end
+
+    ##
+    # Sets the openai_api_base on the Configuration.  Typically not invoked
+    # directly, but rather through use of `Asimov.configure`.
+    ##
+    def openai_api_base=(val)
+      @openai_api_base = val ? HTTParty.normalize_base_uri(val) : nil
     end
 
     ##

data/lib/asimov/error.rb

@@ -15,6 +15,12 @@ module Asimov
   ##
   class MissingApiKeyError < ConfigurationError; end
 
+  ##
+  # Error that occurs when there is no configured
+  # base URI for a newly created Asimov::Client.
+  ##
+  class MissingBaseUriError < ConfigurationError; end
+
   ##
   # Errors that occur when making an API request.  They
   # can occur either through local validation or
@@ -136,6 +142,12 @@ module Asimov
   ##
   class InvalidClassificationError < FileDataError; end
 
+  ##
+  # Error that occurs when the provided chat messages
+  # parameter is not valid.
+  ##
+  class InvalidChatMessagesError < RequestError; end
+
   ##
   # Error that occurs when an invalid value is provided
   # for an expected parameter in a request.

data/lib/asimov/utils/chat_messages_validator.rb

@@ -0,0 +1,63 @@
+module Asimov
+  module Utils
+    ##
+    # Validator for OpenAI's chat message format
+    ##
+    class ChatMessagesValidator
+      def self.validate_and_normalize(messages)
+        new.validate(messages)
+      end
+
+      def validate(messages)
+        raise InvalidChatMessagesError, "Chat messages cannot be nil." if messages.nil?
+
+        unless messages.is_a?(Array)
+          raise InvalidChatMessagesError,
+                "Chat messages must be an array."
+        end
+
+        messages.map do |message|
+          validate_message(normalize_parsed(message))
+        end
+      rescue JSON::ParserError
+        raise InvalidChatMessagesError, "Chat messages must be valid JSON."
+      end
+
+      def validate_message(message)
+        raise InvalidChatMessagesError, "Chat messages must be hashes." unless message.is_a?(Hash)
+
+        validate_role(message["role"])
+
+        content = message["content"]
+        raise InvalidChatMessagesError, "Chat messages must have content." if content.nil?
+
+        validate_keys(message)
+        message
+      end
+
+      def validate_keys(json)
+        additional_keys = json.keys - %w[role content]
+        return if additional_keys.empty?
+
+        raise InvalidChatMessagesError,
+              "Chat messages must not have additional keys - #{additional_keys.join(', ')}."
+      end
+
+      ALLOWED_ROLES = %w[assistant system user].freeze
+      def validate_role(role)
+        raise InvalidChatMessagesError, "Chat messages must have a role." if role.nil?
+
+        return true if ALLOWED_ROLES.include?(role)
+
+        raise InvalidChatMessagesError,
+              "The value '#{role}' is not a valid role for a chat message."
+      end
+
+      def normalize_parsed(message)
+        return message if message.is_a?(String)
+
+        JSON.parse(message.respond_to?(:to_json) ? message.to_json : message)
+      end
+    end
+  end
+end

data/lib/asimov/version.rb

@@ -1,4 +1,4 @@
 module Asimov
   # Current gem version
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asimov
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter M. Goldstein
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,7 +44,9 @@ files:
 - README.md
 - lib/asimov.rb
 - lib/asimov/api_v1/api_error_translator.rb
+- lib/asimov/api_v1/audio.rb
 - lib/asimov/api_v1/base.rb
+- lib/asimov/api_v1/chat.rb
 - lib/asimov/api_v1/completions.rb
 - lib/asimov/api_v1/edits.rb
 - lib/asimov/api_v1/embeddings.rb
@@ -58,6 +60,7 @@ files:
 - lib/asimov/configuration.rb
 - lib/asimov/error.rb
 - lib/asimov/headers_factory.rb
+- lib/asimov/utils/chat_messages_validator.rb
 - lib/asimov/utils/classifications_file_validator.rb
 - lib/asimov/utils/file_manager.rb
 - lib/asimov/utils/jsonl_validator.rb
@@ -88,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A Ruby client for the OpenAI API support for multiple API configurations