DetectEntitiesResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.comprehend.model.DetectEntitiesResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DetectEntitiesResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DetectEntitiesResult()

Constructors
Constructor and Description
`DetectEntitiesResult()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DetectEntitiesResult
```
public DetectEntitiesResult()
```
- Method Detail
  - getEntities
```
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.
    
    Returns:
    
    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.
  - setEntities
```
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.
    
    Parameters:
    
    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.
  - withEntities
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEntities
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentMetadata
```
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.
    
    Parameters:
    
    documentMetadata - Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.
  - getDocumentMetadata
```
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.
    
    Returns:
    
    Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.
  - withDocumentMetadata
```
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.
    
    Parameters:
    
    documentMetadata - Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDocumentType
```
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.
    
    Returns:
    
    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.
  - setDocumentType
```
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.
    
    Parameters:
    
    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.
  - withDocumentType
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDocumentType
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBlocks
```
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.
    
    Returns:
    
    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.
  - setBlocks
```
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.
    
    Parameters:
    
    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.
  - withBlocks
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlocks
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getErrors
```
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.
    
    Returns:
    
    Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
  - setErrors
```
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.
    
    Parameters:
    
    errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
  - withErrors
```
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.
    
    Parameters:
    
    errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withErrors
```
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.
    
    Parameters:
    
    errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DetectEntitiesResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DetectEntitiesResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DetectEntitiesResult

Method Detail

getEntities

setEntities

withEntities

withEntities

setDocumentMetadata

getDocumentMetadata

withDocumentMetadata

getDocumentType

setDocumentType

withDocumentType

withDocumentType

getBlocks

setBlocks

withBlocks

withBlocks

getErrors

setErrors

withErrors

withErrors

toString

equals

hashCode

clone