VectorSearch Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.7.0

• java.lang.Object
• • com.azure.search.documents.indexes.models.VectorSearch

Implements

JsonSerializable<VectorSearch>

public final class VectorSearch
implements JsonSerializable<VectorSearch>

Contains configuration options related to vector search.

Constructor Summary

Constructor	Description
VectorSearch()	Creates an instance of VectorSearch class.

Method Summary

Modifier and Type	Method and Description
static VectorSearch	fromJson(JsonReader jsonReader) Reads an instance of VectorSearch from the JsonReader.
List<VectorSearchAlgorithmConfiguration>	getAlgorithms() Get the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.
List<VectorSearchCompression>	getCompressions() Get the compressions property: Contains configuration options specific to the compression method used during indexing or querying.
List<VectorSearchProfile>	getProfiles() Get the profiles property: Defines combinations of configurations to use with vector search.
List<VectorSearchVectorizer>	getVectorizers() Get the vectorizers property: Contains configuration options on how to vectorize text vector queries.
VectorSearch	setAlgorithms(VectorSearchAlgorithmConfiguration[] algorithms) Set the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.
VectorSearch	setAlgorithms(List<VectorSearchAlgorithmConfiguration> algorithms) Set the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.
VectorSearch	setCompressions(VectorSearchCompression[] compressions) Set the compressions property: Contains configuration options specific to the compression method used during indexing or querying.
VectorSearch	setCompressions(List<VectorSearchCompression> compressions) Set the compressions property: Contains configuration options specific to the compression method used during indexing or querying.
VectorSearch	setProfiles(VectorSearchProfile[] profiles) Set the profiles property: Defines combinations of configurations to use with vector search.
VectorSearch	setProfiles(List<VectorSearchProfile> profiles) Set the profiles property: Defines combinations of configurations to use with vector search.
VectorSearch	setVectorizers(VectorSearchVectorizer[] vectorizers) Set the vectorizers property: Contains configuration options on how to vectorize text vector queries.
VectorSearch	setVectorizers(List<VectorSearchVectorizer> vectorizers) Set the vectorizers property: Contains configuration options on how to vectorize text vector queries.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorSearch

public VectorSearch()

Creates an instance of VectorSearch class.

Method Details

fromJson

public static VectorSearch fromJson(JsonReader jsonReader)

Reads an instance of VectorSearch from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VectorSearch if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the VectorSearch.

getAlgorithms

public List getAlgorithms()

Get the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.

Returns:

the algorithms value.

getCompressions

public List getCompressions()

Get the compressions property: Contains configuration options specific to the compression method used during indexing or querying.

Returns:

the compressions value.

getProfiles

public List getProfiles()

Get the profiles property: Defines combinations of configurations to use with vector search.

Returns:

the profiles value.

getVectorizers

public List getVectorizers()

Get the vectorizers property: Contains configuration options on how to vectorize text vector queries.

Returns:

the vectorizers value.

setAlgorithms

public VectorSearch setAlgorithms(VectorSearchAlgorithmConfiguration[] algorithms)

Set the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.

Parameters:

algorithms - the algorithms value to set.

Returns:

the VectorSearch object itself.

setAlgorithms

public VectorSearch setAlgorithms(List algorithms)

Set the algorithms property: Contains configuration options specific to the algorithm used during indexing or querying.

Parameters:

algorithms - the algorithms value to set.

Returns:

the VectorSearch object itself.

setCompressions

public VectorSearch setCompressions(VectorSearchCompression[] compressions)

Set the compressions property: Contains configuration options specific to the compression method used during indexing or querying.

Parameters:

compressions - the compressions value to set.

Returns:

the VectorSearch object itself.

setCompressions

public VectorSearch setCompressions(List compressions)

Set the compressions property: Contains configuration options specific to the compression method used during indexing or querying.

Parameters:

compressions - the compressions value to set.

Returns:

the VectorSearch object itself.

setProfiles

public VectorSearch setProfiles(VectorSearchProfile[] profiles)

Set the profiles property: Defines combinations of configurations to use with vector search.

Parameters:

profiles - the profiles value to set.

Returns:

the VectorSearch object itself.

setProfiles

public VectorSearch setProfiles(List profiles)

Set the profiles property: Defines combinations of configurations to use with vector search.

Parameters:

profiles - the profiles value to set.

Returns:

the VectorSearch object itself.

setVectorizers

public VectorSearch setVectorizers(VectorSearchVectorizer[] vectorizers)

Set the vectorizers property: Contains configuration options on how to vectorize text vector queries.

Parameters:

vectorizers - the vectorizers value to set.

Returns:

the VectorSearch object itself.

setVectorizers

public VectorSearch setVectorizers(List vectorizers)

Set the vectorizers property: Contains configuration options on how to vectorize text vector queries.

Parameters:

vectorizers - the vectorizers value to set.

Returns:

the VectorSearch object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException