Freigeben über

AnalysisResult Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.AnalysisResult

Implements

JsonSerializable<AnalysisResult>

public final class AnalysisResult
implements JsonSerializable<AnalysisResult>

Analyze operation result.

Method Summary

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

Reads an instance of AnalysisResult from the JsonReader.
String getAnalyzerId()

Get the analyzerId property: The unique identifier of the analyzer.
String getApiVersion()

Get the apiVersion property: The version of the API used to analyze the document.
List<AnalysisContent> getContents()

Get the contents property: The extracted content.
OffsetDateTime getCreatedAt()

Get the createdAt property: The date and time when the result was created.
String getStringEncoding()

Get the stringEncoding property: The string encoding format for content spans in the response.
List<ResponseError> getWarnings()

Get the warnings property: Warnings encountered while analyzing the document.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static AnalysisResult fromJson(JsonReader jsonReader)

Reads an instance of AnalysisResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAnalyzerId

public String getAnalyzerId()

Get the analyzerId property: The unique identifier of the analyzer.

Returns:

the analyzerId value.

getApiVersion

public String getApiVersion()

Get the apiVersion property: The version of the API used to analyze the document.

Returns:

the apiVersion value.

getContents

public List<AnalysisContent> getContents()

Get the contents property: The extracted content.

Returns:

the contents value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The date and time when the result was created.

Returns:

the createdAt value.

getStringEncoding

public String getStringEncoding()

Get the stringEncoding property: The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.").

Returns:

the stringEncoding value.

getWarnings

public List<ResponseError> getWarnings()

Get the warnings property: Warnings encountered while analyzing the document.

Returns:

the warnings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to