com.amazonaws.services.comprehendmedical.model

Class DetectEntitiesV2Result

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Result

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DetectEntitiesV2Result()

Method Summary

Modifier and Type	Method and Description
DetectEntitiesV2Result	clone()
boolean	equals(Object obj)
List<Entity>	getEntities() The collection of medical entities extracted from the input text and their associated information.
String	getModelVersion() The version of the model used to analyze the documents.
String	getPaginationToken() If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.
List<UnmappedAttribute>	getUnmappedAttributes() Attributes extracted from the input text that couldn't be related to an entity.
int	hashCode()
void	setEntities(Collection<Entity> entities) The collection of medical entities extracted from the input text and their associated information.
void	setModelVersion(String modelVersion) The version of the model used to analyze the documents.
void	setPaginationToken(String paginationToken) If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.
void	setUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes) Attributes extracted from the input text that couldn't be related to an entity.
String	toString() Returns a string representation of this object.
DetectEntitiesV2Result	withEntities(Collection<Entity> entities) The collection of medical entities extracted from the input text and their associated information.
DetectEntitiesV2Result	withEntities(Entity... entities) The collection of medical entities extracted from the input text and their associated information.
DetectEntitiesV2Result	withModelVersion(String modelVersion) The version of the model used to analyze the documents.
DetectEntitiesV2Result	withPaginationToken(String paginationToken) If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.
DetectEntitiesV2Result	withUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes) Attributes extracted from the input text that couldn't be related to an entity.
DetectEntitiesV2Result	withUnmappedAttributes(UnmappedAttribute... unmappedAttributes) Attributes extracted from the input text that couldn't be related to an entity.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DetectEntitiesV2Result

public DetectEntitiesV2Result()

Method Detail

getEntities

public List<Entity> getEntities()

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

Returns:

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

setEntities

public void setEntities(Collection<Entity> entities)

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

Parameters:

entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

withEntities

public DetectEntitiesV2Result withEntities(Entity... entities)

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

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 - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

withEntities

public DetectEntitiesV2Result withEntities(Collection<Entity> entities)

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

Parameters:

entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

getUnmappedAttributes

public List<UnmappedAttribute> getUnmappedAttributes()

Attributes extracted from the input text that couldn't be related to an entity.

Returns:

Attributes extracted from the input text that couldn't be related to an entity.

setUnmappedAttributes

public void setUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)

Attributes extracted from the input text that couldn't be related to an entity.

Parameters:

unmappedAttributes - Attributes extracted from the input text that couldn't be related to an entity.

withUnmappedAttributes

public DetectEntitiesV2Result withUnmappedAttributes(UnmappedAttribute... unmappedAttributes)

Attributes extracted from the input text that couldn't be related to an entity.

NOTE: This method appends the values to the existing list (if any). Use setUnmappedAttributes(java.util.Collection) or withUnmappedAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

unmappedAttributes - Attributes extracted from the input text that couldn't be related to an entity.

Returns:

Returns a reference to this object so that method calls can be chained together.

withUnmappedAttributes

public DetectEntitiesV2Result withUnmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)

Attributes extracted from the input text that couldn't be related to an entity.

Parameters:

unmappedAttributes - Attributes extracted from the input text that couldn't be related to an entity.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPaginationToken

public void setPaginationToken(String paginationToken)

If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

Parameters:

paginationToken - If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

getPaginationToken

public String getPaginationToken()

If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

Returns:

If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

withPaginationToken

public DetectEntitiesV2Result withPaginationToken(String paginationToken)

If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

Parameters:

paginationToken - If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

Returns:

Returns a reference to this object so that method calls can be chained together.

setModelVersion

public void setModelVersion(String modelVersion)

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Parameters:

modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

getModelVersion

public String getModelVersion()

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Returns:

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

withModelVersion

public DetectEntitiesV2Result withModelVersion(String modelVersion)

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Parameters:

modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

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 DetectEntitiesV2Result clone()

Overrides:

clone in class Object