SemanticConfiguration Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.9.0-beta.1
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SemanticConfiguration

Implements

JsonSerializable<SemanticConfiguration>

public final class SemanticConfiguration
implements JsonSerializable<SemanticConfiguration>

Defines a specific configuration to be used in the context of semantic capabilities.

Constructor Summary

Constructor Description
SemanticConfiguration(String name, SemanticPrioritizedFields prioritizedFields)

Creates an instance of SemanticConfiguration class.

Method Summary

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

Reads an instance of SemanticConfiguration from the JsonReader.
String getName()

Get the name property: The name of the semantic configuration.
SemanticPrioritizedFields getPrioritizedFields()

Get the prioritizedFields property: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers.
RankingOrder getRankingOrder()

Get the rankingOrder property: Specifies the score type to be used for the sort order of the search results.
Boolean isFlightingOptIn()

Get the flightingOptIn property: Determines which semantic or query rewrite models to use during model flighting/upgrades.
SemanticConfiguration setFlightingOptIn(Boolean flightingOptIn)

Set the flightingOptIn property: Determines which semantic or query rewrite models to use during model flighting/upgrades.
SemanticConfiguration setRankingOrder(RankingOrder rankingOrder)

Set the rankingOrder property: Specifies the score type to be used for the sort order of the search results.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SemanticConfiguration

public SemanticConfiguration(String name, SemanticPrioritizedFields prioritizedFields)

Creates an instance of SemanticConfiguration class.

Parameters:

name - the name value to set.
prioritizedFields - the prioritizedFields value to set.

Method Details

fromJson

public static SemanticConfiguration fromJson(JsonReader jsonReader)

Reads an instance of SemanticConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getName

public String getName()

Get the name property: The name of the semantic configuration.

Returns:

the name value.

getPrioritizedFields

public SemanticPrioritizedFields getPrioritizedFields()

Get the prioritizedFields property: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set.

Returns:

the prioritizedFields value.

getRankingOrder

public RankingOrder getRankingOrder()

Get the rankingOrder property: Specifies the score type to be used for the sort order of the search results.

Returns:

the rankingOrder value.

isFlightingOptIn

public Boolean isFlightingOptIn()

Get the flightingOptIn property: Determines which semantic or query rewrite models to use during model flighting/upgrades.

Returns:

the flightingOptIn value.

setFlightingOptIn

public SemanticConfiguration setFlightingOptIn(Boolean flightingOptIn)

Set the flightingOptIn property: Determines which semantic or query rewrite models to use during model flighting/upgrades.

Parameters:

flightingOptIn - the flightingOptIn value to set.

Returns:

the SemanticConfiguration object itself.

setRankingOrder

public SemanticConfiguration setRankingOrder(RankingOrder rankingOrder)

Set the rankingOrder property: Specifies the score type to be used for the sort order of the search results.

Parameters:

rankingOrder - the rankingOrder value to set.

Returns:

the SemanticConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to