azure_cognitiveservices_personalizer 0.17.0

data/lib/v1.0/generated/azure_cognitiveservices_personalizer/models/ranked_action.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Personalizer::V1_0
+  module Models
+    #
+    # A ranked action with its resulting probability.
+    #
+    class RankedAction
+
+      include MsRestAzure
+
+      # @return [String] Id of the action
+      attr_accessor :id
+
+      # @return [Float] Probability of the action
+      attr_accessor :probability
+
+
+      #
+      # Mapper for RankedAction class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'RankedAction',
+          type: {
+            name: 'Composite',
+            class_name: 'RankedAction',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                constraints: {
+                  MaxLength: 256
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              probability: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'probability',
+                constraints: {
+                  InclusiveMaximum: 1,
+                  InclusiveMinimum: 0
+                },
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/v1.0/generated/azure_cognitiveservices_personalizer/models/reward_request.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Personalizer::V1_0
+  module Models
+    #
+    # Reward given to a rank response.
+    #
+    class RewardRequest
+
+      include MsRestAzure
+
+      # @return [Float] Reward to be assigned to an action. Value should be
+      # between -1 and 1 inclusive.
+      attr_accessor :value
+
+
+      #
+      # Mapper for RewardRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'RewardRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'RewardRequest',
+            model_properties: {
+              value: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'value',
+                type: {
+                  name: 'Double'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/v1.0/generated/azure_cognitiveservices_personalizer/module_definition.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure end
+module Azure::CognitiveServices end
+module Azure::CognitiveServices::Personalizer end
+module Azure::CognitiveServices::Personalizer::V1_0 end

data/lib/v1.0/generated/azure_cognitiveservices_personalizer/personalizer_client.rb

@@ -0,0 +1,226 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::CognitiveServices::Personalizer::V1_0
+  #
+  # A service client - single point of access to the REST API.
+  #
+  class PersonalizerClient < MsRestAzure::AzureServiceClient
+    include MsRestAzure
+    include MsRestAzure::Serialization
+
+    # @return [String] the base URI of the service.
+    attr_reader :base_url
+
+    # @return Credentials needed for the client to connect to Azure.
+    attr_reader :credentials1
+
+    # @return [String] Supported Cognitive Services endpoint.
+    attr_accessor :endpoint
+
+    # @return Subscription credentials which uniquely identify client
+    # subscription.
+    attr_accessor :credentials
+
+    # @return [String] The preferred language for the response.
+    attr_accessor :accept_language
+
+    # @return [Integer] The retry timeout in seconds for Long Running
+    # Operations. Default value is 30.
+    attr_accessor :long_running_operation_retry_timeout
+
+    # @return [Boolean] Whether a unique x-ms-client-request-id should be
+    # generated. When set to true a unique x-ms-client-request-id value is
+    # generated and included in each request. Default is true.
+    attr_accessor :generate_client_request_id
+
+    # @return [Events] events
+    attr_reader :events
+
+    #
+    # Creates initializes a new instance of the PersonalizerClient class.
+    # @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client.
+    # @param options [Array] filters to be applied to the HTTP requests.
+    #
+    def initialize(credentials = nil, options = nil)
+      super(credentials, options)
+      @base_url = '{Endpoint}/personalizer/v1.0'
+
+      fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
+      @credentials = credentials
+
+      @events = Events.new(self)
+      @accept_language = 'en-US'
+      @long_running_operation_retry_timeout = 30
+      @generate_client_request_id = true
+      add_telemetry
+    end
+
+    #
+    # Makes a request and returns the body of the response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Hash{String=>String}] containing the body of the response.
+    # Example:
+    #
+    #  request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
+    #  path = "/path"
+    #  options = {
+    #    body: request_content,
+    #    query_params: {'api-version' => '2016-02-01'}
+    #  }
+    #  result = @client.make_request(:put, path, options)
+    #
+    def make_request(method, path, options = {})
+      result = make_request_with_http_info(method, path, options)
+      result.body unless result.nil?
+    end
+
+    #
+    # Makes a request and returns the operation response.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.
+    #
+    def make_request_with_http_info(method, path, options = {})
+      result = make_request_async(method, path, options).value!
+      result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
+      result
+    end
+
+    #
+    # Makes a request asynchronously.
+    # @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete.
+    # @param path [String] the path, relative to {base_url}.
+    # @param options [Hash{String=>String}] specifying any request options like :body.
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def make_request_async(method, path, options = {})
+      fail ArgumentError, 'method is nil' if method.nil?
+      fail ArgumentError, 'path is nil' if path.nil?
+
+      request_url = options[:base_url] || @base_url
+      if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
+        @request_headers['Content-Type'] = options[:headers]['Content-Type']
+      end
+
+      request_headers = @request_headers
+      request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
+      options.merge!({headers: request_headers.merge(options[:headers] || {})})
+      options.merge!({credentials: @credentials}) unless @credentials.nil?
+
+      super(request_url, method, path, options)
+    end
+
+    #
+    # A Personalizer rank request.
+    #
+    # @param rank_request [RankRequest] A Personalizer request.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [RankResponse] operation results.
+    #
+    def rank(rank_request, custom_headers:nil)
+      response = rank_async(rank_request, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # A Personalizer rank request.
+    #
+    # @param rank_request [RankRequest] A Personalizer request.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
+    #
+    def rank_with_http_info(rank_request, custom_headers:nil)
+      rank_async(rank_request, custom_headers:custom_headers).value!
+    end
+
+    #
+    # A Personalizer rank request.
+    #
+    # @param rank_request [RankRequest] A Personalizer request.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def rank_async(rank_request, custom_headers:nil)
+      fail ArgumentError, 'endpoint is nil' if endpoint.nil?
+      fail ArgumentError, "'endpoint' should satisfy the constraint - 'MaxLength': '1024'" if !endpoint.nil? && endpoint.length > 1024
+      fail ArgumentError, 'rank_request is nil' if rank_request.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+
+      # Set Headers
+      request_headers['x-ms-client-request-id'] = SecureRandom.uuid
+      request_headers['accept-language'] = accept_language unless accept_language.nil?
+
+      # Serialize Request
+      request_mapper = Azure::CognitiveServices::Personalizer::V1_0::Models::RankRequest.mapper()
+      request_content = self.serialize(request_mapper,  rank_request)
+      request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil
+
+      path_template = 'rank'
+
+      request_url = @base_url || self.base_url
+    request_url = request_url.gsub('{Endpoint}', endpoint)
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          body: request_content,
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = self.make_request_async(:post, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 201
+          error_model = JSON.load(response_content)
+          fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
+        end
+
+        result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
+        # Deserialize Response
+        if status_code == 201
+          begin
+            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
+            result_mapper = Azure::CognitiveServices::Personalizer::V1_0::Models::RankResponse.mapper()
+            result.body = self.deserialize(result_mapper, parsed_response)
+          rescue Exception => e
+            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
+          end
+        end
+
+        result
+      end
+
+      promise.execute
+    end
+
+
+    private
+    #
+    # Adds telemetry information.
+    #
+    def add_telemetry
+        sdk_information = 'azure_cognitiveservices_personalizer'
+        sdk_information = "#{sdk_information}/0.17.0"
+        add_user_agent_information(sdk_information)
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+module Azure::CognitiveServices::Personalizer
+    VERSION = '0.17.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: azure_cognitiveservices_personalizer
+version: !ruby/object:Gem::Version
+  version: 0.17.0
+platform: ruby
+authors:
+- Microsoft Corporation
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: ms_rest_azure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+description: 
+email: azrubyteam@microsoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/azure_cognitiveservices_personalizer.rb
+- lib/module_definition.rb
+- lib/profiles/latest/modules/personalizer_profile_module.rb
+- lib/profiles/latest/personalizer_latest_profile_client.rb
+- lib/profiles/latest/personalizer_module_definition.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/events.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/error_code.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/error_response.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/internal_error.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/personalizer_error.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/rank_request.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/rank_response.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/rankable_action.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/ranked_action.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/models/reward_request.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/module_definition.rb
+- lib/v1.0/generated/azure_cognitiveservices_personalizer/personalizer_client.rb
+- lib/version.rb
+homepage: https://aka.ms/azure-sdk-for-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Azure/azure-sdk-for-ruby/issues
+  changelog_uri: https://github.com/Azure/azure-sdk-for-ruby/blob/master/ChangeLog.md
+  documentation_uri: https://azure.microsoft.com/en-us/develop/ruby/
+  homepage_uri: https://aka.ms/azure-sdk-for-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Official Ruby client library to consume Cognitiveservices Personalizer
+test_files: []