Share via

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

Implements

JsonSerializable<AnalysisContent>

public class AnalysisContent
implements JsonSerializable<AnalysisContent>

Media content base class.

Constructor Summary

Modifier Constructor Description
protected AnalysisContent(String mimeType)

Creates an instance of AnalysisContent class.

Method Summary

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

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

Get the analyzerId property: The analyzer that generated this content.
String getCategory()

Get the category property: Classified content category.
Map<String,ContentField> getFields()

Get the fields property: Extracted fields from the content.
AnalysisContentKind getKind()

Get the kind property: Content kind.
String getMarkdown()

Get the markdown property: Markdown representation of the content.
String getMimeType()

Get the mimeType property: Detected MIME type of the content.
String getPath()

Get the path property: The path of the content in the input.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AnalysisContent

protected AnalysisContent(String mimeType)

Creates an instance of AnalysisContent class.

Parameters:

mimeType - the mimeType value to set.

Method Details

fromJson

public static AnalysisContent fromJson(JsonReader jsonReader)

Reads an instance of AnalysisContent from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AnalysisContent 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 analyzer that generated this content.

Returns:

the analyzerId value.

getCategory

public String getCategory()

Get the category property: Classified content category.

Returns:

the category value.

getFields

public Map<String,ContentField> getFields()

Get the fields property: Extracted fields from the content.

Returns:

the fields value.

getKind

public AnalysisContentKind getKind()

Get the kind property: Content kind.

Returns:

the kind value.

getMarkdown

public String getMarkdown()

Get the markdown property: Markdown representation of the content.

Returns:

the markdown value.

getMimeType

public String getMimeType()

Get the mimeType property: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc.

Returns:

the mimeType value.

getPath

public String getPath()

Get the path property: The path of the content in the input.

Returns:

the path value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to