Interface DetectEntitiesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>, SdkBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DetectEntitiesRequest
@Mutable @NotThreadSafe public static interface DetectEntitiesRequest.Builder extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>

  • Method Details

    • text

      DetectEntitiesRequest.Builder text(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • languageCode

      DetectEntitiesRequest.Builder languageCode(String 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.

      Parameters:
      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.

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

    • languageCode

      DetectEntitiesRequest.Builder languageCode(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.

      Parameters:
      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.

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

    • endpointArn

      DetectEntitiesRequest.Builder endpointArn(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.

      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.

      For information about endpoints, see Managing endpoints.

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

    • bytes

      DetectEntitiesRequest.Builder bytes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • documentReaderConfig

      DetectEntitiesRequest.Builder documentReaderConfig(DocumentReaderConfig documentReaderConfig)

      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

      Parameters:
      documentReaderConfig - Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentReaderConfig

      default DetectEntitiesRequest.Builder documentReaderConfig(Consumer<DocumentReaderConfig.Builder> documentReaderConfig)

      Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

      This is a convenience method that creates an instance of the DocumentReaderConfig.Builder avoiding the need to create one manually via DocumentReaderConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentReaderConfig(DocumentReaderConfig).

      Parameters:
      documentReaderConfig - a consumer that will call methods on DocumentReaderConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DetectEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DetectEntitiesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.