Package software.amazon.awssdk.services.comprehendmedical.model

Class InferSnomedctResponse

    • 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<SNOMEDCTEntity> entities()

        The collection of medical concept 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 that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

        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:
        The collection of medical concept 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 that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

      • paginationToken

        public final String paginationToken()

        If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.

        Returns:
        If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.

      • modelVersion

        public final String modelVersion()

        The version of the model used to analyze the documents, in the format n.n.n 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, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

      • snomedctDetails

        public final SNOMEDCTDetails snomedctDetails()

        The details of the SNOMED-CT revision, including the edition, language, and version date.

        Returns:
        The details of the SNOMED-CT revision, including the edition, language, and version date.

      • characters

        public final Characters characters()

        The number of characters in the input request documentation.

        Returns:
        The number of characters in the input request documentation.

      • 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