@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DetectEntitiesResult() |
Modifier and Type | Method and Description |
---|---|
DetectEntitiesResult |
clone() |
boolean |
equals(Object obj) |
List<Block> |
getBlocks()
Information about each block of text in the input document.
|
DocumentMetadata |
getDocumentMetadata()
Information about the document, discovered during text extraction.
|
List<DocumentTypeListItem> |
getDocumentType()
The document type for each page in the input document.
|
List<Entity> |
getEntities()
A collection of entities identified in the input text.
|
List<ErrorsListItem> |
getErrors()
Page-level errors that the system detected while processing the input document.
|
int |
hashCode() |
void |
setBlocks(Collection<Block> blocks)
Information about each block of text in the input document.
|
void |
setDocumentMetadata(DocumentMetadata documentMetadata)
Information about the document, discovered during text extraction.
|
void |
setDocumentType(Collection<DocumentTypeListItem> documentType)
The document type for each page in the input document.
|
void |
setEntities(Collection<Entity> entities)
A collection of entities identified in the input text.
|
void |
setErrors(Collection<ErrorsListItem> errors)
Page-level errors that the system detected while processing the input document.
|
String |
toString()
Returns a string representation of this object.
|
DetectEntitiesResult |
withBlocks(Block... blocks)
Information about each block of text in the input document.
|
DetectEntitiesResult |
withBlocks(Collection<Block> blocks)
Information about each block of text in the input document.
|
DetectEntitiesResult |
withDocumentMetadata(DocumentMetadata documentMetadata)
Information about the document, discovered during text extraction.
|
DetectEntitiesResult |
withDocumentType(Collection<DocumentTypeListItem> documentType)
The document type for each page in the input document.
|
DetectEntitiesResult |
withDocumentType(DocumentTypeListItem... documentType)
The document type for each page in the input document.
|
DetectEntitiesResult |
withEntities(Collection<Entity> entities)
A collection of entities identified in the input text.
|
DetectEntitiesResult |
withEntities(Entity... entities)
A collection of entities identified in the input text.
|
DetectEntitiesResult |
withErrors(Collection<ErrorsListItem> errors)
Page-level errors that the system detected while processing the input document.
|
DetectEntitiesResult |
withErrors(ErrorsListItem... errors)
Page-level errors that the system detected while processing the input document.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public List<Entity> getEntities()
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
public void setEntities(Collection<Entity> entities)
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
entities
- A collection of entities identified in the input text. For each entity, the response provides the entity
text, entity type, where the entity text begins and ends, and the level of confidence that Amazon
Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
public DetectEntitiesResult withEntities(Entity... entities)
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEntities(java.util.Collection)
or withEntities(java.util.Collection)
if you want to override
the existing values.
entities
- A collection of entities identified in the input text. For each entity, the response provides the entity
text, entity type, where the entity text begins and ends, and the level of confidence that Amazon
Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
public DetectEntitiesResult withEntities(Collection<Entity> entities)
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
entities
- A collection of entities identified in the input text. For each entity, the response provides the entity
text, entity type, where the entity text begins and ends, and the level of confidence that Amazon
Comprehend has in the detection.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
public void setDocumentMetadata(DocumentMetadata documentMetadata)
Information about the document, discovered during text extraction. This field is present in the response only if
your request used the Byte
parameter.
documentMetadata
- Information about the document, discovered during text extraction. This field is present in the response
only if your request used the Byte
parameter.public DocumentMetadata getDocumentMetadata()
Information about the document, discovered during text extraction. This field is present in the response only if
your request used the Byte
parameter.
Byte
parameter.public DetectEntitiesResult withDocumentMetadata(DocumentMetadata documentMetadata)
Information about the document, discovered during text extraction. This field is present in the response only if
your request used the Byte
parameter.
documentMetadata
- Information about the document, discovered during text extraction. This field is present in the response
only if your request used the Byte
parameter.public List<DocumentTypeListItem> getDocumentType()
The document type for each page in the input document. This field is present in the response only if your request
used the Byte
parameter.
Byte
parameter.public void setDocumentType(Collection<DocumentTypeListItem> documentType)
The document type for each page in the input document. This field is present in the response only if your request
used the Byte
parameter.
documentType
- The document type for each page in the input document. This field is present in the response only if your
request used the Byte
parameter.public DetectEntitiesResult withDocumentType(DocumentTypeListItem... documentType)
The document type for each page in the input document. This field is present in the response only if your request
used the Byte
parameter.
NOTE: This method appends the values to the existing list (if any). Use
setDocumentType(java.util.Collection)
or withDocumentType(java.util.Collection)
if you want to
override the existing values.
documentType
- The document type for each page in the input document. This field is present in the response only if your
request used the Byte
parameter.public DetectEntitiesResult withDocumentType(Collection<DocumentTypeListItem> documentType)
The document type for each page in the input document. This field is present in the response only if your request
used the Byte
parameter.
documentType
- The document type for each page in the input document. This field is present in the response only if your
request used the Byte
parameter.public List<Block> getBlocks()
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
public void setBlocks(Collection<Block> blocks)
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
blocks
- Information about each block of text in the input document. Blocks are nested. A page block contains a
block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
public DetectEntitiesResult withBlocks(Block... blocks)
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
NOTE: This method appends the values to the existing list (if any). Use
setBlocks(java.util.Collection)
or withBlocks(java.util.Collection)
if you want to override the
existing values.
blocks
- Information about each block of text in the input document. Blocks are nested. A page block contains a
block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
public DetectEntitiesResult withBlocks(Collection<Block> blocks)
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
blocks
- Information about each block of text in the input document. Blocks are nested. A page block contains a
block for each line of text, which contains a block for each word.
The Block
content for a Word input document does not include a Geometry
field.
The Block
field is not present in the response for plain-text inputs.
public List<ErrorsListItem> getErrors()
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
public void setErrors(Collection<ErrorsListItem> errors)
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
errors
- Page-level errors that the system detected while processing the input document. The field is empty if the
system encountered no errors.public DetectEntitiesResult withErrors(ErrorsListItem... errors)
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
NOTE: This method appends the values to the existing list (if any). Use
setErrors(java.util.Collection)
or withErrors(java.util.Collection)
if you want to override the
existing values.
errors
- Page-level errors that the system detected while processing the input document. The field is empty if the
system encountered no errors.public DetectEntitiesResult withErrors(Collection<ErrorsListItem> errors)
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
errors
- Page-level errors that the system detected while processing the input document. The field is empty if the
system encountered no errors.public String toString()
toString
in class Object
Object.toString()
public DetectEntitiesResult clone()