VectorSearchField Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.5.1
Package:
Azure.Search.Documents v11.6.0-beta.3
Source:
VectorSearchField.cs
Source:
VectorSearchField.cs

A searchable vector field of type "Collection(Single)".

public class VectorSearchField : Azure.Search.Documents.Indexes.Models.SearchFieldTemplate
type VectorSearchField = class
    inherit SearchFieldTemplate
Public Class VectorSearchField
Inherits SearchFieldTemplate
Inheritance
Object
SearchFieldTemplate
VectorSearchField

Constructors

VectorSearchField(String, Int32, String)

Initializes a new instance of the SimpleField class.

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.
Name

Gets the name of the field.

(Inherited from SearchFieldTemplate)
Type

Gets the data type of the field.

(Inherited from SearchFieldTemplate)
VectorSearchDimensions

The dimensionality of the vector field.
VectorSearchProfileName

The name of the vector search profile that specifies the algorithm to use when searching the vector field.

Applies to