azure_openai_client 0.0.1 → 0.0.2

data/lib/azure_openai_client/models/completions_create_request_prompt.rb

@@ -0,0 +1,105 @@
+=begin
+#Azure OpenAI Service API
+
+#Azure OpenAI APIs for completions and search
+
+The version of the OpenAPI document: 2023-05-15
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module AzureOpenaiClient
+  # The prompt(s) to generate completions for, encoded as a string or array of strings. Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. Maximum allowed size of string list is 2048.
+  module CompletionsCreateRequestPrompt
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Array<String>',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when 'Boolean'
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when 'Float'
+            return data if data.instance_of?(Float)
+          when 'Integer'
+            return data if data.instance_of?(Integer)
+          when 'Time'
+            return Time.parse(data)
+          when 'Date'
+            return Date.parse(data)
+          when 'String'
+            return data if data.instance_of?(String)
+          when 'Object' # "type: object"
+            return data if data.instance_of?(Hash)
+          when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+          when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+          else # model
+            const = AzureOpenaiClient.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of) # nested oneOf model
+                model = const.build(data)
+                return model if model
+              else
+                # raise if data contains keys that are not known to the model
+                raise unless (data.keys - const.acceptable_attributes).empty?
+                model = const.build_from_hash(data)
+                return model if model && model.valid?
+              end
+            end
+          end
+
+          raise # if no match by now, raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+    end
+  end
+end

data/lib/azure_openai_client/models/completions_create_request_stop.rb

@@ -0,0 +1,105 @@
+=begin
+#Azure OpenAI Service API
+
+#Azure OpenAI APIs for completions and search
+
+The version of the OpenAPI document: 2023-05-15
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module AzureOpenaiClient
+  # Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
+  module CompletionsCreateRequestStop
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Array<String>',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when 'Boolean'
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when 'Float'
+            return data if data.instance_of?(Float)
+          when 'Integer'
+            return data if data.instance_of?(Integer)
+          when 'Time'
+            return Time.parse(data)
+          when 'Date'
+            return Date.parse(data)
+          when 'String'
+            return data if data.instance_of?(String)
+          when 'Object' # "type: object"
+            return data if data.instance_of?(Hash)
+          when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+          when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+          else # model
+            const = AzureOpenaiClient.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of) # nested oneOf model
+                model = const.build(data)
+                return model if model
+              else
+                # raise if data contains keys that are not known to the model
+                raise unless (data.keys - const.acceptable_attributes).empty?
+                model = const.build_from_hash(data)
+                return model if model && model.valid?
+              end
+            end
+          end
+
+          raise # if no match by now, raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+    end
+  end
+end

data/lib/azure_openai_client/models/{inline_response_200_1.rb → embeddings_create200_response.rb}

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
 =begin
 #Azure OpenAI Service API
 
 #Azure OpenAI APIs for completions and search
 
-OpenAPI spec version: 2023-05-15
+The version of the OpenAPI document: 2023-05-15
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.42
 =end
 
 require 'date'
+require 'time'
 
 module AzureOpenaiClient
-  class InlineResponse2001
+  class EmbeddingsCreate200Response
     attr_accessor :object
 
     attr_accessor :model
@@ -26,20 +26,25 @@ module AzureOpenaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        'object': :'object',
-        'model': :'model',
-        'data': :'data',
-        'usage': :'usage'
+        :'object' => :'object',
+        :'model' => :'model',
+        :'data' => :'data',
+        :'usage' => :'usage'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        'object': :'Object',
-        'model': :'Object',
-        'data': :'Object',
-        'usage': :'Object'
+        :'object' => :'String',
+        :'model' => :'String',
+        :'data' => :'Array<EmbeddingsCreate200ResponseDataInner>',
+        :'usage' => :'EmbeddingsCreate200ResponseUsage'
       }
     end
 
@@ -53,13 +58,13 @@ module AzureOpenaiClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::InlineResponse2001` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::EmbeddingsCreate200Response` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `AzureOpenaiClient::InlineResponse2001`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AzureOpenaiClient::EmbeddingsCreate200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -151,8 +156,11 @@ module AzureOpenaiClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -160,8 +168,6 @@ module AzureOpenaiClient
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
         end
       end
 
@@ -174,8 +180,8 @@ module AzureOpenaiClient
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -205,7 +211,9 @@ module AzureOpenaiClient
           end
         end
       else # model
-        AzureOpenaiClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = AzureOpenaiClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/azure_openai_client/models/{inline_response_200_1_data.rb → embeddings_create200_response_data_inner.rb}

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
 =begin
 #Azure OpenAI Service API
 
 #Azure OpenAI APIs for completions and search
 
-OpenAPI spec version: 2023-05-15
+The version of the OpenAPI document: 2023-05-15
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.42
 =end
 
 require 'date'
+require 'time'
 
 module AzureOpenaiClient
-  class InlineResponse2001Data
+  class EmbeddingsCreate200ResponseDataInner
     attr_accessor :index
 
     attr_accessor :object
@@ -24,18 +24,23 @@ module AzureOpenaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        'index': :'index',
-        'object': :'object',
-        'embedding': :'embedding'
+        :'index' => :'index',
+        :'object' => :'object',
+        :'embedding' => :'embedding'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        'index': :'Object',
-        'object': :'Object',
-        'embedding': :'Object'
+        :'index' => :'Integer',
+        :'object' => :'String',
+        :'embedding' => :'Array<Float>'
       }
     end
 
@@ -49,13 +54,13 @@ module AzureOpenaiClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::InlineResponse2001Data` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::EmbeddingsCreate200ResponseDataInner` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `AzureOpenaiClient::InlineResponse2001Data`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AzureOpenaiClient::EmbeddingsCreate200ResponseDataInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -137,8 +142,11 @@ module AzureOpenaiClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -146,8 +154,6 @@ module AzureOpenaiClient
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
         end
       end
 
@@ -160,8 +166,8 @@ module AzureOpenaiClient
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -191,7 +197,9 @@ module AzureOpenaiClient
           end
         end
       else # model
-        AzureOpenaiClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = AzureOpenaiClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/azure_openai_client/models/{inline_response_200_1_usage.rb → embeddings_create200_response_usage.rb}

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
 =begin
 #Azure OpenAI Service API
 
 #Azure OpenAI APIs for completions and search
 
-OpenAPI spec version: 2023-05-15
+The version of the OpenAPI document: 2023-05-15
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.42
 =end
 
 require 'date'
+require 'time'
 
 module AzureOpenaiClient
-  class InlineResponse2001Usage
+  class EmbeddingsCreate200ResponseUsage
     attr_accessor :prompt_tokens
 
     attr_accessor :total_tokens
@@ -22,16 +22,21 @@ module AzureOpenaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        'prompt_tokens': :'prompt_tokens',
-        'total_tokens': :'total_tokens'
+        :'prompt_tokens' => :'prompt_tokens',
+        :'total_tokens' => :'total_tokens'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        'prompt_tokens': :'Object',
-        'total_tokens': :'Object'
+        :'prompt_tokens' => :'Integer',
+        :'total_tokens' => :'Integer'
       }
     end
 
@@ -45,13 +50,13 @@ module AzureOpenaiClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::InlineResponse2001Usage` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::EmbeddingsCreate200ResponseUsage` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `AzureOpenaiClient::InlineResponse2001Usage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AzureOpenaiClient::EmbeddingsCreate200ResponseUsage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -121,8 +126,11 @@ module AzureOpenaiClient
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -130,8 +138,6 @@ module AzureOpenaiClient
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
         end
       end
 
@@ -144,8 +150,8 @@ module AzureOpenaiClient
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -175,7 +181,9 @@ module AzureOpenaiClient
           end
         end
       else # model
-        AzureOpenaiClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = AzureOpenaiClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end