Class SearchModelsRequestParameters

Request options for SearchModels

<p>https://docs.opensearch.org/latest/vector-search/api/knn/#search-for-a-model</p>
Inheritance
object
RequestParameters<SearchModelsRequestParameters>
SearchModelsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.KnnApi
Assembly: OpenSearch.Net.dll
Syntax
public class SearchModelsRequestParameters : RequestParameters<SearchModelsRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

AllowNoIndices

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

Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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?
| Edit this page View Source

AnalyzeWildcard

Specify whether wildcard and prefix queries should be analyzed.

Declaration
public bool? AnalyzeWildcard { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Analyzer

The analyzer to use for the query string.

Declaration
public string Analyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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 int? BatchedReduceSize { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

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?
| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

DefaultOperator

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

Declaration
public DefaultOperator? DefaultOperator { get; set; }
Property Value
Type Description
DefaultOperator?
| Edit this page View Source

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
| Edit this page View Source

DocValueFields

A 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[]
| Edit this page View Source

ExpandWildcards

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

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

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?
| Edit this page View Source

From

Starting offset.

Declaration
public int? From { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

IgnoreThrottled

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

Declaration
public bool? IgnoreThrottled { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IgnoreUnavailable

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

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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?
| Edit this page View Source

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 int? MaxConcurrentShardRequests { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

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, that is if date filters are mandatory to match but the shard bounds and the query are disjoint.

Declaration
public int? PreFilterShardSize { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Preference

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

Declaration
public string Preference { get; set; }
Property Value
Type Description
string
| Edit this page View Source

QueryOnQueryString

Query in the Lucene query string syntax.

Declaration
public string QueryOnQueryString { get; set; }
Property Value
Type Description
string
| Edit this page View Source

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?
| Edit this page View Source

Routing

A comma-separated list of specific routing values.

Declaration
public string[] Routing { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

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
| Edit this page View Source

SearchType

Search operation type.

Declaration
public SearchType? SearchType { get; set; }
Property Value
Type Description
SearchType?
| Edit this page View Source

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?
| Edit this page View Source

Size

Number of hits to return.

Declaration
public int? Size { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Sort

A comma-separated list of <field>:<direction> pairs.

Declaration
public string[] Sort { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SourceEnabled

Set to 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?
| Edit this page View Source

SourceExcludes

List of fields to exclude from the returned _source field.

Declaration
public string[] SourceExcludes { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SourceIncludes

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

Declaration
public string[] SourceIncludes { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Stats

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

Declaration
public string[] Stats { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

StoredFields

A comma-separated list of stored fields to return.

Declaration
public string[] StoredFields { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SuggestField

Specify which field to use for suggestions.

Declaration
public string SuggestField { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SuggestMode

Specify suggest mode.

Declaration
public SuggestMode? SuggestMode { get; set; }
Property Value
Type Description
SuggestMode?
| Edit this page View Source

SuggestSize

How many suggestions to return in response.

Declaration
public int? SuggestSize { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

SuggestText

The source text for which the suggestions should be returned.

Declaration
public string SuggestText { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

TerminateAfter

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

Declaration
public int? TerminateAfter { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Timeout

Operation timeout.

Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

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?
| Edit this page View Source

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?
| Edit this page View Source

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?
| Edit this page View Source

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?
| Edit this page View Source

Version

Whether to return document version as part of a hit.

Declaration
public bool? Version { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods