SemanticRole Class

Package:

com.azure.ai.contentunderstanding.models

Maven Artifact:

com.azure:azure-ai-contentunderstanding:1.0.0

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.contentunderstanding.models.SemanticRole

public final class SemanticRole
extends ExpandableStringEnum<SemanticRole>

Semantic role of the paragraph.

Field Summary

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

Constructor Summary

Constructor	Description
SemanticRole()	Deprecated Use the fromString(String name) factory method. Creates a new instance of SemanticRole value.

Method Summary

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

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

FOOTNOTE

public static final SemanticRole FOOTNOTE

Note usually placed after the main content on a page.

FORMULA_BLOCK

public static final SemanticRole FORMULA_BLOCK

Block of formulas, often with shared alignment.

PAGE_FOOTER

public static final SemanticRole PAGE_FOOTER

Text near the bottom edge of the page.

PAGE_HEADER

public static final SemanticRole PAGE_HEADER

Text near the top edge of the page.

PAGE_NUMBER

public static final SemanticRole PAGE_NUMBER

Page number.

SECTION_HEADING

public static final SemanticRole SECTION_HEADING

Sub heading describing a section of the document.

TITLE

public static final SemanticRole TITLE

Top-level title describing the entire document.

Constructor Details

SemanticRole

@Deprecated
public SemanticRole()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SemanticRole value.

Method Details

fromString

public static SemanticRole fromString(String name)

Creates or finds a SemanticRole from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SemanticRole.

values

public static Collection<SemanticRole> values()

Gets known SemanticRole values.

Returns:

known SemanticRole values.