Class Attribute
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Attribute.Builder,
Attribute>
An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The 0-based character offset in the input text that shows where the attribute begins.static Attribute.Builder
builder()
final EntityType
category()
The category of attribute.final String
The category of attribute.final Integer
The 0-based character offset in the input text that shows where the attribute 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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Traits property.final Integer
id()
The numeric identifier for this attribute.final Float
The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.final RelationshipType
The type of relationship between the entity and attribute.final String
The type of relationship between the entity and attribute.final Float
score()
The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.static Class
<? extends Attribute.Builder> final String
text()
The segment of input text extracted as this attribute.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.traits()
Contextual information for this attribute.final EntitySubType
type()
The type of attribute.final String
The type of attribute.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type of attribute.
If the service returns an enum value that is not available in the current SDK version,
type
will returnEntitySubType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of attribute.
- See Also:
-
typeAsString
The type of attribute.
If the service returns an enum value that is not available in the current SDK version,
type
will returnEntitySubType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of attribute.
- See Also:
-
score
The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
- Returns:
- The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
-
relationshipScore
The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
- Returns:
- The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
-
relationshipType
The type of relationship between the entity and attribute. Type for the relationship is
OVERLAP
, indicating that the entity occurred at the same time as theDate_Expression
.If the service returns an enum value that is not available in the current SDK version,
relationshipType
will returnRelationshipType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrelationshipTypeAsString()
.- Returns:
- The type of relationship between the entity and attribute. Type for the relationship is
OVERLAP
, indicating that the entity occurred at the same time as theDate_Expression
. - See Also:
-
relationshipTypeAsString
The type of relationship between the entity and attribute. Type for the relationship is
OVERLAP
, indicating that the entity occurred at the same time as theDate_Expression
.If the service returns an enum value that is not available in the current SDK version,
relationshipType
will returnRelationshipType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrelationshipTypeAsString()
.- Returns:
- The type of relationship between the entity and attribute. Type for the relationship is
OVERLAP
, indicating that the entity occurred at the same time as theDate_Expression
. - See Also:
-
id
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
- Returns:
- The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
-
beginOffset
The 0-based character offset in the input text that shows where the attribute 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 attribute 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 attribute 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 attribute ends. The offset returns the UTF-8 code point in the string.
-
text
The segment of input text extracted as this attribute.
- Returns:
- The segment of input text extracted as this attribute.
-
category
The category of attribute.
If the service returns an enum value that is not available in the current SDK version,
category
will returnEntityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- The category of attribute.
- See Also:
-
categoryAsString
The category of attribute.
If the service returns an enum value that is not available in the current SDK version,
category
will returnEntityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- The category of attribute.
- See Also:
-
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
Contextual information for this attribute.
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:
- Contextual information for this attribute.
-
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<Attribute.Builder,
Attribute> - 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
-