Search Results for

    Show / Hide Table of Contents

    Class NeuralQueryDescriptor<T>

    Inheritance
    object
    DescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>
    FieldNameQueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery, T>
    NeuralQueryDescriptor<T>
    Implements
    IDescriptor
    INeuralQuery
    IFieldNameQuery
    IQuery
    Inherited Members
    FieldNameQueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery, T>.Field(Field)
    FieldNameQueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery, T>.Field<TValue>(Expression<Func<T, TValue>>)
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Conditionless
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Name(string)
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Boost(double?)
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Verbatim(bool)
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Strict(bool)
    DescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Self
    DescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Assign<TValue>(TValue, Action<INeuralQuery, TValue>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    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
    QueryDescriptorBase<NeuralQueryDescriptor<T>, INeuralQuery>.Conditionless

    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

    IDescriptor
    INeuralQuery
    IFieldNameQuery
    IQuery

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Conditionless
    • Methods
      • K(int?)
      • ModelId(string)
      • QueryText(string)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX