-
Notifications
You must be signed in to change notification settings - Fork 180
/
SuggestDocumentsResult.yml
47 lines (44 loc) · 1.43 KB
/
SuggestDocumentsResult.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
### YamlMime:TSType
name: SuggestDocumentsResult
uid: '@azure/search-documents.SuggestDocumentsResult'
package: '@azure/search-documents'
summary: Response containing suggestion query results from an index.
fullName: SuggestDocumentsResult<TModel, TFields>
remarks: ''
isDeprecated: false
type: interface
properties:
- name: coverage
uid: '@azure/search-documents.SuggestDocumentsResult.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 set 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
- name: results
uid: '@azure/search-documents.SuggestDocumentsResult.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: SuggestResult<TModel, TFields>[]'
return:
description: ''
type: >-
<xref uid="@azure/search-documents.SuggestResult" /><TModel,
TFields>[]