Package com.azure.search.documents.models

Class QueryResultDocumentSemanticField

java.lang.Object
com.azure.search.documents.models.QueryResultDocumentSemanticField
All Implemented Interfaces:
com.azure.json.JsonSerializable<QueryResultDocumentSemanticField>
public final class QueryResultDocumentSemanticField extends Object implements com.azure.json.JsonSerializable<QueryResultDocumentSemanticField>
Description of fields that were sent to the semantic enrichment process, as well as how they were used.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QueryResultDocumentSemanticField()
    Creates an instance of QueryResultDocumentSemanticField class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static QueryResultDocumentSemanticField
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of QueryResultDocumentSemanticField from the JsonReader.
    String
    getName()
    Get the name property: The name of the field that was sent to the semantic enrichment process.
    SemanticFieldState
    getState()
    Get the state property: The way the field was used for the semantic enrichment process (fully used, partially used, or unused).
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • QueryResultDocumentSemanticField

      public QueryResultDocumentSemanticField()
      Creates an instance of QueryResultDocumentSemanticField class.

  • Method Details

    • getName

      public String getName()
      Get the name property: The name of the field that was sent to the semantic enrichment process.
      Returns:
      the name value.

    • getState

      public SemanticFieldState getState()
      Get the state property: The way the field was used for the semantic enrichment process (fully used, partially used, or unused).
      Returns:
      the state value.

    • toJson

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

    • fromJson

      public static QueryResultDocumentSemanticField fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of QueryResultDocumentSemanticField from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of QueryResultDocumentSemanticField 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 QueryResultDocumentSemanticField.