Class: Azure::CognitiveServices::LocalSearch::V1_0::Models::SearchResultsAnswer

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

Overview

Defines a search result answer.

Direct Known Subclasses

Places

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 ⇒ SearchResultsAnswer

Returns a new instance of SearchResultsAnswer.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_results_answer.rb', line 16

def initialize
  @_type = "SearchResultsAnswer"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_results_answer.rb', line 20

def _type
  @_type
end

#is_family_friendly ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_results_answer.rb', line 31

def is_family_friendly
  @is_family_friendly
end

#query_context ⇒ QueryContext

Returns:



23
24
25
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_results_answer.rb', line 23

def query_context
  @query_context
end

#total_estimated_matches ⇒ Integer

the query. Use this number along with the count and offset query parameters to page the results.

Returns:

  • (Integer) —

    The estimated number of webpages that are relevant to



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

def total_estimated_matches
  @total_estimated_matches
end

Class Method Details

.mapper ⇒ Object

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



38
39
40
41
42
43
44
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
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/search_results_answer.rb', line 38

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SearchResultsAnswer',
    type: {
      name: 'Composite',
      class_name: 'SearchResultsAnswer',
      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'
          }
        },
        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'
          }
        }
      }
    }
  }
end