Struct aws_sdk_comprehendmedical::types::Attribute

#[non_exhaustive]
pub struct Attribute {
    pub type: Option<EntitySubType>,
    pub score: Option<f32>,
    pub relationship_score: Option<f32>,
    pub relationship_type: Option<RelationshipType>,
    pub id: Option<i32>,
    pub begin_offset: Option<i32>,
    pub end_offset: Option<i32>,
    pub text: Option<String>,
    pub category: Option<EntityType>,
    pub traits: Option<Vec<Trait>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Option<EntitySubType>

The type of attribute.

score: Option<f32>

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

relationship_score: Option<f32>

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

relationship_type: Option<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 the Date_Expression.

id: Option<i32>

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

begin_offset: Option<i32>

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.

end_offset: Option<i32>

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: Option<String>

The segment of input text extracted as this attribute.

category: Option<EntityType>

The category of attribute.

traits: Option<Vec<Trait>>

Contextual information for this attribute.

Implementations

impl Attribute

pub fn type(&self) -> Option<&EntitySubType>

The type of attribute.

pub fn score(&self) -> Option<f32>

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

pub fn relationship_score(&self) -> Option<f32>

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

pub fn relationship_type(&self) -> Option<&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 the Date_Expression.

pub fn id(&self) -> Option<i32>

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

pub fn begin_offset(&self) -> Option<i32>

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.

pub fn end_offset(&self) -> Option<i32>

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.

pub fn text(&self) -> Option<&str>

The segment of input text extracted as this attribute.

pub fn category(&self) -> Option<&EntityType>

The category of attribute.

pub fn traits(&self) -> &[Trait]

Contextual information for this attribute.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .traits.is_none().

impl Attribute

pub fn builder() -> AttributeBuilder

Creates a new builder-style object to manufacture Attribute.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Attribute

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Attribute

fn eq(&self, other: &Attribute) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Attribute