com.amazonaws.services.comprehend.model

Class DetectEntitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.comprehend.model.DetectEntitiesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DetectEntitiesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DetectEntitiesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEndpointArn() The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
java.lang.String	getLanguageCode() The language of the input documents.
java.lang.String	getText() A UTF-8 text string.
int	hashCode()
void	setEndpointArn(java.lang.String endpointArn) The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
void	setLanguageCode(LanguageCode languageCode) The language of the input documents.
void	setLanguageCode(java.lang.String languageCode) The language of the input documents.
void	setText(java.lang.String text) A UTF-8 text string.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DetectEntitiesRequest	withEndpointArn(java.lang.String endpointArn) The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
DetectEntitiesRequest	withLanguageCode(LanguageCode languageCode) The language of the input documents.
DetectEntitiesRequest	withLanguageCode(java.lang.String languageCode) The language of the input documents.
DetectEntitiesRequest	withText(java.lang.String text) A UTF-8 text string.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DetectEntitiesRequest

public DetectEntitiesRequest()

Method Detail

getText

public java.lang.String getText()

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Returns:

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

setText

public void setText(java.lang.String text)

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Constraints:
Length: 1 -

Parameters:

text -

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

withText

public DetectEntitiesRequest withText(java.lang.String text)

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

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

Constraints:
Length: 1 -

Parameters:

text -

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getLanguageCode

public java.lang.String getLanguageCode()

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Returns:

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

See Also:

LanguageCode

withLanguageCode

public DetectEntitiesRequest withLanguageCode(java.lang.String languageCode)

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

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

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

See Also:

LanguageCode

withLanguageCode

public DetectEntitiesRequest withLanguageCode(LanguageCode languageCode)

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

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

Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW

Parameters:

languageCode -

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getEndpointArn

public java.lang.String getEndpointArn()

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Returns:

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

setEndpointArn

public void setEndpointArn(java.lang.String endpointArn)

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Parameters:

endpointArn -

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

withEndpointArn

public DetectEntitiesRequest withEndpointArn(java.lang.String endpointArn)

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

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

Constraints:
Length: - 256
Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity -recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Parameters:

endpointArn -

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object