azure_cognitiveservices_entitysearch 0.16.0

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/entities_entity_presentation_info.rb

@@ -0,0 +1,85 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines additional information about an entity such as type hints.
+    #
+    class EntitiesEntityPresentationInfo
+
+      include MsRestAzure
+
+      # @return [EntityScenario] The supported scenario. Possible values
+      # include: 'DominantEntity', 'DisambiguationItem', 'ListItem'. Default
+      # value: 'DominantEntity' .
+      attr_accessor :entity_scenario
+
+      # @return [Array<EntityType>] A list of hints that indicate the entity's
+      # type. The list could contain a single hint such as Movie or a list of
+      # hints such as Place, LocalBusiness, Restaurant. Each successive hint in
+      # the array narrows the entity's type.
+      attr_accessor :entity_type_hints
+
+      # @return [String] A display version of the entity hint. For example, if
+      # entityTypeHints is Artist, this field may be set to American Singer.
+      attr_accessor :entity_type_display_hint
+
+
+      #
+      # Mapper for EntitiesEntityPresentationInfo class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Entities/EntityPresentationInfo',
+          type: {
+            name: 'Composite',
+            class_name: 'EntitiesEntityPresentationInfo',
+            model_properties: {
+              entity_scenario: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'entityScenario',
+                default_value: 'DominantEntity',
+                type: {
+                  name: 'String'
+                }
+              },
+              entity_type_hints: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'entityTypeHints',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'EntityTypeElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              },
+              entity_type_display_hint: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'entityTypeDisplayHint',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/entity_query_scenario.rb

@@ -0,0 +1,19 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines values for EntityQueryScenario
+    #
+    module EntityQueryScenario
+      DominantEntity = "DominantEntity"
+      DominantEntityWithDisambiguation = "DominantEntityWithDisambiguation"
+      Disambiguation = "Disambiguation"
+      List = "List"
+      ListWithPivot = "ListWithPivot"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/entity_scenario.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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines values for EntityScenario
+    #
+    module EntityScenario
+      DominantEntity = "DominantEntity"
+      DisambiguationItem = "DisambiguationItem"
+      ListItem = "ListItem"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/entity_type.rb

@@ -0,0 +1,63 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines values for EntityType
+    #
+    module EntityType
+      Generic = "Generic"
+      Person = "Person"
+      Place = "Place"
+      Media = "Media"
+      Organization = "Organization"
+      LocalBusiness = "LocalBusiness"
+      Restaurant = "Restaurant"
+      Hotel = "Hotel"
+      TouristAttraction = "TouristAttraction"
+      Travel = "Travel"
+      City = "City"
+      Country = "Country"
+      Attraction = "Attraction"
+      House = "House"
+      State = "State"
+      RadioStation = "RadioStation"
+      StreetAddress = "StreetAddress"
+      Neighborhood = "Neighborhood"
+      Locality = "Locality"
+      PostalCode = "PostalCode"
+      Region = "Region"
+      SubRegion = "SubRegion"
+      MinorRegion = "MinorRegion"
+      Continent = "Continent"
+      PointOfInterest = "PointOfInterest"
+      Other = "Other"
+      Movie = "Movie"
+      Book = "Book"
+      TelevisionShow = "TelevisionShow"
+      TelevisionSeason = "TelevisionSeason"
+      VideoGame = "VideoGame"
+      MusicAlbum = "MusicAlbum"
+      MusicRecording = "MusicRecording"
+      MusicGroup = "MusicGroup"
+      Composition = "Composition"
+      TheaterPlay = "TheaterPlay"
+      Event = "Event"
+      Actor = "Actor"
+      Artist = "Artist"
+      Attorney = "Attorney"
+      Speciality = "Speciality"
+      CollegeOrUniversity = "CollegeOrUniversity"
+      School = "School"
+      Food = "Food"
+      Drug = "Drug"
+      Animal = "Animal"
+      SportsTeam = "SportsTeam"
+      Product = "Product"
+      Car = "Car"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/error.rb

@@ -0,0 +1,116 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines the error that occurred.
+    #
+    class Error
+
+      include MsRestAzure
+
+      # @return [ErrorCode] The error code that identifies the category of
+      # error. Possible values include: 'None', 'ServerError',
+      # 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization',
+      # 'InsufficientAuthorization'. Default value: 'None' .
+      attr_accessor :code
+
+      # @return [ErrorSubCode] The error code that further helps to identify
+      # the error. Possible values include: 'UnexpectedError', 'ResourceError',
+      # 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue',
+      # 'HttpNotAllowed', 'Blocked', 'AuthorizationMissing',
+      # 'AuthorizationRedundancy', 'AuthorizationDisabled',
+      # 'AuthorizationExpired'
+      attr_accessor :sub_code
+
+      # @return [String] A description of the error.
+      attr_accessor :message
+
+      # @return [String] A description that provides additional information
+      # about the error.
+      attr_accessor :more_details
+
+      # @return [String] The parameter in the request that caused the error.
+      attr_accessor :parameter
+
+      # @return [String] The parameter's value in the request that was not
+      # valid.
+      attr_accessor :value
+
+
+      #
+      # Mapper for Error class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Error',
+          type: {
+            name: 'Composite',
+            class_name: 'Error',
+            model_properties: {
+              code: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'code',
+                default_value: 'None',
+                type: {
+                  name: 'String'
+                }
+              },
+              sub_code: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'subCode',
+                type: {
+                  name: 'String'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              },
+              more_details: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'moreDetails',
+                type: {
+                  name: 'String'
+                }
+              },
+              parameter: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'parameter',
+                type: {
+                  name: 'String'
+                }
+              },
+              value: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'value',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/error_code.rb

@@ -0,0 +1,20 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines values for ErrorCode
+    #
+    module ErrorCode
+      None = "None"
+      ServerError = "ServerError"
+      InvalidRequest = "InvalidRequest"
+      RateLimitExceeded = "RateLimitExceeded"
+      InvalidAuthorization = "InvalidAuthorization"
+      InsufficientAuthorization = "InsufficientAuthorization"
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/error_response.rb

@@ -0,0 +1,109 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # The top-level response that represents a failed request.
+    #
+    class ErrorResponse < Response
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "ErrorResponse"
+      end
+
+      attr_accessor :_type
+
+      # @return [Array<Error>] A list of errors that describe the reasons why
+      # the request failed.
+      attr_accessor :errors
+
+
+      #
+      # 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: {
+              _type: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: '_type',
+                type: {
+                  name: 'String'
+                }
+              },
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              contractual_rules: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'contractualRules',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ContractualRulesContractualRuleElementType',
+                      type: {
+                        name: 'Composite',
+                        polymorphic_discriminator: '_type',
+                        uber_parent: 'ContractualRulesContractualRule',
+                        class_name: 'ContractualRulesContractualRule'
+                      }
+                  }
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              errors: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'errors',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ErrorElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Error'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_entitysearch/models/error_sub_code.rb

@@ -0,0 +1,25 @@
+# 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::EntitySearch::V1_0
+  module Models
+    #
+    # Defines values for ErrorSubCode
+    #
+    module ErrorSubCode
+      UnexpectedError = "UnexpectedError"
+      ResourceError = "ResourceError"
+      NotImplemented = "NotImplemented"
+      ParameterMissing = "ParameterMissing"
+      ParameterInvalidValue = "ParameterInvalidValue"
+      HttpNotAllowed = "HttpNotAllowed"
+      Blocked = "Blocked"
+      AuthorizationMissing = "AuthorizationMissing"
+      AuthorizationRedundancy = "AuthorizationRedundancy"
+      AuthorizationDisabled = "AuthorizationDisabled"
+      AuthorizationExpired = "AuthorizationExpired"
+    end
+  end
+end