Search Results for

    Show / Hide Table of Contents

    Class NeuralQuery

    Inheritance
    object
    QueryBase
    FieldNameQueryBase
    NeuralQuery
    Implements
    INeuralQuery
    IFieldNameQuery
    IQuery
    Inherited Members
    FieldNameQueryBase.Field
    QueryBase.Boost
    QueryBase.IsStrict
    QueryBase.IsVerbatim
    QueryBase.IsWritable
    QueryBase.Name
    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
    [DataContract]
    public class NeuralQuery : FieldNameQueryBase, INeuralQuery, IFieldNameQuery, IQuery

    Properties

    | Edit this page View Source

    Conditionless

    Declaration
    protected override bool Conditionless { get; }
    Property Value
    Type Description
    bool
    Overrides
    QueryBase.Conditionless
    | Edit this page View Source

    K

    The number of results the k-NN search returns.

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

    ModelId

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

    QueryText

    The query text from which to produce queries.

    Declaration
    public string QueryText { get; set; }
    Property Value
    Type Description
    string

    Implements

    INeuralQuery
    IFieldNameQuery
    IQuery

    Extension Methods

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