azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents.indexes.models.SemanticConfiguration.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.SemanticConfiguration"
fullName: "com.azure.search.documents.indexes.models.SemanticConfiguration"
name: "SemanticConfiguration"
nameWithType: "SemanticConfiguration"
summary: "Defines a specific configuration to be used in the context of semantic capabilities."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SemanticConfiguration**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.SemanticConfiguration?alt=com.azure.search.documents.indexes.models.SemanticConfiguration&text=SemanticConfiguration\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.SemanticConfiguration.SemanticConfiguration(java.lang.String,com.azure.search.documents.indexes.models.SemanticPrioritizedFields)"
  fullName: "com.azure.search.documents.indexes.models.SemanticConfiguration.SemanticConfiguration(String name, SemanticPrioritizedFields prioritizedFields)"
  name: "SemanticConfiguration(String name, SemanticPrioritizedFields prioritizedFields)"
  nameWithType: "SemanticConfiguration.SemanticConfiguration(String name, SemanticPrioritizedFields prioritizedFields)"
  summary: "Creates an instance of Semantic<wbr>Configuration class."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the prioritizedFields value to set."
    name: "prioritizedFields"
    type: "<xref href=\"com.azure.search.documents.indexes.models.SemanticPrioritizedFields?alt=com.azure.search.documents.indexes.models.SemanticPrioritizedFields&text=SemanticPrioritizedFields\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public SemanticConfiguration(String name, SemanticPrioritizedFields prioritizedFields)"
  desc: "Creates an instance of SemanticConfiguration class."
methods:
- uid: "com.azure.search.documents.indexes.models.SemanticConfiguration.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.SemanticConfiguration.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "SemanticConfiguration.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Semantic<wbr>Configuration from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static SemanticConfiguration fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of SemanticConfiguration from the JsonReader."
  returns:
    description: "An instance of SemanticConfiguration if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SemanticConfiguration?alt=com.azure.search.documents.indexes.models.SemanticConfiguration&text=SemanticConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SemanticConfiguration.getName()"
  fullName: "com.azure.search.documents.indexes.models.SemanticConfiguration.getName()"
  name: "getName()"
  nameWithType: "SemanticConfiguration.getName()"
  summary: "Get the name property: The name of the semantic configuration."
  syntax: "public String getName()"
  desc: "Get the name property: The name of the semantic configuration."
  returns:
    description: "the name value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SemanticConfiguration.getPrioritizedFields()"
  fullName: "com.azure.search.documents.indexes.models.SemanticConfiguration.getPrioritizedFields()"
  name: "getPrioritizedFields()"
  nameWithType: "SemanticConfiguration.getPrioritizedFields()"
  summary: "Get the prioritized<wbr>Fields property: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers."
  syntax: "public SemanticPrioritizedFields getPrioritizedFields()"
  desc: "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:
    description: "the prioritizedFields value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SemanticPrioritizedFields?alt=com.azure.search.documents.indexes.models.SemanticPrioritizedFields&text=SemanticPrioritizedFields\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SemanticConfiguration.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.SemanticConfiguration.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "SemanticConfiguration.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines a specific configuration to be used in the context of semantic capabilities."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.SemanticConfiguration?alt=com.azure.search.documents.indexes.models.SemanticConfiguration&text=SemanticConfiguration\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.3