Class: Azure::CognitiveServices::CustomSearch::V1_0::Models::WebWebAnswer

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

Overview

Defines a list of relevant webpage links.

Instance Attribute Summary collapse

Attributes inherited from SearchResultsAnswer

#is_family_friendly, #query_context, #total_estimated_matches

Attributes inherited from Answer

#follow_up_queries

Attributes inherited from Response

#web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebWebAnswer

Returns a new instance of WebWebAnswer.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb', line 16

def initialize
  @_type = "Web/WebAnswer"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb', line 20

def _type
  @_type
end

#some_results_removed ⇒ Boolean

excluded some results from the answer. If Bing excluded some results, the value is true.

Returns:

  • (Boolean) —

    A Boolean value that indicates whether the response



29
30
31
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb', line 29

def some_results_removed
  @some_results_removed
end

#value ⇒ Array<WebPage>

query.

Returns:

  • (Array<WebPage>) —

    A list of webpages that are relevant to the



24
25
26
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb', line 24

def value
  @value
end

Class Method Details

.mapper ⇒ Object

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



36
37
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
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_web_answer.rb', line 36

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Web/WebAnswer',
    type: {
      name: 'Composite',
      class_name: 'WebWebAnswer',
      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: 'WebPageElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WebPage'
                }
            }
          }
        },
        some_results_removed: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'someResultsRemoved',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end