| | | 1 | | // <auto-generated> |
| | | 2 | | // Copyright (c) Microsoft Corporation. All rights reserved. |
| | | 3 | | // Licensed under the MIT License. See License.txt in the project root for |
| | | 4 | | // license information. |
| | | 5 | | // |
| | | 6 | | // Code generated by Microsoft (R) AutoRest Code Generator. |
| | | 7 | | // Changes may cause incorrect behavior and will be lost if the code is |
| | | 8 | | // regenerated. |
| | | 9 | | // </auto-generated> |
| | | 10 | | |
| | | 11 | | namespace Microsoft.Azure.Search.Models |
| | | 12 | | { |
| | | 13 | | using Newtonsoft.Json; |
| | | 14 | | using System.Collections; |
| | | 15 | | using System.Collections.Generic; |
| | | 16 | | using System.Linq; |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Parameters for filtering, sorting, faceting, paging, and other search |
| | | 20 | | /// query behaviors. |
| | | 21 | | /// </summary> |
| | | 22 | | internal partial class SearchRequest |
| | | 23 | | { |
| | | 24 | | /// <summary> |
| | | 25 | | /// Initializes a new instance of the SearchRequest class. |
| | | 26 | | /// </summary> |
| | 130 | 27 | | public SearchRequest() |
| | | 28 | | { |
| | | 29 | | CustomInit(); |
| | 130 | 30 | | } |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// Initializes a new instance of the SearchRequest class. |
| | | 34 | | /// </summary> |
| | | 35 | | /// <param name="includeTotalResultCount">A value that specifies |
| | | 36 | | /// whether to fetch the total count of results. Default is false. |
| | | 37 | | /// Setting this value to true may have a performance impact. Note that |
| | | 38 | | /// the count returned is an approximation.</param> |
| | | 39 | | /// <param name="facets">The list of facet expressions to apply to the |
| | | 40 | | /// search query. Each facet expression contains a field name, |
| | | 41 | | /// optionally followed by a comma-separated list of name:value |
| | | 42 | | /// pairs.</param> |
| | | 43 | | /// <param name="filter">The OData $filter expression to apply to the |
| | | 44 | | /// search query.</param> |
| | | 45 | | /// <param name="highlightFields">The comma-separated list of field |
| | | 46 | | /// names to use for hit highlights. Only searchable fields can be used |
| | | 47 | | /// for hit highlighting.</param> |
| | | 48 | | /// <param name="highlightPostTag">A string tag that is appended to hit |
| | | 49 | | /// highlights. Must be set with highlightPreTag. Default is |
| | | 50 | | /// &lt;/em&gt;.</param> |
| | | 51 | | /// <param name="highlightPreTag">A string tag that is prepended to hit |
| | | 52 | | /// highlights. Must be set with highlightPostTag. Default is |
| | | 53 | | /// &lt;em&gt;.</param> |
| | | 54 | | /// <param name="minimumCoverage">A number between 0 and 100 indicating |
| | | 55 | | /// the percentage of the index that must be covered by a search query |
| | | 56 | | /// in order for the query to be reported as a success. This parameter |
| | | 57 | | /// can be useful for ensuring search availability even for services |
| | | 58 | | /// with only one replica. The default is 100.</param> |
| | | 59 | | /// <param name="orderBy">The comma-separated list of OData $orderby |
| | | 60 | | /// expressions by which to sort the results. Each expression can be |
| | | 61 | | /// either a field name or a call to either the geo.distance() or the |
| | | 62 | | /// search.score() functions. Each expression can be followed by asc to |
| | | 63 | | /// indicate ascending, or desc to indicate descending. The default is |
| | | 64 | | /// ascending order. Ties will be broken by the match scores of |
| | | 65 | | /// documents. If no $orderby is specified, the default sort order is |
| | | 66 | | /// descending by document match score. There can be at most 32 |
| | | 67 | | /// $orderby clauses.</param> |
| | | 68 | | /// <param name="queryType">A value that specifies the syntax of the |
| | | 69 | | /// search query. The default is 'simple'. Use 'full' if your query |
| | | 70 | | /// uses the Lucene query syntax. Possible values include: 'simple', |
| | | 71 | | /// 'full'</param> |
| | | 72 | | /// <param name="scoringParameters">The list of parameter values to be |
| | | 73 | | /// used in scoring functions (for example, referencePointParameter) |
| | | 74 | | /// using the format name-values. For example, if the scoring profile |
| | | 75 | | /// defines a function with a parameter called 'mylocation' the |
| | | 76 | | /// parameter string would be "mylocation--122.2,44.8" (without the |
| | | 77 | | /// quotes).</param> |
| | | 78 | | /// <param name="scoringProfile">The name of a scoring profile to |
| | | 79 | | /// evaluate match scores for matching documents in order to sort the |
| | | 80 | | /// results.</param> |
| | | 81 | | /// <param name="searchText">A full-text search query expression; Use |
| | | 82 | | /// "*" or omit this parameter to match all documents.</param> |
| | | 83 | | /// <param name="searchFields">The comma-separated list of field names |
| | | 84 | | /// to which to scope the full-text search. When using fielded search |
| | | 85 | | /// (fieldName:searchExpression) in a full Lucene query, the field |
| | | 86 | | /// names of each fielded search expression take precedence over any |
| | | 87 | | /// field names listed in this parameter.</param> |
| | | 88 | | /// <param name="searchMode">A value that specifies whether any or all |
| | | 89 | | /// of the search terms must be matched in order to count the document |
| | | 90 | | /// as a match. Possible values include: 'any', 'all'</param> |
| | | 91 | | /// <param name="select">The comma-separated list of fields to |
| | | 92 | | /// retrieve. If unspecified, all fields marked as retrievable in the |
| | | 93 | | /// schema are included.</param> |
| | | 94 | | /// <param name="skip">The number of search results to skip. This value |
| | | 95 | | /// cannot be greater than 100,000. If you need to scan documents in |
| | | 96 | | /// sequence, but cannot use skip due to this limitation, consider |
| | | 97 | | /// using orderby on a totally-ordered key and filter with a range |
| | | 98 | | /// query instead.</param> |
| | | 99 | | /// <param name="top">The number of search results to retrieve. This |
| | | 100 | | /// can be used in conjunction with $skip to implement client-side |
| | | 101 | | /// paging of search results. If results are truncated due to |
| | | 102 | | /// server-side paging, the response will include a continuation token |
| | | 103 | | /// that can be used to issue another Search request for the next page |
| | | 104 | | /// of results.</param> |
| | 0 | 105 | | public SearchRequest(bool? includeTotalResultCount = default(bool?), IList<string> facets = default(IList<string |
| | | 106 | | { |
| | 0 | 107 | | IncludeTotalResultCount = includeTotalResultCount; |
| | 0 | 108 | | Facets = facets; |
| | 0 | 109 | | Filter = filter; |
| | 0 | 110 | | HighlightFields = highlightFields; |
| | 0 | 111 | | HighlightPostTag = highlightPostTag; |
| | 0 | 112 | | HighlightPreTag = highlightPreTag; |
| | 0 | 113 | | MinimumCoverage = minimumCoverage; |
| | 0 | 114 | | OrderBy = orderBy; |
| | 0 | 115 | | QueryType = queryType; |
| | 0 | 116 | | ScoringParameters = scoringParameters; |
| | 0 | 117 | | ScoringProfile = scoringProfile; |
| | 0 | 118 | | SearchText = searchText; |
| | 0 | 119 | | SearchFields = searchFields; |
| | 0 | 120 | | SearchMode = searchMode; |
| | 0 | 121 | | Select = select; |
| | 0 | 122 | | Skip = skip; |
| | 0 | 123 | | Top = top; |
| | | 124 | | CustomInit(); |
| | 0 | 125 | | } |
| | | 126 | | |
| | | 127 | | /// <summary> |
| | | 128 | | /// An initialization method that performs custom operations like setting defaults |
| | | 129 | | /// </summary> |
| | | 130 | | partial void CustomInit(); |
| | | 131 | | |
| | | 132 | | /// <summary> |
| | | 133 | | /// Gets or sets a value that specifies whether to fetch the total |
| | | 134 | | /// count of results. Default is false. Setting this value to true may |
| | | 135 | | /// have a performance impact. Note that the count returned is an |
| | | 136 | | /// approximation. |
| | | 137 | | /// </summary> |
| | | 138 | | [JsonProperty(PropertyName = "count")] |
| | 238 | 139 | | public bool? IncludeTotalResultCount { get; set; } |
| | | 140 | | |
| | | 141 | | /// <summary> |
| | | 142 | | /// Gets or sets the list of facet expressions to apply to the search |
| | | 143 | | /// query. Each facet expression contains a field name, optionally |
| | | 144 | | /// followed by a comma-separated list of name:value pairs. |
| | | 145 | | /// </summary> |
| | | 146 | | [JsonProperty(PropertyName = "facets")] |
| | 266 | 147 | | public IList<string> Facets { get; set; } |
| | | 148 | | |
| | | 149 | | /// <summary> |
| | | 150 | | /// Gets or sets the OData $filter expression to apply to the search |
| | | 151 | | /// query. |
| | | 152 | | /// </summary> |
| | | 153 | | [JsonProperty(PropertyName = "filter")] |
| | 220 | 154 | | public string Filter { get; set; } |
| | | 155 | | |
| | | 156 | | /// <summary> |
| | | 157 | | /// Gets or sets the comma-separated list of field names to use for hit |
| | | 158 | | /// highlights. Only searchable fields can be used for hit |
| | | 159 | | /// highlighting. |
| | | 160 | | /// </summary> |
| | | 161 | | [JsonProperty(PropertyName = "highlight")] |
| | 220 | 162 | | public string HighlightFields { get; set; } |
| | | 163 | | |
| | | 164 | | /// <summary> |
| | | 165 | | /// Gets or sets a string tag that is appended to hit highlights. Must |
| | | 166 | | /// be set with highlightPreTag. Default is |
| | | 167 | | /// &amp;lt;/em&amp;gt;. |
| | | 168 | | /// </summary> |
| | | 169 | | [JsonProperty(PropertyName = "highlightPostTag")] |
| | 220 | 170 | | public string HighlightPostTag { get; set; } |
| | | 171 | | |
| | | 172 | | /// <summary> |
| | | 173 | | /// Gets or sets a string tag that is prepended to hit highlights. Must |
| | | 174 | | /// be set with highlightPostTag. Default is |
| | | 175 | | /// &amp;lt;em&amp;gt;. |
| | | 176 | | /// </summary> |
| | | 177 | | [JsonProperty(PropertyName = "highlightPreTag")] |
| | 220 | 178 | | public string HighlightPreTag { get; set; } |
| | | 179 | | |
| | | 180 | | /// <summary> |
| | | 181 | | /// Gets or sets a number between 0 and 100 indicating the percentage |
| | | 182 | | /// of the index that must be covered by a search query in order for |
| | | 183 | | /// the query to be reported as a success. This parameter can be useful |
| | | 184 | | /// for ensuring search availability even for services with only one |
| | | 185 | | /// replica. The default is 100. |
| | | 186 | | /// </summary> |
| | | 187 | | [JsonProperty(PropertyName = "minimumCoverage")] |
| | 220 | 188 | | public double? MinimumCoverage { get; set; } |
| | | 189 | | |
| | | 190 | | /// <summary> |
| | | 191 | | /// Gets or sets the comma-separated list of OData $orderby expressions |
| | | 192 | | /// by which to sort the results. Each expression can be either a field |
| | | 193 | | /// name or a call to either the geo.distance() or the search.score() |
| | | 194 | | /// functions. Each expression can be followed by asc to indicate |
| | | 195 | | /// ascending, or desc to indicate descending. The default is ascending |
| | | 196 | | /// order. Ties will be broken by the match scores of documents. If no |
| | | 197 | | /// $orderby is specified, the default sort order is descending by |
| | | 198 | | /// document match score. There can be at most 32 $orderby clauses. |
| | | 199 | | /// </summary> |
| | | 200 | | [JsonProperty(PropertyName = "orderby")] |
| | 234 | 201 | | public string OrderBy { get; set; } |
| | | 202 | | |
| | | 203 | | /// <summary> |
| | | 204 | | /// Gets or sets a value that specifies the syntax of the search query. |
| | | 205 | | /// The default is 'simple'. Use 'full' if your query uses the Lucene |
| | | 206 | | /// query syntax. Possible values include: 'simple', 'full' |
| | | 207 | | /// </summary> |
| | | 208 | | [JsonProperty(PropertyName = "queryType")] |
| | 264 | 209 | | public QueryType? QueryType { get; set; } |
| | | 210 | | |
| | | 211 | | /// <summary> |
| | | 212 | | /// Gets or sets the list of parameter values to be used in scoring |
| | | 213 | | /// functions (for example, referencePointParameter) using the format |
| | | 214 | | /// name-values. For example, if the scoring profile defines a function |
| | | 215 | | /// with a parameter called 'mylocation' the parameter string would be |
| | | 216 | | /// "mylocation--122.2,44.8" (without the quotes). |
| | | 217 | | /// </summary> |
| | | 218 | | [JsonProperty(PropertyName = "scoringParameters")] |
| | 266 | 219 | | public IList<string> ScoringParameters { get; set; } |
| | | 220 | | |
| | | 221 | | /// <summary> |
| | | 222 | | /// Gets or sets the name of a scoring profile to evaluate match scores |
| | | 223 | | /// for matching documents in order to sort the results. |
| | | 224 | | /// </summary> |
| | | 225 | | [JsonProperty(PropertyName = "scoringProfile")] |
| | 220 | 226 | | public string ScoringProfile { get; set; } |
| | | 227 | | |
| | | 228 | | /// <summary> |
| | | 229 | | /// Gets or sets a full-text search query expression; Use "*" or omit |
| | | 230 | | /// this parameter to match all documents. |
| | | 231 | | /// </summary> |
| | | 232 | | [JsonProperty(PropertyName = "search")] |
| | 238 | 233 | | public string SearchText { get; set; } |
| | | 234 | | |
| | | 235 | | /// <summary> |
| | | 236 | | /// Gets or sets the comma-separated list of field names to which to |
| | | 237 | | /// scope the full-text search. When using fielded search |
| | | 238 | | /// (fieldName:searchExpression) in a full Lucene query, the field |
| | | 239 | | /// names of each fielded search expression take precedence over any |
| | | 240 | | /// field names listed in this parameter. |
| | | 241 | | /// </summary> |
| | | 242 | | [JsonProperty(PropertyName = "searchFields")] |
| | 220 | 243 | | public string SearchFields { get; set; } |
| | | 244 | | |
| | | 245 | | /// <summary> |
| | | 246 | | /// Gets or sets a value that specifies whether any or all of the |
| | | 247 | | /// search terms must be matched in order to count the document as a |
| | | 248 | | /// match. Possible values include: 'any', 'all' |
| | | 249 | | /// </summary> |
| | | 250 | | [JsonProperty(PropertyName = "searchMode")] |
| | 264 | 251 | | public SearchMode? SearchMode { get; set; } |
| | | 252 | | |
| | | 253 | | /// <summary> |
| | | 254 | | /// Gets or sets the comma-separated list of fields to retrieve. If |
| | | 255 | | /// unspecified, all fields marked as retrievable in the schema are |
| | | 256 | | /// included. |
| | | 257 | | /// </summary> |
| | | 258 | | [JsonProperty(PropertyName = "select")] |
| | 234 | 259 | | public string Select { get; set; } |
| | | 260 | | |
| | | 261 | | /// <summary> |
| | | 262 | | /// Gets or sets the number of search results to skip. This value |
| | | 263 | | /// cannot be greater than 100,000. If you need to scan documents in |
| | | 264 | | /// sequence, but cannot use skip due to this limitation, consider |
| | | 265 | | /// using orderby on a totally-ordered key and filter with a range |
| | | 266 | | /// query instead. |
| | | 267 | | /// </summary> |
| | | 268 | | [JsonProperty(PropertyName = "skip")] |
| | 238 | 269 | | public int? Skip { get; set; } |
| | | 270 | | |
| | | 271 | | /// <summary> |
| | | 272 | | /// Gets or sets the number of search results to retrieve. This can be |
| | | 273 | | /// used in conjunction with $skip to implement client-side paging of |
| | | 274 | | /// search results. If results are truncated due to server-side paging, |
| | | 275 | | /// the response will include a continuation token that can be used to |
| | | 276 | | /// issue another Search request for the next page of results. |
| | | 277 | | /// </summary> |
| | | 278 | | [JsonProperty(PropertyName = "top")] |
| | 232 | 279 | | public int? Top { get; set; } |
| | | 280 | | |
| | | 281 | | } |
| | | 282 | | } |