Share via

VectorSearchProfile Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.indexes.models.VectorSearchProfile

Implements

JsonSerializable<VectorSearchProfile>

public final class VectorSearchProfile
implements JsonSerializable<VectorSearchProfile>

Defines a combination of configurations to use with vector search.

Constructor Summary

Constructor Description
VectorSearchProfile(String name, String algorithmConfigurationName)

Creates an instance of VectorSearchProfile class.

Method Summary

Modifier and Type Method and Description
static VectorSearchProfile fromJson(JsonReader jsonReader)

Reads an instance of VectorSearchProfile from the JsonReader.
String getAlgorithmConfigurationName()

Get the algorithmConfigurationName property: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.
String getCompressionName()

Get the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.
String getName()

Get the name property: The name to associate with this particular vector search profile.
String getVectorizerName()

Get the vectorizerName property: The name of the vectorization being configured for use with vector search.
VectorSearchProfile setCompressionName(String compressionName)

Set the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.
VectorSearchProfile setVectorizerName(String vectorizerName)

Set the vectorizerName property: The name of the vectorization being configured for use with vector search.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorSearchProfile

public VectorSearchProfile(String name, String algorithmConfigurationName)

Creates an instance of VectorSearchProfile class.

Parameters:

name - the name value to set.
algorithmConfigurationName - the algorithmConfigurationName value to set.

Method Details

fromJson

public static VectorSearchProfile fromJson(JsonReader jsonReader)

Reads an instance of VectorSearchProfile from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAlgorithmConfigurationName

public String getAlgorithmConfigurationName()

Get the algorithmConfigurationName property: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.

Returns:

the algorithmConfigurationName value.

getCompressionName

public String getCompressionName()

Get the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.

Returns:

the compressionName value.

getName

public String getName()

Get the name property: The name to associate with this particular vector search profile.

Returns:

the name value.

getVectorizerName

public String getVectorizerName()

Get the vectorizerName property: The name of the vectorization being configured for use with vector search.

Returns:

the vectorizerName value.

setCompressionName

public VectorSearchProfile setCompressionName(String compressionName)

Set the compressionName property: The name of the compression method configuration that specifies the compression method and optional parameters.

Parameters:

compressionName - the compressionName value to set.

Returns:

the VectorSearchProfile object itself.

setVectorizerName

public VectorSearchProfile setVectorizerName(String vectorizerName)

Set the vectorizerName property: The name of the vectorization being configured for use with vector search.

Parameters:

vectorizerName - the vectorizerName value to set.

Returns:

the VectorSearchProfile object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to