Class: Azure::CognitiveServices::LocalSearch::V1_0::Models::SearchResponse

Inherits:
Response show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb

Overview

Defines the top-level object that the response includes when the request succeeds.

Instance Attribute Summary collapse

Attributes inherited from Response

#adaptive_card, #immediate_action, #potential_action, #preferred_clickthrough_url, #read_link, #web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SearchResponse

Returns a new instance of SearchResponse.



17
18
19
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 17

def initialize
  @_type = "SearchResponse"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



21
22
23
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 21

def _type
  @_type
end

#lottery ⇒ SearchResultsAnswer

Returns:



35
36
37
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 35

def lottery
  @lottery
end

#places ⇒ Places

that are relevant to the query.

Returns:

  • (Places) —

    A list of local entities such as restaurants or hotels



32
33
34
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 32

def places
  @places
end

#query_context ⇒ QueryContext

Bing used for the request. This object contains the query string as entered by the user. It may also contain an altered query string that Bing used for the query if the query string contained a spelling mistake.

Returns:

  • (QueryContext) —

    An object that contains the query string that



28
29
30
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 28

def query_context
  @query_context
end

#search_results_confidence_score ⇒ Float

Returns:

  • (Float) 


38
39
40
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 38

def search_results_confidence_score
  @search_results_confidence_score
end

Class Method Details

.mapper ⇒ Object

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



45
46
47
48
49
50
51
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
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_response.rb', line 45

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SearchResponse',
    type: {
      name: 'Composite',
      class_name: 'SearchResponse',
      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'
          }
        },
        potential_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'potentialAction',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Action'
                }
            }
          }
        },
        immediate_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'immediateAction',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Action'
                }
            }
          }
        },
        preferred_clickthrough_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'preferredClickthroughUrl',
          type: {
            name: 'String'
          }
        },
        adaptive_card: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'adaptiveCard',
          type: {
            name: 'String'
          }
        },
        query_context: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'queryContext',
          type: {
            name: 'Composite',
            polymorphic_discriminator: '_type',
            uber_parent: 'QueryContext',
            class_name: 'QueryContext'
          }
        },
        places: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'places',
          type: {
            name: 'Composite',
            class_name: 'Places'
          }
        },
        lottery: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'lottery',
          type: {
            name: 'Composite',
            class_name: 'SearchResultsAnswer'
          }
        },
        search_results_confidence_score: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'searchResultsConfidenceScore',
          type: {
            name: 'Double'
          }
        }
      }
    }
  }
end