Package software.amazon.awssdk.services.comprehend.model

Class DetectEntitiesResponse

    • Method Detail

      • hasEntities

        public final boolean hasEntities()
        For responses, this returns true if the service returned a value for the Entities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • entities

        public final List<Entity> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntities() method.

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

      • documentMetadata

        public final 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.

        Returns:
        Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

      • hasDocumentType

        public final boolean hasDocumentType()
        For responses, this returns true if the service returned a value for the DocumentType property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • documentType

        public final List<DocumentTypeListItem> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDocumentType() method.

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

      • hasBlocks

        public final boolean hasBlocks()
        For responses, this returns true if the service returned a value for the Blocks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • blocks

        public final List<Block> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlocks() method.

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

      • hasErrors

        public final boolean hasErrors()
        For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • errors

        public final List<ErrorsListItem> errors()

        Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

        Returns:
        Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

      • 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