class Azure::CognitiveServices::WebSearch::V1_0::Models::SpellSuggestions

Defines a suggested query string that likely represents the user's intent. The search results include this response if Bing determines that the user may have intended to search for something different. For example, if the user searches for alon brown, Bing may determine that the user likely intended to search for Alton Brown instead (based on past searches by others of Alon Brown).

Attributes

_type[RW]
value[RW]

@return [Array<Query>] A list of suggested query strings that may represent the user's intention. The list contains only one Query object.

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_websearch/models/spell_suggestions.rb, line 37
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SpellSuggestions',
    type: {
      name: 'Composite',
      class_name: 'SpellSuggestions',
      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'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        follow_up_queries: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'followUpQueries',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        },
        query_context: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'queryContext',
          type: {
            name: 'Composite',
            class_name: 'QueryContext'
          }
        },
        total_estimated_matches: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'totalEstimatedMatches',
          type: {
            name: 'Number'
          }
        },
        is_family_friendly: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'isFamilyFriendly',
          type: {
            name: 'Boolean'
          }
        },
        value: {
          client_side_validation: true,
          required: true,
          serialized_name: 'value',
          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_websearch/models/spell_suggestions.rb, line 21
def initialize
  @_type = "SpellSuggestions"
end