Class NeuralQueryDescriptor<T>

Inheritance
object
DescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>
QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>
FieldNameQueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery, T>
NeuralQueryDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class NeuralQueryDescriptor<T> : FieldNameQueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery, T>, IDescriptor, INeuralQuery, IFieldNameQuery, IQuery where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Conditionless

Whether the query is conditionless. A conditionless query is not serialized as part of the request sent to OpenSearch.

Declaration
protected override bool Conditionless { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

K(int?)

The number of results the k-NN search returns.

Declaration
public NeuralQueryDescriptor<T> K(int? k)
Parameters
Type Name Description
int? k
Returns
Type Description
NeuralQueryDescriptor<T>
| Edit this page View Source

ModelId(string)

The ID of the model that will be used in the embedding interface. The model must be indexed in OpenSearch before it can be used in Neural Search.

Declaration
public NeuralQueryDescriptor<T> ModelId(string modelId)
Parameters
Type Name Description
string modelId
Returns
Type Description
NeuralQueryDescriptor<T>
| Edit this page View Source

QueryText(string)

The query text from which to produce queries.

Declaration
public NeuralQueryDescriptor<T> QueryText(string queryText)
Parameters
Type Name Description
string queryText
Returns
Type Description
NeuralQueryDescriptor<T>

Implements

Extension Methods