java.lang.Object
- software.amazon.awssdk.services.comprehendmedical.model.ICD10CMEntity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ICD10CMEntity.Builder,ICD10CMEntity>
```
@Generated("software.amazon.awssdk:codegen")
public final class ICD10CMEntity
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ICD10CMEntity.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ICD10CMAttribute>`	`attributes()`	The detected attributes that relate to the entity.
`Integer`	`beginOffset()`	The 0-based character offset in the input text that shows where the entity begins.
`static ICD10CMEntity.Builder`	`builder()`
`ICD10CMEntityCategory`	`category()`	The category of the entity.
`String`	`categoryAsString()`	The category of the entity.
`Integer`	`endOffset()`	The 0-based character offset in the input text that shows where the entity ends.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasIcd10CMConcepts()`	For responses, this returns true if the service returned a value for the ICD10CMConcepts property.
`boolean`	`hasTraits()`	For responses, this returns true if the service returned a value for the Traits property.
`List<ICD10CMConcept>`	`icd10CMConcepts()`	The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
`Integer`	`id()`	The numeric identifier for the entity.
`Float`	`score()`	The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ICD10CMEntity.Builder>`	`serializableBuilderClass()`
`String`	`text()`	The segment of input text that is matched to the detected entity.
`ICD10CMEntity.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<ICD10CMTrait>`	`traits()`	Provides Contextual information for the entity.
`ICD10CMEntityType`	`type()`	Describes the specific type of entity with category of entities.
`String`	`typeAsString()`	Describes the specific type of entity with category of entities.

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
  - id
```
public final Integer 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
```
public final String 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
```
public final ICD10CMEntityCategory 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 return ICD10CMEntityCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().
    
    Returns:
    
    The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
    
    See Also:
    
    ICD10CMEntityCategory
  - categoryAsString
```
public final String 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 return ICD10CMEntityCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().
    
    Returns:
    
    The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
    
    See Also:
    
    ICD10CMEntityCategory
  - type
```
public final ICD10CMEntityType type()
```
    Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ICD10CMEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.
    
    See Also:
    
    ICD10CMEntityType
  - typeAsString
```
public final String typeAsString()
```
    Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ICD10CMEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.
    
    See Also:
    
    ICD10CMEntityType
  - score
```
public final Float 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
```
public final Integer 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
```
public final Integer 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 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.
  - attributes
```
public final List<ICD10CMAttribute> 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 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.
  - traits
```
public final List<ICD10CMTrait> traits()
```
    Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
    
    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, and NEGATION.
  - 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 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.
  - icd10CMConcepts
```
public final List<ICD10CMConcept> 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
```
public ICD10CMEntity.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ICD10CMEntity.Builder,ICD10CMEntity>
  - builder
```
public static ICD10CMEntity.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ICD10CMEntity.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ICD10CMEntity

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

text

category

categoryAsString

type

typeAsString

score

beginOffset

endOffset

hasAttributes

attributes

hasTraits

traits

hasIcd10CMConcepts

icd10CMConcepts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields