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

Implements

JsonSerializable<ContentAnalyzerConfig>

public final class ContentAnalyzerConfig
implements JsonSerializable<ContentAnalyzerConfig>

Configuration settings for an analyzer.

Constructor Summary

Constructor	Description
ContentAnalyzerConfig()	Creates an instance of ContentAnalyzerConfig class.

Method Summary

Modifier and Type	Method and Description
static ContentAnalyzerConfig	fromJson(JsonReader jsonReader) Reads an instance of ContentAnalyzerConfig from the JsonReader.
AnnotationFormat	getAnnotationFormat() Get the annotationFormat property: Representation format of annotations in analyze result markdown.
ChartFormat	getChartFormat() Get the chartFormat property: Representation format of charts in analyze result markdown.
Map<String,ContentCategoryDefinition>	getContentCategories() Get the contentCategories property: Map of categories to classify the input content(s) against.
List<String>	getLocales() Get the locales property: List of locale hints for speech transcription.
TableFormat	getTableFormat() Get the tableFormat property: Representation format of tables in analyze result markdown.
Boolean	isEstimateFieldSourceAndConfidence() Get the estimateFieldSourceAndConfidence property: Return field grounding source and confidence.
Boolean	isFaceBlurringDisabled() Get the faceBlurringDisabled property: Disable the default blurring of faces for privacy while processing the content.
Boolean	isFigureAnalysisEnabled() Get the figureAnalysisEnabled property: Enable analysis of figures, such as charts and diagrams.
Boolean	isFigureDescriptionEnabled() Get the figureDescriptionEnabled property: Enable generation of figure description.
Boolean	isFormulaEnabled() Get the formulaEnabled property: Enable mathematical formula detection.
Boolean	isLayoutEnabled() Get the layoutEnabled property: Enable layout analysis.
Boolean	isOcrEnabled() Get the ocrEnabled property: Enable optical character recognition (OCR).
Boolean	isOmitContent() Get the omitContent property: Omit the content for this analyzer from analyze result.
Boolean	isReturnDetails() Get the returnDetails property: Return all content details.
Boolean	isSegmentEnabled() Get the segmentEnabled property: Enable segmentation of the input by contentCategories.
Boolean	isSegmentPerPage() Get the segmentPerPage property: Force segmentation of document content by page.
ContentAnalyzerConfig	setAnnotationFormat(AnnotationFormat annotationFormat) Set the annotationFormat property: Representation format of annotations in analyze result markdown.
ContentAnalyzerConfig	setChartFormat(ChartFormat chartFormat) Set the chartFormat property: Representation format of charts in analyze result markdown.
ContentAnalyzerConfig	setContentCategories(Map<String,ContentCategoryDefinition> contentCategories) Set the contentCategories property: Map of categories to classify the input content(s) against.
ContentAnalyzerConfig	setEstimateFieldSourceAndConfidence(Boolean estimateFieldSourceAndConfidence) Set the estimateFieldSourceAndConfidence property: Return field grounding source and confidence.
ContentAnalyzerConfig	setFaceBlurringDisabled(Boolean faceBlurringDisabled) Set the faceBlurringDisabled property: Disable the default blurring of faces for privacy while processing the content.
ContentAnalyzerConfig	setFigureAnalysisEnabled(Boolean figureAnalysisEnabled) Set the figureAnalysisEnabled property: Enable analysis of figures, such as charts and diagrams.
ContentAnalyzerConfig	setFigureDescriptionEnabled(Boolean figureDescriptionEnabled) Set the figureDescriptionEnabled property: Enable generation of figure description.
ContentAnalyzerConfig	setFormulaEnabled(Boolean formulaEnabled) Set the formulaEnabled property: Enable mathematical formula detection.
ContentAnalyzerConfig	setLayoutEnabled(Boolean layoutEnabled) Set the layoutEnabled property: Enable layout analysis.
ContentAnalyzerConfig	setLocales(List<String> locales) Set the locales property: List of locale hints for speech transcription.
ContentAnalyzerConfig	setOcrEnabled(Boolean ocrEnabled) Set the ocrEnabled property: Enable optical character recognition (OCR).
ContentAnalyzerConfig	setOmitContent(Boolean omitContent) Set the omitContent property: Omit the content for this analyzer from analyze result.
ContentAnalyzerConfig	setReturnDetails(Boolean returnDetails) Set the returnDetails property: Return all content details.
ContentAnalyzerConfig	setSegmentEnabled(Boolean segmentEnabled) Set the segmentEnabled property: Enable segmentation of the input by contentCategories.
ContentAnalyzerConfig	setSegmentPerPage(Boolean segmentPerPage) Set the segmentPerPage property: Force segmentation of document content by page.
ContentAnalyzerConfig	setTableFormat(TableFormat tableFormat) Set the tableFormat property: Representation format of tables in analyze result markdown.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ContentAnalyzerConfig

public ContentAnalyzerConfig()

Creates an instance of ContentAnalyzerConfig class.

Method Details

fromJson

public static ContentAnalyzerConfig fromJson(JsonReader jsonReader)

Reads an instance of ContentAnalyzerConfig from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAnnotationFormat

public AnnotationFormat getAnnotationFormat()

Get the annotationFormat property: Representation format of annotations in analyze result markdown.

Returns:

the annotationFormat value.

getChartFormat

public ChartFormat getChartFormat()

Get the chartFormat property: Representation format of charts in analyze result markdown.

Returns:

the chartFormat value.

getContentCategories

public Map<String,ContentCategoryDefinition> getContentCategories()

Get the contentCategories property: Map of categories to classify the input content(s) against.

Returns:

the contentCategories value.

getLocales

public List<String> getLocales()

Get the locales property: List of locale hints for speech transcription.

Returns:

the locales value.

getTableFormat

public TableFormat getTableFormat()

Get the tableFormat property: Representation format of tables in analyze result markdown.

Returns:

the tableFormat value.

isEstimateFieldSourceAndConfidence

public Boolean isEstimateFieldSourceAndConfidence()

Get the estimateFieldSourceAndConfidence property: Return field grounding source and confidence.

Returns:

the estimateFieldSourceAndConfidence value.

isFaceBlurringDisabled

public Boolean isFaceBlurringDisabled()

Get the faceBlurringDisabled property: Disable the default blurring of faces for privacy while processing the content.

Returns:

the faceBlurringDisabled value.

isFigureAnalysisEnabled

public Boolean isFigureAnalysisEnabled()

Get the figureAnalysisEnabled property: Enable analysis of figures, such as charts and diagrams.

Returns:

the figureAnalysisEnabled value.

isFigureDescriptionEnabled

public Boolean isFigureDescriptionEnabled()

Get the figureDescriptionEnabled property: Enable generation of figure description.

Returns:

the figureDescriptionEnabled value.

isFormulaEnabled

public Boolean isFormulaEnabled()

Get the formulaEnabled property: Enable mathematical formula detection.

Returns:

the formulaEnabled value.

isLayoutEnabled

public Boolean isLayoutEnabled()

Get the layoutEnabled property: Enable layout analysis.

Returns:

the layoutEnabled value.

isOcrEnabled

public Boolean isOcrEnabled()

Get the ocrEnabled property: Enable optical character recognition (OCR).

Returns:

the ocrEnabled value.

isOmitContent

public Boolean isOmitContent()

Get the omitContent property: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any.

Returns:

the omitContent value.

isReturnDetails

public Boolean isReturnDetails()

Get the returnDetails property: Return all content details.

Returns:

the returnDetails value.

isSegmentEnabled

public Boolean isSegmentEnabled()

Get the segmentEnabled property: Enable segmentation of the input by contentCategories.

Returns:

the segmentEnabled value.

isSegmentPerPage

public Boolean isSegmentPerPage()

Get the segmentPerPage property: Force segmentation of document content by page.

Returns:

the segmentPerPage value.

setAnnotationFormat

public ContentAnalyzerConfig setAnnotationFormat(AnnotationFormat annotationFormat)

Set the annotationFormat property: Representation format of annotations in analyze result markdown.

Parameters:

annotationFormat - the annotationFormat value to set.

Returns:

the ContentAnalyzerConfig object itself.

setChartFormat

public ContentAnalyzerConfig setChartFormat(ChartFormat chartFormat)

Set the chartFormat property: Representation format of charts in analyze result markdown.

Parameters:

chartFormat - the chartFormat value to set.

Returns:

the ContentAnalyzerConfig object itself.

setContentCategories

public ContentAnalyzerConfig setContentCategories(Map<String,ContentCategoryDefinition> contentCategories)

Set the contentCategories property: Map of categories to classify the input content(s) against.

Parameters:

contentCategories - the contentCategories value to set.

Returns:

the ContentAnalyzerConfig object itself.

setEstimateFieldSourceAndConfidence

public ContentAnalyzerConfig setEstimateFieldSourceAndConfidence(Boolean estimateFieldSourceAndConfidence)

Set the estimateFieldSourceAndConfidence property: Return field grounding source and confidence.

Parameters:

estimateFieldSourceAndConfidence - the estimateFieldSourceAndConfidence value to set.

Returns:

the ContentAnalyzerConfig object itself.

setFaceBlurringDisabled

public ContentAnalyzerConfig setFaceBlurringDisabled(Boolean faceBlurringDisabled)

Set the faceBlurringDisabled property: Disable the default blurring of faces for privacy while processing the content.

Parameters:

faceBlurringDisabled - the faceBlurringDisabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setFigureAnalysisEnabled

public ContentAnalyzerConfig setFigureAnalysisEnabled(Boolean figureAnalysisEnabled)

Set the figureAnalysisEnabled property: Enable analysis of figures, such as charts and diagrams.

Parameters:

figureAnalysisEnabled - the figureAnalysisEnabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setFigureDescriptionEnabled

public ContentAnalyzerConfig setFigureDescriptionEnabled(Boolean figureDescriptionEnabled)

Set the figureDescriptionEnabled property: Enable generation of figure description.

Parameters:

figureDescriptionEnabled - the figureDescriptionEnabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setFormulaEnabled

public ContentAnalyzerConfig setFormulaEnabled(Boolean formulaEnabled)

Set the formulaEnabled property: Enable mathematical formula detection.

Parameters:

formulaEnabled - the formulaEnabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setLayoutEnabled

public ContentAnalyzerConfig setLayoutEnabled(Boolean layoutEnabled)

Set the layoutEnabled property: Enable layout analysis.

Parameters:

layoutEnabled - the layoutEnabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setLocales

public ContentAnalyzerConfig setLocales(List<String> locales)

Set the locales property: List of locale hints for speech transcription.

Parameters:

locales - the locales value to set.

Returns:

the ContentAnalyzerConfig object itself.

setOcrEnabled

public ContentAnalyzerConfig setOcrEnabled(Boolean ocrEnabled)

Set the ocrEnabled property: Enable optical character recognition (OCR).

Parameters:

ocrEnabled - the ocrEnabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setOmitContent

public ContentAnalyzerConfig setOmitContent(Boolean omitContent)

Set the omitContent property: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any.

Parameters:

omitContent - the omitContent value to set.

Returns:

the ContentAnalyzerConfig object itself.

setReturnDetails

public ContentAnalyzerConfig setReturnDetails(Boolean returnDetails)

Set the returnDetails property: Return all content details.

Parameters:

returnDetails - the returnDetails value to set.

Returns:

the ContentAnalyzerConfig object itself.

setSegmentEnabled

public ContentAnalyzerConfig setSegmentEnabled(Boolean segmentEnabled)

Set the segmentEnabled property: Enable segmentation of the input by contentCategories.

Parameters:

segmentEnabled - the segmentEnabled value to set.

Returns:

the ContentAnalyzerConfig object itself.

setSegmentPerPage

public ContentAnalyzerConfig setSegmentPerPage(Boolean segmentPerPage)

Set the segmentPerPage property: Force segmentation of document content by page.

Parameters:

segmentPerPage - the segmentPerPage value to set.

Returns:

the ContentAnalyzerConfig object itself.

setTableFormat

public ContentAnalyzerConfig setTableFormat(TableFormat tableFormat)

Set the tableFormat property: Representation format of tables in analyze result markdown.

Parameters:

tableFormat - the tableFormat value to set.

Returns:

the ContentAnalyzerConfig object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException