Class KnnVectorPropertyDescriptor<T>

Inheritance

object

DescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty>

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>

CorePropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>

DocValuesPropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>

KnnVectorPropertyDescriptor<T>

Implements

IDescriptor

IKnnVectorProperty

IDocValuesProperty

ICoreProperty

IProperty

IFieldMapping

Inherited Members

DocValuesPropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.DocValues(bool?)

CorePropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.Store(bool?)

CorePropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.Fields(Func<PropertiesDescriptor<T>, IPromise<IProperties>>)

CorePropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.Similarity(string)

CorePropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.CopyTo(Func<FieldsDescriptor<T>, IPromise<Fields>>)

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.DebugDisplay

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.TypeOverride

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.Name(PropertyName)

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.Name<TValue>(Expression<Func<T, TValue>>)

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.LocalMetadata(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

PropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>.Meta(Func<FluentDictionary<string, string>, FluentDictionary<string, string>>)

DescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty>.Self

DescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty>.Assign<TValue>(TValue, Action<IKnnVectorProperty, 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 KnnVectorPropertyDescriptor<T> : DocValuesPropertyDescriptorBase<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty, T>, IDescriptor, IKnnVectorProperty, IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping where T : class

Type Parameters

Name	Description
T

Constructors

KnnVectorPropertyDescriptor()

Declaration

public KnnVectorPropertyDescriptor()

Methods

Dimension(int?)

The dimension of the vector.

Declaration

public KnnVectorPropertyDescriptor<T> Dimension(int? dimension)

Parameters

Type	Name	Description
int?	dimension

Returns

Type	Description
KnnVectorPropertyDescriptor<T>

Method(Func<KnnMethodDescriptor, IKnnMethod>)

The method to use when the underlying Approximate k-NN algorithm does not require training.

Declaration

public KnnVectorPropertyDescriptor<T> Method(Func<KnnMethodDescriptor, IKnnMethod> selector)

Parameters

Type	Name	Description
Func<KnnMethodDescriptor, IKnnMethod>	selector

Returns

Type	Description
KnnVectorPropertyDescriptor<T>

ModelId(string)

The model to use when the underlying Approximate k-NN algorithm requires a training step.

Declaration

public KnnVectorPropertyDescriptor<T> ModelId(string modelId)

Parameters

Type	Name	Description
string	modelId

Returns

Type	Description
KnnVectorPropertyDescriptor<T>

Implements

IDescriptor

IKnnVectorProperty

IDocValuesProperty

ICoreProperty

IProperty

IFieldMapping

Extension Methods

SuffixExtensions.Suffix(object, string)