azure_cognitiveservices_personalizer 0.17.0

data/lib/v1.0/generated/azure_cognitiveservices_personalizer/models/error_response.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
+    #
+    # Used to return an error to the client
+    #
+    class ErrorResponse
+
+      include MsRestAzure
+
+      # @return [PersonalizerError] The error object.
+      attr_accessor :error
+
+
+      #
+      # Mapper for ErrorResponse class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ErrorResponse',
+          type: {
+            name: 'Composite',
+            class_name: 'ErrorResponse',
+            model_properties: {
+              error: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'error',
+                type: {
+                  name: 'Composite',
+                  class_name: 'PersonalizerError'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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
+    #
+    # An object containing more specific information than the parent object
+    # about the error.
+    #
+    class InternalError
+
+      include MsRestAzure
+
+      # @return [String] Detailed error code.
+      attr_accessor :code
+
+      # @return [InternalError] The error object.
+      attr_accessor :innererror
+
+
+      #
+      # Mapper for InternalError class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'InternalError',
+          type: {
+            name: 'Composite',
+            class_name: 'InternalError',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'code',
+                type: {
+                  name: 'String'
+                }
+              },
+              innererror: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'innererror',
+                type: {
+                  name: 'Composite',
+                  class_name: 'InternalError'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# 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
+    #
+    # The error object.
+    #
+    class PersonalizerError
+
+      include MsRestAzure
+
+      # @return [ErrorCode] High level error code. Possible values include:
+      # 'BadRequest', 'ResourceNotFound', 'InternalServerError'
+      attr_accessor :code
+
+      # @return [String] A message explaining the error reported by the
+      # service.
+      attr_accessor :message
+
+      # @return [String] Error source element.
+      attr_accessor :target
+
+      # @return [Array<PersonalizerError>] An array of details about specific
+      # errors that led to this reported error.
+      attr_accessor :details
+
+      # @return [InternalError] Finer error details.
+      attr_accessor :inner_error
+
+
+      #
+      # Mapper for PersonalizerError class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'PersonalizerError',
+          type: {
+            name: 'Composite',
+            class_name: 'PersonalizerError',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'code',
+                type: {
+                  name: 'String'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              },
+              target: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'target',
+                type: {
+                  name: 'String'
+                }
+              },
+              details: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'details',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'PersonalizerErrorElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'PersonalizerError'
+                      }
+                  }
+                }
+              },
+              inner_error: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'innerError',
+                type: {
+                  name: 'Composite',
+                  class_name: 'InternalError'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# 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
+    #
+    # Request a set of actions to be ranked by the Personalizer service.
+    #
+    class RankRequest
+
+      include MsRestAzure
+
+      # @return Features of the context used for Personalizer as a
+      # dictionary of dictionaries. This depends on the application, and
+      # typically includes features about the current user, their
+      # device, profile information, data about time and date, etc.
+      attr_accessor :context_features
+
+      # @return [Array<RankableAction>] The set of actions the Personalizer
+      # service can pick from.
+      # The set should not contain more than 50 actions.
+      # The order of the actions does not affect the rank result but the order
+      # should match the sequence your application would have used to display
+      # them.
+      attr_accessor :actions
+
+      # @return [Array<String>] The set of action ids to exclude from ranking.
+      attr_accessor :excluded_actions
+
+      # @return [String] Optionally pass an eventId that uniquely identifies
+      # this Rank event.
+      # If null, the service generates a unique eventId. The eventId will be
+      # used for
+      # associating this request with its reward, as well as seeding the
+      # pseudo-random
+      # generator when making a Personalizer call.
+      attr_accessor :event_id
+
+      # @return [Boolean] Send false if the user will see the rank results,
+      # therefore
+      # Personalizer will expect a Reward call, otherwise it will assign the
+      # default
+      # Reward to the event. Send true if it is possible the user will not see
+      # the
+      # rank results, because the page is rendering later, or the Rank results
+      # may be
+      # overridden by code further downstream. Default value: false .
+      attr_accessor :defer_activation
+
+
+      #
+      # Mapper for RankRequest class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'RankRequest',
+          type: {
+            name: 'Composite',
+            class_name: 'RankRequest',
+            model_properties: {
+              context_features: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'contextFeatures',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ObjectElementType',
+                      type: {
+                        name: 'Object'
+                      }
+                  }
+                }
+              },
+              actions: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'actions',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'RankableActionElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'RankableAction'
+                      }
+                  }
+                }
+              },
+              excluded_actions: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'excludedActions',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'StringElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              event_id: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'eventId',
+                constraints: {
+                  MaxLength: 256
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              defer_activation: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'deferActivation',
+                default_value: false,
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# 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 resulting ordered list of actions that result from a rank request.
+    #
+    class RankResponse
+
+      include MsRestAzure
+
+      # @return [Array<RankedAction>] The calculated ranking for the current
+      # request.
+      attr_accessor :ranking
+
+      # @return [String] The eventId for the round trip from request to
+      # response.
+      attr_accessor :event_id
+
+      # @return [String] The action chosen by the Personalizer service. This is
+      # the action for which to report the reward. This might not be the
+      # first found in 'ranking' if an action in the request in first position
+      # was part of the excluded ids.
+      attr_accessor :reward_action_id
+
+
+      #
+      # Mapper for RankResponse class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'RankResponse',
+          type: {
+            name: 'Composite',
+            class_name: 'RankResponse',
+            model_properties: {
+              ranking: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'ranking',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'RankedActionElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'RankedAction'
+                      }
+                  }
+                }
+              },
+              event_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'eventId',
+                constraints: {
+                  MaxLength: 256
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              reward_action_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'rewardActionId',
+                constraints: {
+                  MaxLength: 256
+                },
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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
+    #
+    # An action with it's associated features used for ranking.
+    #
+    class RankableAction
+
+      include MsRestAzure
+
+      # @return [String] Id of the action.
+      attr_accessor :id
+
+      # @return List of dictionaries containing features.
+      attr_accessor :features
+
+
+      #
+      # Mapper for RankableAction class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'RankableAction',
+          type: {
+            name: 'Composite',
+            class_name: 'RankableAction',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'id',
+                constraints: {
+                  MaxLength: 256
+                },
+                type: {
+                  name: 'String'
+                }
+              },
+              features: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'features',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ObjectElementType',
+                      type: {
+                        name: 'Object'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end