Struct aws_sdk_comprehendmedical::types::SnomedctEntity

#[non_exhaustive]
pub struct SnomedctEntity {
    pub id: Option<i32>,
    pub text: Option<String>,
    pub category: Option<SnomedctEntityCategory>,
    pub type: Option<SnomedctEntityType>,
    pub score: Option<f32>,
    pub begin_offset: Option<i32>,
    pub end_offset: Option<i32>,
    pub attributes: Option<Vec<SnomedctAttribute>>,
    pub traits: Option<Vec<SnomedctTrait>>,
    pub snomedct_concepts: Option<Vec<SnomedctConcept>>,
}

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.

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.

id: Option<i32>

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

text: Option<String>

The segment of input text extracted as this entity.

category: Option<SnomedctEntityCategory>

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

type: Option<SnomedctEntityType>

Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.

score: Option<f32>

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

begin_offset: Option<i32>

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.

end_offset: Option<i32>

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.

attributes: Option<Vec<SnomedctAttribute>>

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.

traits: Option<Vec<SnomedctTrait>>

Contextual information for the entity.

snomedct_concepts: Option<Vec<SnomedctConcept>>

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Implementations

impl SnomedctEntity

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

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

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

The segment of input text extracted as this entity.

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

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

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

Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.

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

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

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

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.

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

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.

pub fn attributes(&self) -> &[SnomedctAttribute]

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.

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

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

Contextual information for the entity.

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().

pub fn snomedct_concepts(&self) -> &[SnomedctConcept]

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

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

impl SnomedctEntity

pub fn builder() -> SnomedctEntityBuilder

Creates a new builder-style object to manufacture SnomedctEntity.

Trait Implementations

impl Clone for SnomedctEntity

fn clone(&self) -> SnomedctEntity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnomedctEntity

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

Formats the value using the given formatter.

impl PartialEq for SnomedctEntity

fn eq(&self, other: &SnomedctEntity) -> 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 SnomedctEntity