Class: Azure::CognitiveServices::ComputerVision::V2_0::Models::ImageAnalysis

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb

Overview

Result of AnalyzeImage operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#adult ⇒ AdultInfo

adult-oriented content and/or is racy.

Returns:

  • (AdultInfo) —

    An object describing whether the image contains



20
21
22
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 20

def adult
  @adult
end

#brands ⇒ Array<DetectedBrand>

Returns Array of brands detected in the image.

Returns:

  • (Array<DetectedBrand>) —

    Array of brands detected in the image.



46
47
48
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 46

def brands
  @brands
end

#categories ⇒ Array<Category>

Returns An array indicating identified categories.

Returns:

  • (Array<Category>) —

    An array indicating identified categories.



16
17
18
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 16

def categories
  @categories
end

#color ⇒ ColorInfo

color attributes.

Returns:

  • (ColorInfo) —

    An object providing additional metadata describing



24
25
26
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 24

def color
  @color
end

#description ⇒ ImageDescriptionDetails

with a list of captions sorted by confidence level, and image metadata.

Returns:



35
36
37
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 35

def description
  @description
end

#faces ⇒ Array<FaceDescription>

image.

Returns:



39
40
41
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 39

def faces
  @faces
end

#image_type ⇒ ImageType

matching confidence levels.

Returns:

  • (ImageType) —

    An object providing possible image types and



28
29
30
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 28

def image_type
  @image_type
end

#metadata ⇒ ImageMetadata

Returns:



52
53
54
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 52

def metadata
  @metadata
end

#objects ⇒ Array<DetectedObject>

detected in the image.

Returns:



43
44
45
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 43

def objects
  @objects
end

#request_id ⇒ String

Returns Id of the REST API request.

Returns:

  • (String) —

    Id of the REST API request.



49
50
51
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 49

def request_id
  @request_id
end

#tags ⇒ Array<ImageTag>

Returns A list of tags with confidence level.

Returns:

  • (Array<ImageTag>) —

    A list of tags with confidence level.



31
32
33
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 31

def tags
  @tags
end

Class Method Details

.mapper ⇒ Object

Mapper for ImageAnalysis class as Ruby Hash. This will be used for serialization/deserialization.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/image_analysis.rb', line 59

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ImageAnalysis',
    type: {
      name: 'Composite',
      class_name: 'ImageAnalysis',
      model_properties: {
        categories: {
          client_side_validation: true,
          required: false,
          serialized_name: 'categories',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'CategoryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Category'
                }
            }
          }
        },
        adult: {
          client_side_validation: true,
          required: false,
          serialized_name: 'adult',
          type: {
            name: 'Composite',
            class_name: 'AdultInfo'
          }
        },
        color: {
          client_side_validation: true,
          required: false,
          serialized_name: 'color',
          type: {
            name: 'Composite',
            class_name: 'ColorInfo'
          }
        },
        image_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'imageType',
          type: {
            name: 'Composite',
            class_name: 'ImageType'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ImageTagElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ImageTag'
                }
            }
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'Composite',
            class_name: 'ImageDescriptionDetails'
          }
        },
        faces: {
          client_side_validation: true,
          required: false,
          serialized_name: 'faces',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'FaceDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'FaceDescription'
                }
            }
          }
        },
        objects: {
          client_side_validation: true,
          required: false,
          serialized_name: 'objects',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'DetectedObjectElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DetectedObject'
                }
            }
          }
        },
        brands: {
          client_side_validation: true,
          required: false,
          serialized_name: 'brands',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'DetectedBrandElementType',
                type: {
                  name: 'Composite',
                  class_name: 'DetectedBrand'
                }
            }
          }
        },
        request_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'requestId',
          type: {
            name: 'String'
          }
        },
        metadata: {
          client_side_validation: true,
          required: false,
          serialized_name: 'metadata',
          type: {
            name: 'Composite',
            class_name: 'ImageMetadata'
          }
        }
      }
    }
  }
end