VectorSearchFieldAttribute Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
VectorSearchFieldAttribute.cs
Source:
VectorSearchFieldAttribute.cs

Attributes a ReadOnlyMemory<float> vector field, allowing its use with the VectorSearch indexes.

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]
public class VectorSearchFieldAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type VectorSearchFieldAttribute = class
    inherit Attribute
Public Class VectorSearchFieldAttribute
Inherits Attribute
Inheritance
Attribute
VectorSearchFieldAttribute
Attributes
AttributeUsageAttribute

Constructors

VectorSearchFieldAttribute()

Properties

IsHidden

Gets or sets whether the field is returned in search results. The default is false.
IsStored

An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields.
VectorEncodingFormat

The encoding format to interpret the field contents.
VectorSearchDimensions

The dimensionality of the vector field.
VectorSearchProfileName

The Name of the vector search profile configured in the index's Profiles that specifies the algorithm to use when searching the vector field.

Applies to