Class ICD10CMEntity
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ICD10CMEntity.Builder,
ICD10CMEntity>
The collection of medical 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.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List
<ICD10CMAttribute> The detected attributes that relate to the entity.final Integer
The 0-based character offset in the input text that shows where the entity begins.static ICD10CMEntity.Builder
builder()
final ICD10CMEntityCategory
category()
The category of the entity.final String
The category of the entity.final Integer
The 0-based character offset in the input text that shows where the entity ends.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ICD10CMConcepts property.final boolean
For responses, this returns true if the service returned a value for the Traits property.final List
<ICD10CMConcept> The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.final Integer
id()
The numeric identifier for the entity.final Float
score()
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.static Class
<? extends ICD10CMEntity.Builder> final String
text()
The segment of input text that is matched to the detected entity.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<ICD10CMTrait> traits()
Provides Contextual information for the entity.final ICD10CMEntityType
type()
Describes the specific type of entity with category of entities.final String
Describes the specific type of entity with category of entities.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
- Returns:
- The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
-
text
The segment of input text that is matched to the detected entity.
- Returns:
- The segment of input text that is matched to the detected entity.
-
category
The category of the entity. InferICD10CM detects entities in the
MEDICAL_CONDITION
category.If the service returns an enum value that is not available in the current SDK version,
category
will returnICD10CMEntityCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- The category of the entity. InferICD10CM detects entities in the
MEDICAL_CONDITION
category. - See Also:
-
categoryAsString
The category of the entity. InferICD10CM detects entities in the
MEDICAL_CONDITION
category.If the service returns an enum value that is not available in the current SDK version,
category
will returnICD10CMEntityCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- The category of the entity. InferICD10CM detects entities in the
MEDICAL_CONDITION
category. - See Also:
-
type
Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type
DX_NAME
andTIME_EXPRESSION
.If the service returns an enum value that is not available in the current SDK version,
type
will returnICD10CMEntityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Describes the specific type of entity with category of entities. InferICD10CM detects entities of the
type
DX_NAME
andTIME_EXPRESSION
. - See Also:
-
typeAsString
Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type
DX_NAME
andTIME_EXPRESSION
.If the service returns an enum value that is not available in the current SDK version,
type
will returnICD10CMEntityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Describes the specific type of entity with category of entities. InferICD10CM detects entities of the
type
DX_NAME
andTIME_EXPRESSION
. - See Also:
-
score
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
- Returns:
- The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
-
beginOffset
The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
- Returns:
- The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
-
endOffset
The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
- Returns:
- The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
attributes
The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.
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
hasAttributes()
method.- Returns:
- The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.
-
hasTraits
public final boolean hasTraits()For responses, this returns true if the service returned a value for the Traits property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
traits
Provides Contextual information for the entity. The traits recognized by InferICD10CM are
DIAGNOSIS
,SIGN
,SYMPTOM
, andNEGATION.
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
hasTraits()
method.- Returns:
- Provides Contextual information for the entity. The traits recognized by InferICD10CM are
DIAGNOSIS
,SIGN
,SYMPTOM
, andNEGATION.
-
hasIcd10CMConcepts
public final boolean hasIcd10CMConcepts()For responses, this returns true if the service returned a value for the ICD10CMConcepts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
icd10CMConcepts
The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
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
hasIcd10CMConcepts()
method.- Returns:
- The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ICD10CMEntity.Builder,
ICD10CMEntity> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-