/
WebSearchModels.SpellSuggestions.yml
144 lines (135 loc) · 4.38 KB
/
WebSearchModels.SpellSuggestions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
### YamlMime:TSType
name: SpellSuggestions
uid: '@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions'
package: '@azure/cognitiveservices-websearch'
summary: >-
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).
fullName: SpellSuggestions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: followUpQueries
uid: >-
@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.followUpQueries
package: '@azure/cognitiveservices-websearch'
summary: >-
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: followUpQueries
remarks: ''
isDeprecated: false
syntax:
content: 'followUpQueries?: Query[]'
return:
description: ''
type: >-
<xref uid="@azure/cognitiveservices-websearch.WebSearchModels.Query"
/>[]
- name: id
uid: '@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.id'
package: '@azure/cognitiveservices-websearch'
summary: >-
A String identifier.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
- name: isFamilyFriendly
uid: >-
@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.isFamilyFriendly
package: '@azure/cognitiveservices-websearch'
summary: >-
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: isFamilyFriendly
remarks: ''
isDeprecated: false
syntax:
content: 'isFamilyFriendly?: boolean'
return:
description: ''
type: boolean
- name: queryContext
uid: >-
@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.queryContext
package: '@azure/cognitiveservices-websearch'
summary: >-
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: queryContext
remarks: ''
isDeprecated: false
syntax:
content: 'queryContext?: QueryContext'
return:
description: ''
type: >-
<xref
uid="@azure/cognitiveservices-websearch.WebSearchModels.QueryContext"
/>
- name: totalEstimatedMatches
uid: >-
@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.totalEstimatedMatches
package: '@azure/cognitiveservices-websearch'
summary: >-
The estimated number of webpages that are relevant to the query. Use this
number along with
the count and offset query parameters to page the results.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: totalEstimatedMatches
remarks: ''
isDeprecated: false
syntax:
content: 'totalEstimatedMatches?: number'
return:
description: ''
type: number
- name: value
uid: '@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.value'
package: '@azure/cognitiveservices-websearch'
summary: >-
A list of suggested query strings that may represent the user's intention.
The list contains
only one Query object.
fullName: value
remarks: ''
isDeprecated: false
syntax:
content: 'value: Query[]'
return:
description: ''
type: >-
<xref uid="@azure/cognitiveservices-websearch.WebSearchModels.Query"
/>[]
- name: webSearchUrl
uid: >-
@azure/cognitiveservices-websearch.WebSearchModels.SpellSuggestions.webSearchUrl
package: '@azure/cognitiveservices-websearch'
summary: >-
The URL To Bing's search result for this item.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: webSearchUrl
remarks: ''
isDeprecated: false
syntax:
content: 'webSearchUrl?: string'
return:
description: ''
type: string