class Azure::CognitiveServices::ImageSearch::V1_0::Models::Images

Defines an image answer

Attributes

_type[RW]
next_offset[RW]

@return [Integer] Used as part of deduping. Tells client the next offset that client should use in the next pagination request

pivot_suggestions[RW]

@return [Array<PivotSuggestions>] A list of segments in the original 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.

query_expansions[RW]

@return [Array<Query>] A list of expanded queries that narrows the 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.

similar_terms[RW]

@return [Array<Query>] A list of terms that are similar in meaning to the user's query term.

value[RW]

@return [Array<ImageObject>] A list of image objects that are relevant to the query. If there are no results, the List is empty.

Private Class Methods

mapper() click to toggle source

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

# 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
new() click to toggle source
# File lib/1.0/generated/azure_cognitiveservices_imagesearch/models/images.rb, line 16
def initialize
  @_type = "Images"
end