SemanticSearch Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.6.4

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

Implements

JsonSerializable<SemanticSearch>

public final class SemanticSearch
implements JsonSerializable<SemanticSearch>

Defines parameters for a search index that influence semantic capabilities.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static SemanticSearch	fromJson(JsonReader jsonReader) Reads an instance of SemanticSearch from the JsonReader.
List<SemanticConfiguration>	getConfigurations() Get the configurations property: The semantic configurations for the index.
String	getDefaultConfigurationName() Get the defaultConfigurationName property: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time.
SemanticSearch	setConfigurations(List<SemanticConfiguration> configurations) Set the configurations property: The semantic configurations for the index.
SemanticSearch	setDefaultConfigurationName(String defaultConfigurationName) Set the defaultConfigurationName property: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SemanticSearch

public SemanticSearch()

Creates an instance of SemanticSearch class.

Method Details

fromJson

public static SemanticSearch fromJson(JsonReader jsonReader)

Reads an instance of SemanticSearch from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getConfigurations

public List getConfigurations()

Get the configurations property: The semantic configurations for the index.

Returns:

the configurations value.

getDefaultConfigurationName

public String getDefaultConfigurationName()

Get the defaultConfigurationName property: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time.

Returns:

the defaultConfigurationName value.

setConfigurations

public SemanticSearch setConfigurations(List configurations)

Set the configurations property: The semantic configurations for the index.

Parameters:

configurations - the configurations value to set.

Returns:

the SemanticSearch object itself.

setDefaultConfigurationName

public SemanticSearch setDefaultConfigurationName(String defaultConfigurationName)

Set the defaultConfigurationName property: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time.

Parameters:

defaultConfigurationName - the defaultConfigurationName value to set.

Returns:

the SemanticSearch object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException