com.amazonaws.services.comprehend.model.DetectEntitiesResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-comprehend Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.comprehend.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DetectEntitiesResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private java.util.List entities;
/**
*
* Information about the document, discovered during text extraction. This field is present in the response only if
* your request used the Byte parameter.
*
*/
private DocumentMetadata documentMetadata;
/**
*
* 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.
*
*/
private java.util.List documentType;
/**
*
* 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.
*
*/
private java.util.List blocks;
/**
*
* Page-level errors that the system detected while processing the input document. The field is empty if the system
* encountered no errors.
*
*/
private java.util.List errors;
/**
*
* 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.
*
*
* @return 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 java.util.List getEntities() {
return 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.
*
*
* @param 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 setEntities(java.util.Collection entities) {
if (entities == null) {
this.entities = null;
return;
}
this.entities = new java.util.ArrayList(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
* {@link #setEntities(java.util.Collection)} or {@link #withEntities(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withEntities(Entity... entities) {
if (this.entities == null) {
setEntities(new java.util.ArrayList(entities.length));
}
for (Entity ele : entities) {
this.entities.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withEntities(java.util.Collection entities) {
setEntities(entities);
return this;
}
/**
*
* Information about the document, discovered during text extraction. This field is present in the response only if
* your request used the Byte parameter.
*
*
* @param 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 void setDocumentMetadata(DocumentMetadata documentMetadata) {
this.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.
*
*
* @return 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() {
return this.documentMetadata;
}
/**
*
* Information about the document, discovered during text extraction. This field is present in the response only if
* your request used the Byte parameter.
*
*
* @param documentMetadata
* Information about the document, discovered during text extraction. This field is present in the response
* only if your request used the Byte parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withDocumentMetadata(DocumentMetadata documentMetadata) {
setDocumentMetadata(documentMetadata);
return this;
}
/**
*
* 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.
*
*
* @return 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 java.util.List getDocumentType() {
return 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.
*
*
* @param 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 void setDocumentType(java.util.Collection documentType) {
if (documentType == null) {
this.documentType = null;
return;
}
this.documentType = new java.util.ArrayList(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
* {@link #setDocumentType(java.util.Collection)} or {@link #withDocumentType(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withDocumentType(DocumentTypeListItem... documentType) {
if (this.documentType == null) {
setDocumentType(new java.util.ArrayList(documentType.length));
}
for (DocumentTypeListItem ele : documentType) {
this.documentType.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withDocumentType(java.util.Collection documentType) {
setDocumentType(documentType);
return this;
}
/**
*
* 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.
*
*
* @return 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 java.util.List getBlocks() {
return 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.
*
*
* @param 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 void setBlocks(java.util.Collection blocks) {
if (blocks == null) {
this.blocks = null;
return;
}
this.blocks = new java.util.ArrayList(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
* {@link #setBlocks(java.util.Collection)} or {@link #withBlocks(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withBlocks(Block... blocks) {
if (this.blocks == null) {
setBlocks(new java.util.ArrayList(blocks.length));
}
for (Block ele : blocks) {
this.blocks.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withBlocks(java.util.Collection blocks) {
setBlocks(blocks);
return this;
}
/**
*
* Page-level errors that the system detected while processing the input document. The field is empty if the system
* encountered no errors.
*
*
* @return Page-level errors that the system detected while processing the input document. The field is empty if the
* system encountered no errors.
*/
public java.util.List getErrors() {
return errors;
}
/**
*
* Page-level errors that the system detected while processing the input document. The field is empty if the system
* encountered no errors.
*
*
* @param errors
* 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(java.util.Collection errors) {
if (errors == null) {
this.errors = null;
return;
}
this.errors = new java.util.ArrayList(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
* {@link #setErrors(java.util.Collection)} or {@link #withErrors(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param errors
* Page-level errors that the system detected while processing the input document. The field is empty if the
* system encountered no errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withErrors(ErrorsListItem... errors) {
if (this.errors == null) {
setErrors(new java.util.ArrayList(errors.length));
}
for (ErrorsListItem ele : errors) {
this.errors.add(ele);
}
return this;
}
/**
*
* Page-level errors that the system detected while processing the input document. The field is empty if the system
* encountered no errors.
*
*
* @param errors
* Page-level errors that the system detected while processing the input document. The field is empty if the
* system encountered no errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DetectEntitiesResult withErrors(java.util.Collection errors) {
setErrors(errors);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEntities() != null)
sb.append("Entities: ").append(getEntities()).append(",");
if (getDocumentMetadata() != null)
sb.append("DocumentMetadata: ").append(getDocumentMetadata()).append(",");
if (getDocumentType() != null)
sb.append("DocumentType: ").append(getDocumentType()).append(",");
if (getBlocks() != null)
sb.append("Blocks: ").append(getBlocks()).append(",");
if (getErrors() != null)
sb.append("Errors: ").append(getErrors());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DetectEntitiesResult == false)
return false;
DetectEntitiesResult other = (DetectEntitiesResult) obj;
if (other.getEntities() == null ^ this.getEntities() == null)
return false;
if (other.getEntities() != null && other.getEntities().equals(this.getEntities()) == false)
return false;
if (other.getDocumentMetadata() == null ^ this.getDocumentMetadata() == null)
return false;
if (other.getDocumentMetadata() != null && other.getDocumentMetadata().equals(this.getDocumentMetadata()) == false)
return false;
if (other.getDocumentType() == null ^ this.getDocumentType() == null)
return false;
if (other.getDocumentType() != null && other.getDocumentType().equals(this.getDocumentType()) == false)
return false;
if (other.getBlocks() == null ^ this.getBlocks() == null)
return false;
if (other.getBlocks() != null && other.getBlocks().equals(this.getBlocks()) == false)
return false;
if (other.getErrors() == null ^ this.getErrors() == null)
return false;
if (other.getErrors() != null && other.getErrors().equals(this.getErrors()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEntities() == null) ? 0 : getEntities().hashCode());
hashCode = prime * hashCode + ((getDocumentMetadata() == null) ? 0 : getDocumentMetadata().hashCode());
hashCode = prime * hashCode + ((getDocumentType() == null) ? 0 : getDocumentType().hashCode());
hashCode = prime * hashCode + ((getBlocks() == null) ? 0 : getBlocks().hashCode());
hashCode = prime * hashCode + ((getErrors() == null) ? 0 : getErrors().hashCode());
return hashCode;
}
@Override
public DetectEntitiesResult clone() {
try {
return (DetectEntitiesResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}