WebApiVectorizer Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.VectorSearchVectorizer
  • • com.azure.search.documents.indexes.models.WebApiVectorizer

public final class WebApiVectorizer
extends VectorSearchVectorizer

Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset.

Constructor Summary

Constructor	Description
WebApiVectorizer(String vectorizerName)	Creates an instance of WebApiVectorizer class.

Method Summary

Modifier and Type	Method and Description
static WebApiVectorizer	fromJson(JsonReader jsonReader) Reads an instance of WebApiVectorizer from the JsonReader.
VectorSearchVectorizerKind	getKind() Get the kind property: The name of the kind of vectorization method being configured for use with vector search.
WebApiVectorizerParameters	getWebApiParameters() Get the webApiParameters property: Specifies the properties of the user-defined vectorizer.
WebApiVectorizer	setWebApiParameters(WebApiVectorizerParameters webApiParameters) Set the webApiParameters property: Specifies the properties of the user-defined vectorizer.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from VectorSearchVectorizer

fromJson getKind getVectorizerName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

WebApiVectorizer

public WebApiVectorizer(String vectorizerName)

Creates an instance of WebApiVectorizer class.

Parameters:

vectorizerName - the vectorizerName value to set.

Method Details

fromJson

public static WebApiVectorizer fromJson(JsonReader jsonReader)

Reads an instance of WebApiVectorizer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WebApiVectorizer 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.

getKind

public VectorSearchVectorizerKind getKind()

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

Overrides:

WebApiVectorizer.getKind()

Returns:

the kind value.

getWebApiParameters

public WebApiVectorizerParameters getWebApiParameters()

Get the webApiParameters property: Specifies the properties of the user-defined vectorizer.

Returns:

the webApiParameters value.

setWebApiParameters

public WebApiVectorizer setWebApiParameters(WebApiVectorizerParameters webApiParameters)

Set the webApiParameters property: Specifies the properties of the user-defined vectorizer.

Parameters:

webApiParameters - the webApiParameters value to set.

Returns:

the WebApiVectorizer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

WebApiVectorizer.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException