Package com.azure.ai.documentintelligence.models

Class ParagraphRole

java.lang.Object

com.azure.core.util.ExpandableStringEnum<ParagraphRole>

com.azure.ai.documentintelligence.models.ParagraphRole

public final class ParagraphRole
extends com.azure.core.util.ExpandableStringEnum<ParagraphRole>

Semantic role of the paragraph.

Field Summary

Fields

Modifier and Type	Field	Description
static final ParagraphRole	FOOTNOTE	A note usually placed after the main content on a page.
static final ParagraphRole	FORMULA_BLOCK	A block of formulas, often with shared alignment.
static final ParagraphRole	PAGE_FOOTER	Text near the bottom edge of the page.
static final ParagraphRole	PAGE_HEADER	Text near the top edge of the page.
static final ParagraphRole	PAGE_NUMBER	Page number.
static final ParagraphRole	SECTION_HEADING	Sub heading describing a section of the document.
static final ParagraphRole	TITLE	Top-level title describing the entire document.

Constructor Summary

Constructors

Constructor	Description
ParagraphRole()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static ParagraphRole	fromString(String name)	Creates or finds a ParagraphRole from its string representation.
static Collection<ParagraphRole>	values()	Gets known ParagraphRole values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PAGE_HEADER

public static final ParagraphRole PAGE_HEADER

Text near the top edge of the page.

PAGE_FOOTER

public static final ParagraphRole PAGE_FOOTER

Text near the bottom edge of the page.

PAGE_NUMBER

public static final ParagraphRole PAGE_NUMBER

Page number.

TITLE

public static final ParagraphRole TITLE

Top-level title describing the entire document.

SECTION_HEADING

public static final ParagraphRole SECTION_HEADING

Sub heading describing a section of the document.

FOOTNOTE

public static final ParagraphRole FOOTNOTE

A note usually placed after the main content on a page.

FORMULA_BLOCK

public static final ParagraphRole FORMULA_BLOCK

A block of formulas, often with shared alignment.

Constructor Details

ParagraphRole

@Deprecated
public ParagraphRole()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ParagraphRole value.

Method Details

fromString

public static ParagraphRole fromString(String name)

Creates or finds a ParagraphRole from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ParagraphRole.

values

public static Collection<ParagraphRole> values()

Gets known ParagraphRole values.

Returns:

known ParagraphRole values.