Interface IKnnVectorProperty

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IKnnVectorProperty : IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping

Properties

| Edit this page View Source

CompressionLevel

The compression level applied to the vector field (for example, 1x, 2x, 4x). Higher compression reduces memory footprint at the cost of some search accuracy.

Declaration
[DataMember(Name = "compression_level")]
string CompressionLevel { get; set; }
Property Value
Type Description
string
| Edit this page View Source

DataType

The data type of the vector elements. Defaults to float. Set to byte to store each dimension as an 8-bit signed integer ([-128, 127]), or binary for binary vectors, reducing memory and storage requirements.

Declaration
[DataMember(Name = "data_type")]
string DataType { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Dimension

The dimension of the vector.

Declaration
[DataMember(Name = "dimension")]
int? Dimension { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Method

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

Declaration
[DataMember(Name = "method")]
IKnnMethod Method { get; set; }
Property Value
Type Description
IKnnMethod
| Edit this page View Source

Mode

The mode that determines the default configuration of the vector field, balancing between low latency and low cost (for example, in_memory or on_disk).

Declaration
[DataMember(Name = "mode")]
string Mode { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ModelId

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

Declaration
[DataMember(Name = "model_id")]
string ModelId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SpaceType

The vector space used to calculate the distance between vectors. Can be specified at the top level of the field, as an alternative to specifying it on the Method.

Declaration
[DataMember(Name = "space_type")]
string SpaceType { get; set; }
Property Value
Type Description
string

Extension Methods