com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.yml

### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord"
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord"
name: "DocumentWord"
nameWithType: "DocumentWord"
summary: "A word object consisting of a contiguous sequence of characters."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **DocumentWord**"
constructors:
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.DocumentWord()"
  fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.DocumentWord()"
  name: "DocumentWord()"
  nameWithType: "DocumentWord.DocumentWord()"
  summary: "Creates a Document<wbr>Word object."
  syntax: "public DocumentWord()"
  desc: "Creates a DocumentWord object."
methods:
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getBoundingPolygon()"
  fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getBoundingPolygon()"
  name: "getBoundingPolygon()"
  nameWithType: "DocumentWord.getBoundingPolygon()"
  summary: "Get the list of coordinates of the bounding polygon for the word."
  syntax: "public List<Point> getBoundingPolygon()"
  desc: "Get the list of coordinates of the bounding polygon for the word. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation."
  returns:
    description: "the boundingPolygon value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.Point?alt=com.azure.ai.formrecognizer.documentanalysis.models.Point&text=Point\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getConfidence()"
  fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getConfidence()"
  name: "getConfidence()"
  nameWithType: "DocumentWord.getConfidence()"
  summary: "Get the confidence property: Confidence of correctly extracting the word."
  syntax: "public float getConfidence()"
  desc: "Get the confidence property: Confidence of correctly extracting the word."
  returns:
    description: "the confidence value."
    type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getContent()"
  fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getContent()"
  name: "getContent()"
  nameWithType: "DocumentWord.getContent()"
  summary: "Get the content property: Text content of the word."
  syntax: "public String getContent()"
  desc: "Get the content property: Text content of the word."
  returns:
    description: "the content value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getSpan()"
  fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord.getSpan()"
  name: "getSpan()"
  nameWithType: "DocumentWord.getSpan()"
  summary: "Get the span property: Location of the word in the reading order concatenated content."
  syntax: "public DocumentSpan getSpan()"
  desc: "Get the span property: Location of the word in the reading order concatenated content."
  returns:
    description: "the span value."
    type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan&text=DocumentSpan\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word."
metadata: {}
package: "com.azure.ai.formrecognizer.documentanalysis.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.9