Class SearchModelsRequestParameters

Request options for SearchModels

https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model

Inheritance

object

RequestParameters<SearchModelsRequestParameters>

SearchModelsRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<SearchModelsRequestParameters>.CustomResponseBuilder

RequestParameters<SearchModelsRequestParameters>.QueryString

RequestParameters<SearchModelsRequestParameters>.RequestConfiguration

RequestParameters<SearchModelsRequestParameters>.ContainsQueryString(string)

RequestParameters<SearchModelsRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<SearchModelsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<SearchModelsRequestParameters>.SetQueryString(string, object)

RequestParameters<SearchModelsRequestParameters>.Q<TOut>(string)

RequestParameters<SearchModelsRequestParameters>.Q(string, object)

RequestParameters<SearchModelsRequestParameters>.SetAcceptHeader(string)

RequestParameters<SearchModelsRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.KnnApi

Assembly: OpenSearch.Net.dll

Syntax

public class SearchModelsRequestParameters : RequestParameters<SearchModelsRequestParameters>, IRequestParameters

Properties

AllowNoIndices

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified).

Declaration

public bool? AllowNoIndices { get; set; }

Property Value

Type	Description
bool?

AllowPartialSearchResults

Indicate if an error should be returned if there is a partial search failure or timeout.

Declaration

public bool? AllowPartialSearchResults { get; set; }

Property Value

Type	Description
bool?

AnalyzeWildcard

Specify whether wildcard and prefix queries should be analyzed.

Declaration

public bool? AnalyzeWildcard { get; set; }

Property Value

Type	Description
bool?

Analyzer

The analyzer to use for the query string.

Declaration

public string Analyzer { get; set; }

Property Value

Type	Description
string

BatchedReduceSize

The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.

Declaration

public long? BatchedReduceSize { get; set; }

Property Value

Type	Description
long?

CcsMinimizeRoundtrips

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.

Declaration

public bool? CcsMinimizeRoundtrips { get; set; }

Property Value

Type	Description
bool?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<SearchModelsRequestParameters>.DefaultHttpMethod

DefaultOperator

The default operator for query string query (AND or OR).

Declaration

public KnnDefaultOperator? DefaultOperator { get; set; }

Property Value

Type	Description
KnnDefaultOperator?

Df

The field to use as default where no field prefix is given in the query string.

Declaration

public string Df { get; set; }

Property Value

Type	Description
string

DocValueFields

Comma-separated list of fields to return as the docvalue representation of a field for each hit.

Declaration

public string[] DocValueFields { get; set; }

Property Value

Type	Description
string[]

ExpandWildcards

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Declaration

public ExpandWildcards? ExpandWildcards { get; set; }

Property Value

Type	Description
ExpandWildcards?

Explain

Specify whether to return detailed information about score computation as part of a hit.

Declaration

public bool? Explain { get; set; }

Property Value

Type	Description
bool?

From

Starting offset.

Declaration

public long? From { get; set; }

Property Value

Type	Description
long?

IgnoreThrottled

Whether specified concrete, expanded or aliased indices should be ignored when throttled.

Declaration

public bool? IgnoreThrottled { get; set; }

Property Value

Type	Description
bool?

IgnoreUnavailable

Whether specified concrete indices should be ignored when unavailable (missing or closed).

Declaration

public bool? IgnoreUnavailable { get; set; }

Property Value

Type	Description
bool?

Lenient

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.

Declaration

public bool? Lenient { get; set; }

Property Value

Type	Description
bool?

MaxConcurrentShardRequests

The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.

Declaration

public long? MaxConcurrentShardRequests { get; set; }

Property Value

Type	Description
long?

PreFilterShardSize

Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.

Declaration

public long? PreFilterShardSize { get; set; }

Property Value

Type	Description
long?

Preference

Specify the node or shard the operation should be performed on.

Declaration

public string Preference { get; set; }

Property Value

Type	Description
string

QueryOnQueryString

Query in the Lucene query string syntax.

Declaration

public string QueryOnQueryString { get; set; }

Property Value

Type	Description
string

RequestCache

Specify if request cache should be used for this request or not, defaults to index level setting.

Declaration

public bool? RequestCache { get; set; }

Property Value

Type	Description
bool?

Routing

Comma-separated list of specific routing values.

Declaration

public string[] Routing { get; set; }

Property Value

Type	Description
string[]

Scroll

Specify how long a consistent view of the index should be maintained for scrolled search.

Declaration

public TimeSpan Scroll { get; set; }

Property Value

Type	Description
TimeSpan

SearchType

Search operation type.

Declaration

public KnnSearchType? SearchType { get; set; }

Property Value

Type	Description
KnnSearchType?

SequenceNumberPrimaryTerm

Specify whether to return sequence number and primary term of the last modification of each hit.

Declaration

public bool? SequenceNumberPrimaryTerm { get; set; }

Property Value

Type	Description
bool?

Size

Number of hits to return.

Declaration

public long? Size { get; set; }

Property Value

Type	Description
long?

Sort

Comma-separated list of <field>:<direction> pairs.

Declaration

public string[] Sort { get; set; }

Property Value

Type	Description
string[]

SourceEnabled

True or false to return the _source field or not, or a list of fields to return.

Declaration

public bool? SourceEnabled { get; set; }

Property Value

Type	Description
bool?

SourceExcludes

List of fields to exclude from the returned _source field.

Declaration

public string[] SourceExcludes { get; set; }

Property Value

Type	Description
string[]

SourceIncludes

List of fields to extract and return from the _source field.

Declaration

public string[] SourceIncludes { get; set; }

Property Value

Type	Description
string[]

Stats

Specific 'tag' of the request for logging and statistical purposes.

Declaration

public string[] Stats { get; set; }

Property Value

Type	Description
string[]

StoredFields

Comma-separated list of stored fields to return.

Declaration

public string[] StoredFields { get; set; }

Property Value

Type	Description
string[]

SuggestField

Specify which field to use for suggestions.

Declaration

public string SuggestField { get; set; }

Property Value

Type	Description
string

SuggestMode

Specify suggest mode.

Declaration

public KnnSuggestMode? SuggestMode { get; set; }

Property Value

Type	Description
KnnSuggestMode?

SuggestSize

How many suggestions to return in response.

Declaration

public long? SuggestSize { get; set; }

Property Value

Type	Description
long?

SuggestText

The source text for which the suggestions should be returned.

Declaration

public string SuggestText { get; set; }

Property Value

Type	Description
string

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<SearchModelsRequestParameters>.SupportsBody

TerminateAfter

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

Declaration

public long? TerminateAfter { get; set; }

Property Value

Type	Description
long?

Timeout

Operation timeout.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

TotalHitsAsInteger

Indicates whether hits.total should be rendered as an integer or an object in the rest search response.

Declaration

public bool? TotalHitsAsInteger { get; set; }

Property Value

Type	Description
bool?

TrackScores

Whether to calculate and return scores even if they are not used for sorting.

Declaration

public bool? TrackScores { get; set; }

Property Value

Type	Description
bool?

TrackTotalHits

Indicate if the number of documents that match the query should be tracked.

Declaration

public bool? TrackTotalHits { get; set; }

Property Value

Type	Description
bool?

TypedKeys

Specify whether aggregation and suggester names should be prefixed by their respective types in the response.

Declaration

public bool? TypedKeys { get; set; }

Property Value

Type	Description
bool?

Version

Whether to return document version as part of a hit.

Declaration

public bool? Version { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)