azure_cognitiveservices_personalizer 0.17.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d6df87294302fc4c15b2bfdd225f0ee6bdaa7e5
+  data.tar.gz: 90bbb9abc52238be90f78ac4f741df7069a46579
+SHA512:
+  metadata.gz: 0a65157b50c8140e9eef4bc8898a4f1d52cd789d460688110b458bb11e2ef4f18fdeb30fc6c5ccc6e69619a9afbe8c9b6c2d74c5b3275a69b9f9992a68112381
+  data.tar.gz: 13cf89f61fb9cfe8d84ebe4c2185209408205e6bba9ee9f8e06132cefe95da38c936b8fa960a1034c3da996082a777be14dde87eaa854e608aa012d313e37efe

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/azure_cognitiveservices_personalizer.rb

@@ -0,0 +1,6 @@
+# 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.
+
+require 'v1.0/generated/azure_cognitiveservices_personalizer'
+require 'profiles/latest/personalizer_latest_profile_client'

data/lib/module_definition.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 end
+module Azure::CognitiveServices end
+module Azure::CognitiveServices::Personalizer end

data/lib/profiles/latest/modules/personalizer_profile_module.rb

@@ -0,0 +1,95 @@
+# 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.
+
+require 'azure_cognitiveservices_personalizer'
+
+module Azure::Personalizer::Profiles::Latest
+  Events = Azure::CognitiveServices::Personalizer::V1_0::Events
+
+  module Models
+    RankableAction = Azure::CognitiveServices::Personalizer::V1_0::Models::RankableAction
+    InternalError = Azure::CognitiveServices::Personalizer::V1_0::Models::InternalError
+    RankRequest = Azure::CognitiveServices::Personalizer::V1_0::Models::RankRequest
+    ErrorResponse = Azure::CognitiveServices::Personalizer::V1_0::Models::ErrorResponse
+    RankedAction = Azure::CognitiveServices::Personalizer::V1_0::Models::RankedAction
+    PersonalizerError = Azure::CognitiveServices::Personalizer::V1_0::Models::PersonalizerError
+    RankResponse = Azure::CognitiveServices::Personalizer::V1_0::Models::RankResponse
+    RewardRequest = Azure::CognitiveServices::Personalizer::V1_0::Models::RewardRequest
+    ErrorCode = Azure::CognitiveServices::Personalizer::V1_0::Models::ErrorCode
+  end
+
+  #
+  # PersonalizerDataClass
+  #
+  class PersonalizerDataClass
+    attr_reader :events, :configurable, :base_url, :options, :model_classes
+
+    def initialize(options = {})
+      if options.is_a?(Hash) && options.length == 0
+        @options = setup_default_options
+      else
+        @options = options
+      end
+
+      reset!(options)
+
+      @configurable = self
+      @base_url = options[:base_url].nil? ? nil:options[:base_url]
+      @options = options[:options].nil? ? nil:options[:options]
+
+      @client_0 = Azure::CognitiveServices::Personalizer::V1_0::PersonalizerClient.new(configurable.credentials, options)
+      if(@client_0.respond_to?(:subscription_id))
+        @client_0.subscription_id = configurable.subscription_id
+      end
+      add_telemetry(@client_0)
+      @events = @client_0.events
+
+      @model_classes = ModelClasses.new
+    end
+
+    def add_telemetry(client)
+      profile_information = 'Profiles/Latest/Personalizer'
+      client.add_user_agent_information(profile_information)
+    end
+
+    def method_missing(method, *args)
+      if @client_0.respond_to?method
+        @client_0.send(method, *args)
+      else
+        super
+      end
+    end
+
+  end
+
+  class ModelClasses
+    def rankable_action
+      Azure::CognitiveServices::Personalizer::V1_0::Models::RankableAction
+    end
+    def internal_error
+      Azure::CognitiveServices::Personalizer::V1_0::Models::InternalError
+    end
+    def rank_request
+      Azure::CognitiveServices::Personalizer::V1_0::Models::RankRequest
+    end
+    def error_response
+      Azure::CognitiveServices::Personalizer::V1_0::Models::ErrorResponse
+    end
+    def ranked_action
+      Azure::CognitiveServices::Personalizer::V1_0::Models::RankedAction
+    end
+    def personalizer_error
+      Azure::CognitiveServices::Personalizer::V1_0::Models::PersonalizerError
+    end
+    def rank_response
+      Azure::CognitiveServices::Personalizer::V1_0::Models::RankResponse
+    end
+    def reward_request
+      Azure::CognitiveServices::Personalizer::V1_0::Models::RewardRequest
+    end
+    def error_code
+      Azure::CognitiveServices::Personalizer::V1_0::Models::ErrorCode
+    end
+  end
+end

data/lib/profiles/latest/personalizer_latest_profile_client.rb

@@ -0,0 +1,38 @@
+# 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.
+
+require 'profiles/latest/personalizer_module_definition'
+require 'profiles/latest/modules/personalizer_profile_module'
+
+module Azure::Personalizer::Profiles::Latest
+  #
+  # Client class for the Latest profile SDK.
+  #
+  class Client < PersonalizerDataClass
+    include MsRestAzure::Common::Configurable
+
+    #
+    # Initializes a new instance of the Client class.
+    # @param options [Hash] hash of client options.
+    #    options = {
+    #      tenant_id: 'YOUR TENANT ID',
+    #      client_id: 'YOUR CLIENT ID',
+    #      client_secret: 'YOUR CLIENT SECRET',
+    #      subscription_id: 'YOUR SUBSCRIPTION ID',
+    #      credentials: credentials,
+    #      active_directory_settings: active_directory_settings,
+    #      base_url: 'YOUR BASE URL',
+    #      options: options
+    #    }
+    #   'credentials' are optional and if not passed in the hash, will be obtained
+    #   from MsRest::TokenCredentials using MsRestAzure::ApplicationTokenProvider.
+    #
+    #   Also, base_url, active_directory_settings & options are optional.
+    #
+    def initialize(options = {})
+      super(options)
+    end
+
+  end
+end

data/lib/profiles/latest/personalizer_module_definition.rb

@@ -0,0 +1,8 @@
+# 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 end
+module Azure::Personalizer end
+module Azure::Personalizer::Profiles end
+module Azure::Personalizer::Profiles::Latest end

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

@@ -0,0 +1,37 @@
+# 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.
+
+require 'uri'
+require 'cgi'
+require 'date'
+require 'json'
+require 'base64'
+require 'erb'
+require 'securerandom'
+require 'time'
+require 'timeliness'
+require 'faraday'
+require 'faraday-cookie_jar'
+require 'concurrent'
+require 'ms_rest'
+require 'v1.0/generated/azure_cognitiveservices_personalizer/module_definition'
+require 'ms_rest_azure'
+
+module Azure::CognitiveServices::Personalizer::V1_0
+  autoload :Events,                                             'v1.0/generated/azure_cognitiveservices_personalizer/events.rb'
+  autoload :PersonalizerClient,                                 'v1.0/generated/azure_cognitiveservices_personalizer/personalizer_client.rb'
+
+  module Models
+    autoload :RankableAction,                                     'v1.0/generated/azure_cognitiveservices_personalizer/models/rankable_action.rb'
+    autoload :InternalError,                                      'v1.0/generated/azure_cognitiveservices_personalizer/models/internal_error.rb'
+    autoload :RankRequest,                                        'v1.0/generated/azure_cognitiveservices_personalizer/models/rank_request.rb'
+    autoload :ErrorResponse,                                      'v1.0/generated/azure_cognitiveservices_personalizer/models/error_response.rb'
+    autoload :RankedAction,                                       'v1.0/generated/azure_cognitiveservices_personalizer/models/ranked_action.rb'
+    autoload :PersonalizerError,                                  'v1.0/generated/azure_cognitiveservices_personalizer/models/personalizer_error.rb'
+    autoload :RankResponse,                                       'v1.0/generated/azure_cognitiveservices_personalizer/models/rank_response.rb'
+    autoload :RewardRequest,                                      'v1.0/generated/azure_cognitiveservices_personalizer/models/reward_request.rb'
+    autoload :ErrorCode,                                          'v1.0/generated/azure_cognitiveservices_personalizer/models/error_code.rb'
+  end
+end

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

@@ -0,0 +1,204 @@
+# 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
+  #
+  # Personalizer Service is an Azure Cognitive Service that makes it easy to
+  # target content and experiences without complex pre-analysis or cleanup of
+  # past data. Given a context and featurized content, the Personalizer Service
+  # returns your content in a ranked list. As rewards are sent in response to
+  # the ranked list, the reinforcement learning algorithm will improve the
+  # model and improve performance of future rank calls.
+  #
+  class Events
+    include MsRestAzure
+
+    #
+    # Creates and initializes a new instance of the Events class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [PersonalizerClient] reference to the PersonalizerClient
+    attr_reader :client
+
+    #
+    # Report reward to allocate to the top ranked action for the specified event.
+    #
+    # @param event_id [String] The event id this reward applies to.
+    # @param reward [RewardRequest] The reward should be a floating point number.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    #
+    def reward(event_id, reward, custom_headers:nil)
+      response = reward_async(event_id, reward, custom_headers:custom_headers).value!
+      nil
+    end
+
+    #
+    # Report reward to allocate to the top ranked action for the specified event.
+    #
+    # @param event_id [String] The event id this reward applies to.
+    # @param reward [RewardRequest] The reward should be a floating point number.
+    # @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 reward_with_http_info(event_id, reward, custom_headers:nil)
+      reward_async(event_id, reward, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Report reward to allocate to the top ranked action for the specified event.
+    #
+    # @param event_id [String] The event id this reward applies to.
+    # @param reward [RewardRequest] The reward should be a floating point number.
+    # @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 reward_async(event_id, reward, 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, 'event_id is nil' if event_id.nil?
+      fail ArgumentError, "'event_id' should satisfy the constraint - 'MaxLength': '256'" if !event_id.nil? && event_id.length > 256
+      fail ArgumentError, 'reward is nil' if reward.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'] = @client.accept_language unless @client.accept_language.nil?
+
+      # Serialize Request
+      request_mapper = Azure::CognitiveServices::Personalizer::V1_0::Models::RewardRequest.mapper()
+      request_content = @client.serialize(request_mapper,  reward)
+      request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil
+
+      path_template = 'events/{eventId}/reward'
+
+      request_url = @base_url || @client.base_url
+    request_url = request_url.gsub('{Endpoint}', endpoint)
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'eventId' => event_id},
+          body: request_content,
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.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 == 204
+          error_model = JSON.load(response_content)
+          fail MsRestAzure::AzureOperationError.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?
+
+        result
+      end
+
+      promise.execute
+    end
+
+    #
+    # Report that the specified event was actually displayed to the user and a
+    # reward should be expected for it.
+    #
+    # @param event_id [String] The event ID this activation applies to.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    #
+    def activate(event_id, custom_headers:nil)
+      response = activate_async(event_id, custom_headers:custom_headers).value!
+      nil
+    end
+
+    #
+    # Report that the specified event was actually displayed to the user and a
+    # reward should be expected for it.
+    #
+    # @param event_id [String] The event ID this activation applies to.
+    # @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 activate_with_http_info(event_id, custom_headers:nil)
+      activate_async(event_id, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Report that the specified event was actually displayed to the user and a
+    # reward should be expected for it.
+    #
+    # @param event_id [String] The event ID this activation applies to.
+    # @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 activate_async(event_id, 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, 'event_id is nil' if event_id.nil?
+      fail ArgumentError, "'event_id' should satisfy the constraint - 'MaxLength': '256'" if !event_id.nil? && event_id.length > 256
+
+
+      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'] = @client.accept_language unless @client.accept_language.nil?
+      path_template = 'events/{eventId}/activate'
+
+      request_url = @base_url || @client.base_url
+    request_url = request_url.gsub('{Endpoint}', endpoint)
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'eventId' => event_id},
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.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 == 204
+          error_model = JSON.load(response_content)
+          fail MsRestAzure::AzureOperationError.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?
+
+        result
+      end
+
+      promise.execute
+    end
+
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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
+    #
+    # Defines values for ErrorCode
+    #
+    module ErrorCode
+      BadRequest = "BadRequest"
+      ResourceNotFound = "ResourceNotFound"
+      InternalServerError = "InternalServerError"
+    end
+  end
+end