Class: Azure::CognitiveServices::ImageSearch::V1_0::Models::Images

Inherits:
SearchResultsAnswer show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb

Overview

Defines an image answer

Instance Attribute Summary collapse

Attributes inherited from SearchResultsAnswer

#total_estimated_matches

Attributes inherited from Response

#read_link, #web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Images

Returns a new instance of Images.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 16

def initialize
  @_type = "Images"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 20

def _type
  @_type
end

#next_offset ⇒ Integer

offset that client should use in the next pagination request

Returns:

  • (Integer) —

    Used as part of deduping. Tells client the next



24
25
26
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 24

def next_offset
  @next_offset
end

#pivot_suggestions ⇒ Array<PivotSuggestions>

query. For example, if the query was Red Flowers, Bing might segment the query into Red and Flowers. The Flowers pivot may contain query suggestions such as Red Peonies and Red Daisies, and the Red pivot may contain query suggestions such as Green Flowers and Yellow Flowers.

Returns:



41
42
43
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 41

def pivot_suggestions
  @pivot_suggestions
end

#query_expansions ⇒ Array<Query>

original query. For example, if the query was Microsoft Surface, the expanded queries might be: Microsoft Surface Pro 3, Microsoft Surface RT, Microsoft Surface Phone, and Microsoft Surface Hub.

Returns:

  • (Array<Query>) —

    A list of expanded queries that narrows the



34
35
36
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 34

def query_expansions
  @query_expansions
end

#similar_terms ⇒ Array<Query>

the user’s query term.

Returns:

  • (Array<Query>) —

    A list of terms that are similar in meaning to



45
46
47
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 45

def similar_terms
  @similar_terms
end

#value ⇒ Array<ImageObject>

to the query. If there are no results, the List is empty.

Returns:

  • (Array<ImageObject>) —

    A list of image objects that are relevant



28
29
30
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 28

def value
  @value
end

Class Method Details

.mapper ⇒ Object

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



52
53
54
55
56
57
58
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
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb', line 52

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Images',
    type: {
      name: 'Composite',
      class_name: 'Images',
      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'
          }
        },
        total_estimated_matches: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'totalEstimatedMatches',
          type: {
            name: 'Number'
          }
        },
        next_offset: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'nextOffset',
          type: {
            name: 'Number'
          }
        },
        value: {
          client_side_validation: true,
          required: true,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ImageObjectElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ImageObject'
                }
            }
          }
        },
        query_expansions: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'queryExpansions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        },
        pivot_suggestions: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'pivotSuggestions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PivotSuggestionsElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PivotSuggestions'
                }
            }
          }
        },
        similar_terms: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'similarTerms',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        }
      }
    }
  }
end