azure_cognitiveservices_visualsearch 0.17.0

data/lib/1.0/generated/azure_cognitiveservices_visualsearch/models/image_object.rb

@@ -0,0 +1,326 @@
+# 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::VisualSearch::V1_0
+  module Models
+    #
+    # Defines an image.
+    #
+    class ImageObject < MediaObject
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "ImageObject"
+      end
+
+      attr_accessor :_type
+
+      # @return [ImageObject] The URL to a thumbnail of the image.
+      attr_accessor :thumbnail
+
+      # @return [String] The token that you use in a subsequent call to Visual
+      # Search API to get additional information about the image. For
+      # information about using this token, see the imageInsightsToken field
+      # inside the knowledgeRequest request parameter.
+      attr_accessor :image_insights_token
+
+      # @return [ImagesImageMetadata] A count of the number of websites where
+      # you can shop or perform other actions related to the image. For
+      # example, if the image is of an apple pie, this object includes a count
+      # of the number of websites where you can buy an apple pie. To indicate
+      # the number of offers in your UX, include badging such as a shopping
+      # cart icon that contains the count. When the user clicks on the icon,
+      # use imageInisghtsToken in a subsequent Visual Search API call to get
+      # the list of shopping websites.
+      attr_accessor :insights_metadata
+
+      # @return [String] Unique Id for the image.
+      attr_accessor :image_id
+
+      # @return [String] A three-byte hexadecimal number that represents the
+      # color that dominates the image. Use the color as the temporary
+      # background in your client until the image is loaded.
+      attr_accessor :accent_color
+
+      # @return [String] For interal use only.
+      attr_accessor :visual_words
+
+
+      #
+      # Mapper for ImageObject class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageObject',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageObject',
+            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'
+                }
+              },
+              read_link: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'readLink',
+                type: {
+                  name: 'String'
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'url',
+                type: {
+                  name: 'String'
+                }
+              },
+              image: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'image',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ImageObject'
+                }
+              },
+              description: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'description',
+                type: {
+                  name: 'String'
+                }
+              },
+              alternate_name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alternateName',
+                type: {
+                  name: 'String'
+                }
+              },
+              bing_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'bingId',
+                type: {
+                  name: 'String'
+                }
+              },
+              thumbnail_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'thumbnailUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              provider: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'provider',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              date_published: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'datePublished',
+                type: {
+                  name: 'String'
+                }
+              },
+              text: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              content_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'contentUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              host_page_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'hostPageUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              content_size: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'contentSize',
+                type: {
+                  name: 'String'
+                }
+              },
+              encoding_format: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'encodingFormat',
+                type: {
+                  name: 'String'
+                }
+              },
+              host_page_display_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'hostPageDisplayUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              width: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'width',
+                type: {
+                  name: 'Number'
+                }
+              },
+              height: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'height',
+                type: {
+                  name: 'Number'
+                }
+              },
+              thumbnail: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'thumbnail',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ImageObject'
+                }
+              },
+              image_insights_token: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'imageInsightsToken',
+                type: {
+                  name: 'String'
+                }
+              },
+              insights_metadata: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'insightsMetadata',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ImagesImageMetadata'
+                }
+              },
+              image_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'imageId',
+                type: {
+                  name: 'String'
+                }
+              },
+              accent_color: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'accentColor',
+                type: {
+                  name: 'String'
+                }
+              },
+              visual_words: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'visualWords',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_visualsearch/models/image_recipes_action.rb

@@ -0,0 +1,244 @@
+# 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::VisualSearch::V1_0
+  module Models
+    #
+    # Defines an recipe action.
+    #
+    class ImageRecipesAction < ImageAction
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "ImageRecipesAction"
+      end
+
+      attr_accessor :_type
+
+      # @return [RecipesModule] A list of recipes related to the image.
+      attr_accessor :data
+
+
+      #
+      # Mapper for ImageRecipesAction class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageRecipesAction',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageRecipesAction',
+            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'
+                }
+              },
+              read_link: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'readLink',
+                type: {
+                  name: 'String'
+                }
+              },
+              web_search_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'webSearchUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'url',
+                type: {
+                  name: 'String'
+                }
+              },
+              image: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'image',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ImageObject'
+                }
+              },
+              description: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'description',
+                type: {
+                  name: 'String'
+                }
+              },
+              alternate_name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'alternateName',
+                type: {
+                  name: 'String'
+                }
+              },
+              bing_id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'bingId',
+                type: {
+                  name: 'String'
+                }
+              },
+              thumbnail_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'thumbnailUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              provider: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'provider',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              date_published: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'datePublished',
+                type: {
+                  name: 'String'
+                }
+              },
+              text: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'text',
+                type: {
+                  name: 'String'
+                }
+              },
+              result: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'result',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ThingElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'Thing'
+                      }
+                  }
+                }
+              },
+              display_name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'displayName',
+                type: {
+                  name: 'String'
+                }
+              },
+              is_top_action: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'isTopAction',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              service_url: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'serviceUrl',
+                type: {
+                  name: 'String'
+                }
+              },
+              action_type: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'actionType',
+                type: {
+                  name: 'String'
+                }
+              },
+              data: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'data',
+                type: {
+                  name: 'Composite',
+                  class_name: 'RecipesModule'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end