java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.comprehend.model.ComprehendRequest
    - - software.amazon.awssdk.services.comprehend.model.DetectEntitiesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DetectEntitiesRequest
extends ComprehendRequest
implements ToCopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DetectEntitiesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DetectEntitiesRequest.Builder`	`builder()`
`SdkBytes`	`bytes()`	This field applies only when you use a custom entity recognition model that was trained with PDF annotations.
`DocumentReaderConfig`	`documentReaderConfig()`	Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
`String`	`endpointArn()`	The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LanguageCode`	`languageCode()`	The language of the input documents.
`String`	`languageCodeAsString()`	The language of the input documents.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DetectEntitiesRequest.Builder>`	`serializableBuilderClass()`
`String`	`text()`	A UTF-8 text string.
`DetectEntitiesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - text
```
public final String text()
```
    A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.
    
    Returns:
    
    A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.
  - languageCode
```
public final LanguageCode languageCode()
```
    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.
    
    All input documents must be in the same language.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.
    
    All input documents must be in the same language.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.
    
    All input documents must be in the same language.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.
    
    All input documents must be in the same language.
    
    See Also:
    
    LanguageCode
  - endpointArn
```
public final 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.
    
    For information about endpoints, see Managing endpoints.
    
    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.
    
    For information about endpoints, see Managing endpoints.
  - bytes
```
public final SdkBytes bytes()
```
    This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.
    
    Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).
    
    You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
    
    Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.
    
    The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
    
    If you use the Bytes parameter, do not use the Text parameter.
    
    Returns:
    
    This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.
    
    Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).
    
    You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.
    
    Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.
    
    The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.
    
    If you use the Bytes parameter, do not use the Text parameter.
  - documentReaderConfig
```
public final DocumentReaderConfig documentReaderConfig()
```
    Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
    
    Returns:
    
    Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
  - toBuilder
```
public DetectEntitiesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>
    
    Specified by:
    
    toBuilder in class ComprehendRequest
  - builder
```
public static DetectEntitiesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DetectEntitiesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DetectEntitiesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

text

languageCode

languageCodeAsString

endpointArn

bytes

documentReaderConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields