/
SearchDocumentsResult.yml
165 lines (152 loc) · 5.79 KB
/
SearchDocumentsResult.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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
### YamlMime:TSType
name: SearchDocumentsResult
uid: '@azure/search-documents.SearchDocumentsResult'
package: '@azure/search-documents'
summary: Response containing search results from an index.
fullName: SearchDocumentsResult<TModel, TFields>
remarks: ''
isDeprecated: false
type: interface
properties:
- name: results
uid: '@azure/search-documents.SearchDocumentsResult.results'
package: '@azure/search-documents'
summary: >-
The sequence of results returned by the query.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: results
remarks: ''
isDeprecated: false
syntax:
content: 'results: SearchIterator<TModel, TFields>'
return:
description: ''
type: >-
<xref uid="@azure/search-documents.SearchIterator" /><TModel,
TFields>
inheritedProperties:
- name: answers
uid: '@azure/search-documents.SearchDocumentsResult.answers'
package: '@azure/search-documents'
summary: >-
The answers query results for the search operation; null if the answers
query parameter was
not specified or set to 'none'.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: answers
remarks: ''
isDeprecated: false
syntax:
content: 'answers?: QueryAnswerResult[]'
return:
description: ''
type: <xref uid="@azure/search-documents.QueryAnswerResult" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[SearchDocumentsResultBase.answers](xref:@azure/search-documents.SearchDocumentsResultBase.answers)
- name: count
uid: '@azure/search-documents.SearchDocumentsResult.count'
package: '@azure/search-documents'
summary: >-
The total count of results found by the search operation, or null if the
count was not
requested. If present, the count may be greater than the number of results
in this response.
This can happen if you use the $top or $skip parameters, or if Azure
Cognitive Search can't
return all the requested documents in a single Search response.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: count
remarks: ''
isDeprecated: false
syntax:
content: 'count?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[SearchDocumentsResultBase.count](xref:@azure/search-documents.SearchDocumentsResultBase.count)
- name: coverage
uid: '@azure/search-documents.SearchDocumentsResult.coverage'
package: '@azure/search-documents'
summary: >-
A value indicating the percentage of the index that was included in the
query, or null if
minimumCoverage was not specified in the request.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: coverage
remarks: ''
isDeprecated: false
syntax:
content: 'coverage?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[SearchDocumentsResultBase.coverage](xref:@azure/search-documents.SearchDocumentsResultBase.coverage)
- name: facets
uid: '@azure/search-documents.SearchDocumentsResult.facets'
package: '@azure/search-documents'
summary: >-
The facet query results for the search operation, organized as a
collection of buckets for
each faceted field; null if the query did not include any facet
expressions.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: facets
remarks: ''
isDeprecated: false
syntax:
content: 'facets?: {[propertyName: string]: FacetResult[]}'
return:
description: ''
type: >-
{[propertyName: string]: <xref
uid="@azure/search-documents.FacetResult" />[]}
inheritanceDescription: >-
<b>Inherited From</b>
[SearchDocumentsResultBase.facets](xref:@azure/search-documents.SearchDocumentsResultBase.facets)
- name: semanticErrorReason
uid: '@azure/search-documents.SearchDocumentsResult.semanticErrorReason'
package: '@azure/search-documents'
summary: >-
Reason that a partial response was returned for a semantic search request.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: semanticErrorReason
remarks: ''
isDeprecated: false
syntax:
content: 'semanticErrorReason?: SemanticErrorReason'
return:
description: ''
type: <xref uid="@azure/search-documents.SemanticErrorReason" />
inheritanceDescription: >-
<b>Inherited From</b>
[SearchDocumentsResultBase.semanticErrorReason](xref:@azure/search-documents.SearchDocumentsResultBase.semanticErrorReason)
- name: semanticSearchResultsType
uid: '@azure/search-documents.SearchDocumentsResult.semanticSearchResultsType'
package: '@azure/search-documents'
summary: >-
Type of partial response that was returned for a semantic search request.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: semanticSearchResultsType
remarks: ''
isDeprecated: false
syntax:
content: 'semanticSearchResultsType?: SemanticSearchResultsType'
return:
description: ''
type: <xref uid="@azure/search-documents.SemanticSearchResultsType" />
inheritanceDescription: >-
<b>Inherited From</b>
[SearchDocumentsResultBase.semanticSearchResultsType](xref:@azure/search-documents.SearchDocumentsResultBase.semanticSearchResultsType)
extends: <xref uid="@azure/search-documents.SearchDocumentsResultBase" />