Package com.azure.search.documents.indexes.models

Class SemanticSearch

java.lang.Object
com.azure.search.documents.indexes.models.SemanticSearch
All Implemented Interfaces:
com.azure.json.JsonSerializable<SemanticSearch>
public final class SemanticSearch extends Object implements com.azure.json.JsonSerializable<SemanticSearch>
Defines parameters for a search index that influence semantic capabilities.

  • Constructor Details

    • SemanticSearch

      public SemanticSearch()
      Creates an instance of SemanticSearch class.

  • Method Details

    • 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.

    • 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.

    • getConfigurations

      public List<SemanticConfiguration> getConfigurations()
      Get the configurations property: The semantic configurations for the index.
      Returns:
      the configurations value.

    • setConfigurations

      public SemanticSearch setConfigurations(List<SemanticConfiguration> configurations)
      Set the configurations property: The semantic configurations for the index.
      Parameters:
      configurations - the configurations value to set.
      Returns:
      the SemanticSearch object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SemanticSearch>
      Throws:
      IOException

    • fromJson

      public static SemanticSearch fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.