azure_cognitiveservices_visualsearch 0.17.0

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

@@ -0,0 +1,231 @@
+# 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 entity action.
+    #
+    class ImageEntityAction < ImageAction
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "ImageEntityAction"
+      end
+
+      attr_accessor :_type
+
+
+      #
+      # Mapper for ImageEntityAction class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageEntityAction',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageEntityAction',
+            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'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# 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
+    #
+    # A JSON object that identities the image to get insights of . It also
+    # includes the optional crop area that you use to identify the region of
+    # interest in the image.
+    #
+    class ImageInfo
+
+      include MsRestAzure
+
+      # @return [String] An image insights token. To get the insights token,
+      # call one of the Image Search APIs (for example, /images/search). In the
+      # search results, the
+      # [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image)
+      # object's
+      # [imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken)
+      # field contains the token. The imageInsightsToken and url fields
+      # mutually exclusive; do not specify both. Do not specify an insights
+      # token if the request includes the image form data.
+      attr_accessor :image_insights_token
+
+      # @return [String] The URL of the input image. The imageInsightsToken and
+      # url fields are mutually exclusive; do not specify both. Do not specify
+      # the URL if the request includes the image form data.
+      attr_accessor :url
+
+      # @return [CropArea] A JSON object consisting of coordinates specifying
+      # the four corners of a cropped rectangle within the input image. Use the
+      # crop area to identify the region of interest in the image. You can
+      # apply the crop area to the images specified using the
+      # imageInsightsToken or url fields, or an image binary specified in an
+      # image form data.
+      attr_accessor :crop_area
+
+
+      #
+      # Mapper for ImageInfo class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageInfo',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageInfo',
+            model_properties: {
+              image_insights_token: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'imageInsightsToken',
+                type: {
+                  name: 'String'
+                }
+              },
+              url: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'url',
+                type: {
+                  name: 'String'
+                }
+              },
+              crop_area: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'cropArea',
+                type: {
+                  name: 'Composite',
+                  class_name: 'CropArea'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# 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 a visual search API response.
+    #
+    class ImageKnowledge < Response
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "ImageKnowledge"
+      end
+
+      attr_accessor :_type
+
+      # @return [Array<ImageTag>] A list of visual search tags.
+      attr_accessor :tags
+
+      # @return [ImageObject] Image object containing metadata about the
+      # requested image.
+      attr_accessor :image
+
+
+      #
+      # Mapper for ImageKnowledge class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageKnowledge',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageKnowledge',
+            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'
+                }
+              },
+              tags: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'tags',
+                type: {
+                  name: 'Sequence',
+                  element: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'ImageTagElementType',
+                      type: {
+                        name: 'Composite',
+                        class_name: 'ImageTag'
+                      }
+                  }
+                }
+              },
+              image: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'image',
+                type: {
+                  name: 'Composite',
+                  class_name: 'ImageObject'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/1.0/generated/azure_cognitiveservices_visualsearch/models/image_module_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 image list action.
+    #
+    class ImageModuleAction < ImageAction
+
+      include MsRestAzure
+
+
+      def initialize
+        @_type = "ImageModuleAction"
+      end
+
+      attr_accessor :_type
+
+      # @return [ImagesModule] A list of images.
+      attr_accessor :data
+
+
+      #
+      # Mapper for ImageModuleAction class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'ImageModuleAction',
+          type: {
+            name: 'Composite',
+            class_name: 'ImageModuleAction',
+            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: 'ImagesModule'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end