/
SearchOptions.cs
42 lines (38 loc) · 3.33 KB
/
SearchOptions.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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// <auto-generated/>
#nullable disable
using System.Collections.Generic;
using Azure.Search.Documents.Models;
namespace Azure.Search.Documents
{
/// <summary> Parameters for filtering, sorting, faceting, paging, and other search query behaviors. </summary>
public partial class SearchOptions
{
/// <summary> Initializes a new instance of <see cref="SearchOptions"/>. </summary>
public SearchOptions()
{
Facets = new ChangeTrackingList<string>();
ScoringParameters = new ChangeTrackingList<string>();
VectorQueries = new ChangeTrackingList<VectorQuery>();
}
/// <summary> A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. </summary>
public string HighlightPostTag { get; set; }
/// <summary> A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. </summary>
public string HighlightPreTag { get; set; }
/// <summary> A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. </summary>
public double? MinimumCoverage { get; set; }
/// <summary> A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. </summary>
public SearchQueryType? QueryType { get; set; }
/// <summary> A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. </summary>
public ScoringStatistics? ScoringStatistics { get; set; }
/// <summary> A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. </summary>
public string SessionId { get; set; }
/// <summary> The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. </summary>
public string ScoringProfile { get; set; }
/// <summary> A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. </summary>
public SearchMode? SearchMode { get; set; }
/// <summary> The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead. </summary>
public int? Skip { get; set; }
}
}