-
Notifications
You must be signed in to change notification settings - Fork 124
/
QueryResponse.cs
70 lines (67 loc) · 2.76 KB
/
QueryResponse.cs
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
/**
* (C) Copyright IBM Corp. 2019, 2020.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
using System.Collections.Generic;
using Newtonsoft.Json;
namespace IBM.Watson.Discovery.v2.Model
{
/// <summary>
/// A response containing the documents and aggregations for the query.
/// </summary>
public class QueryResponse
{
/// <summary>
/// The number of matching results for the query.
/// </summary>
[JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)]
public long? MatchingResults { get; set; }
/// <summary>
/// Array of document results for the query.
/// </summary>
[JsonProperty("results", NullValueHandling = NullValueHandling.Ignore)]
public List<QueryResult> Results { get; set; }
/// <summary>
/// Array of aggregations for the query.
/// </summary>
[JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)]
public List<QueryAggregation> Aggregations { get; set; }
/// <summary>
/// An object contain retrieval type information.
/// </summary>
[JsonProperty("retrieval_details", NullValueHandling = NullValueHandling.Ignore)]
public RetrievalDetails RetrievalDetails { get; set; }
/// <summary>
/// Suggested correction to the submitted **natural_language_query** value.
/// </summary>
[JsonProperty("suggested_query", NullValueHandling = NullValueHandling.Ignore)]
public string SuggestedQuery { get; set; }
/// <summary>
/// Array of suggested refinements.
/// </summary>
[JsonProperty("suggested_refinements", NullValueHandling = NullValueHandling.Ignore)]
public List<QuerySuggestedRefinement> SuggestedRefinements { get; set; }
/// <summary>
/// Array of table results.
/// </summary>
[JsonProperty("table_results", NullValueHandling = NullValueHandling.Ignore)]
public List<QueryTableResult> TableResults { get; set; }
/// <summary>
/// Passages returned by Discovery.
/// </summary>
[JsonProperty("passages", NullValueHandling = NullValueHandling.Ignore)]
public List<QueryResponsePassage> Passages { get; set; }
}
}