QueryResultDocumentSemanticField Class

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

Implements

JsonSerializable<QueryResultDocumentSemanticField>

public final class QueryResultDocumentSemanticField
implements JsonSerializable<QueryResultDocumentSemanticField>

Description of fields that were sent to the semantic enrichment process, as well as how they were used.

Constructor Summary

Constructor Description
QueryResultDocumentSemanticField()

Creates an instance of QueryResultDocumentSemanticField class.

Method Summary

Modifier and Type Method and Description
static QueryResultDocumentSemanticField fromJson(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).
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueryResultDocumentSemanticField

public QueryResultDocumentSemanticField()

Creates an instance of QueryResultDocumentSemanticField class.

Method Details

fromJson

public static QueryResultDocumentSemanticField fromJson(JsonReader jsonReader)

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.

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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to