azure_openai_client 0.0.1 → 0.0.3

data/lib/azure_openai_client/configuration.rb

@@ -1,14 +1,13 @@
-# 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
 
 module AzureOpenaiClient
@@ -22,6 +21,18 @@ module AzureOpenaiClient
     # Defines url base path
     attr_accessor :base_path
 
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
     # Defines API keys used with API Key authentications.
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
@@ -51,6 +62,16 @@ module AzureOpenaiClient
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -122,23 +143,28 @@ module AzureOpenaiClient
     # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
 
     def initialize
       @scheme = 'https'
-      @host = '{endpoint}'
-      @base_path = 'https://{endpoint}/openai'
+      @host = 'your-resource-name.openai.azure.com'
+      @base_path = '/openai'
+      @server_index = 0
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
-      @timeout = 0
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
-      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
+      @timeout = 0
+      @params_encoding = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -172,20 +198,32 @@ module AzureOpenaiClient
       @base_path = '' if @base_path == '/'
     end
 
-    def base_url
-      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    # Returns base URL for specified operation based on server settings
+    def base_url(operation = nil)
+      index = server_operation_index[operation]
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
+
+      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
     end
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -194,21 +232,75 @@ module AzureOpenaiClient
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'apiKey' =>
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'api-key',
-            value: api_key_with_prefix('api-key')
-          },
         'bearer' =>
           {
             type: 'oauth2',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer #{access_token}"
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'apiKey' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'api-key',
+            value: api_key_with_prefix('apiKey')
           },
       }
     end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "https://{endpoint}/openai",
+          description: "No description provided",
+          variables: {
+            endpoint: {
+                description: "No description provided",
+                default_value: "your-resource-name.openai.azure.com",
+              }
+            }
+        }
+      ]
+    end
+
+    def operation_server_settings
+      {}
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
+
+      # check array index out of bound
+      if (index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      return url unless server.key? :variables
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
   end
 end

data/lib/azure_openai_client/models/{inline_response_200_2.rb → chat_completions_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 InlineResponse2002
+  class ChatCompletionsCreate200Response
     attr_accessor :id
 
     attr_accessor :object
@@ -30,24 +30,29 @@ module AzureOpenaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        'id': :'id',
-        'object': :'object',
-        'created': :'created',
-        'model': :'model',
-        'choices': :'choices',
-        'usage': :'usage'
+        :'id' => :'id',
+        :'object' => :'object',
+        :'created' => :'created',
+        :'model' => :'model',
+        :'choices' => :'choices',
+        :'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
       {
-        'id': :'Object',
-        'object': :'Object',
-        'created': :'Object',
-        'model': :'Object',
-        'choices': :'Object',
-        'usage': :'Object'
+        :'id' => :'String',
+        :'object' => :'String',
+        :'created' => :'Integer',
+        :'model' => :'String',
+        :'choices' => :'Array<ChatCompletionsCreate200ResponseChoicesInner>',
+        :'usage' => :'ChatCompletionsCreate200ResponseUsage'
       }
     end
 
@@ -61,13 +66,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::InlineResponse2002` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::ChatCompletionsCreate200Response` 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::InlineResponse2002`. 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::ChatCompletionsCreate200Response`. 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
       }
@@ -174,8 +179,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)
@@ -183,8 +191,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
 
@@ -197,8 +203,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
@@ -228,7 +234,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_2_choices.rb → chat_completions_create200_response_choices_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 InlineResponse2002Choices
+  class ChatCompletionsCreate200ResponseChoicesInner
     attr_accessor :index
 
     attr_accessor :message
@@ -24,18 +24,23 @@ module AzureOpenaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        'index': :'index',
-        'message': :'message',
-        'finish_reason': :'finish_reason'
+        :'index' => :'index',
+        :'message' => :'message',
+        :'finish_reason' => :'finish_reason'
       }
     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',
-        'message': :'Object',
-        'finish_reason': :'Object'
+        :'index' => :'Integer',
+        :'message' => :'ChatCompletionsCreate200ResponseChoicesInnerMessage',
+        :'finish_reason' => :'String'
       }
     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::InlineResponse2002Choices` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::ChatCompletionsCreate200ResponseChoicesInner` 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::InlineResponse2002Choices`. 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::ChatCompletionsCreate200ResponseChoicesInner`. 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
       }
@@ -120,8 +125,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)
@@ -129,8 +137,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
 
@@ -143,8 +149,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
@@ -174,7 +180,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_2_message.rb → chat_completions_create200_response_choices_inner_message.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 InlineResponse2002Message
+  class ChatCompletionsCreate200ResponseChoicesInnerMessage
     # The role of the author of this message.
     attr_accessor :role
 
@@ -46,16 +46,21 @@ module AzureOpenaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        'role': :'role',
-        'content': :'content'
+        :'role' => :'role',
+        :'content' => :'content'
       }
     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
       {
-        'role': :'Object',
-        'content': :'Object'
+        :'role' => :'String',
+        :'content' => :'String'
       }
     end
 
@@ -69,13 +74,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::InlineResponse2002Message` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AzureOpenaiClient::ChatCompletionsCreate200ResponseChoicesInnerMessage` 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::InlineResponse2002Message`. 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::ChatCompletionsCreate200ResponseChoicesInnerMessage`. 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
       }
@@ -108,7 +113,7 @@ module AzureOpenaiClient
     # @return true if the model is valid
     def valid?
       return false if @role.nil?
-      role_validator = EnumAttributeValidator.new('Object', ['system', 'user', 'assistant'])
+      role_validator = EnumAttributeValidator.new('String', ["system", "user", "assistant"])
       return false unless role_validator.valid?(@role)
       return false if @content.nil?
       true
@@ -117,7 +122,7 @@ module AzureOpenaiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] role Object to be assigned
     def role=(role)
-      validator = EnumAttributeValidator.new('Object', ['system', 'user', 'assistant'])
+      validator = EnumAttributeValidator.new('String', ["system", "user", "assistant"])
       unless validator.valid?(role)
         fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
       end
@@ -157,8 +162,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)
@@ -166,8 +174,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
 
@@ -180,8 +186,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
@@ -211,7 +217,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