/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ComprehendMedical { namespace Model { /** *

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:

* AWS * API Reference

*/ class SNOMEDCTEntity { public: AWS_COMPREHENDMEDICAL_API SNOMEDCTEntity(); AWS_COMPREHENDMEDICAL_API SNOMEDCTEntity(Aws::Utils::Json::JsonView jsonValue); AWS_COMPREHENDMEDICAL_API SNOMEDCTEntity& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_COMPREHENDMEDICAL_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline int GetId() const{ return m_id; } /** *

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

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

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

*/ inline void SetId(int value) { m_idHasBeenSet = true; m_id = value; } /** *

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

*/ inline SNOMEDCTEntity& WithId(int value) { SetId(value); return *this;} /** *

The segment of input text extracted as this entity.

*/ inline const Aws::String& GetText() const{ return m_text; } /** *

The segment of input text extracted as this entity.

*/ inline bool TextHasBeenSet() const { return m_textHasBeenSet; } /** *

The segment of input text extracted as this entity.

*/ inline void SetText(const Aws::String& value) { m_textHasBeenSet = true; m_text = value; } /** *

The segment of input text extracted as this entity.

*/ inline void SetText(Aws::String&& value) { m_textHasBeenSet = true; m_text = std::move(value); } /** *

The segment of input text extracted as this entity.

*/ inline void SetText(const char* value) { m_textHasBeenSet = true; m_text.assign(value); } /** *

The segment of input text extracted as this entity.

*/ inline SNOMEDCTEntity& WithText(const Aws::String& value) { SetText(value); return *this;} /** *

The segment of input text extracted as this entity.

*/ inline SNOMEDCTEntity& WithText(Aws::String&& value) { SetText(std::move(value)); return *this;} /** *

The segment of input text extracted as this entity.

*/ inline SNOMEDCTEntity& WithText(const char* value) { SetText(value); return *this;} /** *

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

*/ inline const SNOMEDCTEntityCategory& GetCategory() const{ return m_category; } /** *

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

*/ inline bool CategoryHasBeenSet() const { return m_categoryHasBeenSet; } /** *

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

*/ inline void SetCategory(const SNOMEDCTEntityCategory& value) { m_categoryHasBeenSet = true; m_category = value; } /** *

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

*/ inline void SetCategory(SNOMEDCTEntityCategory&& value) { m_categoryHasBeenSet = true; m_category = std::move(value); } /** *

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

*/ inline SNOMEDCTEntity& WithCategory(const SNOMEDCTEntityCategory& value) { SetCategory(value); return *this;} /** *

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

*/ inline SNOMEDCTEntity& WithCategory(SNOMEDCTEntityCategory&& value) { SetCategory(std::move(value)); return *this;} /** *

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.

*/ inline const SNOMEDCTEntityType& GetType() const{ return m_type; } /** *

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.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

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.

*/ inline void SetType(const SNOMEDCTEntityType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

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.

*/ inline void SetType(SNOMEDCTEntityType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

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.

*/ inline SNOMEDCTEntity& WithType(const SNOMEDCTEntityType& value) { SetType(value); return *this;} /** *

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.

*/ inline SNOMEDCTEntity& WithType(SNOMEDCTEntityType&& value) { SetType(std::move(value)); return *this;} /** *

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

*/ inline double GetScore() const{ return m_score; } /** *

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

*/ inline bool ScoreHasBeenSet() const { return m_scoreHasBeenSet; } /** *

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

*/ inline void SetScore(double value) { m_scoreHasBeenSet = true; m_score = value; } /** *

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

*/ inline SNOMEDCTEntity& WithScore(double value) { SetScore(value); return *this;} /** *

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.

*/ inline int GetBeginOffset() const{ return m_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.

*/ inline bool BeginOffsetHasBeenSet() const { return m_beginOffsetHasBeenSet; } /** *

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.

*/ inline void SetBeginOffset(int value) { m_beginOffsetHasBeenSet = true; m_beginOffset = value; } /** *

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.

*/ inline SNOMEDCTEntity& WithBeginOffset(int value) { SetBeginOffset(value); return *this;} /** *

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.

*/ inline int GetEndOffset() const{ return m_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.

*/ inline bool EndOffsetHasBeenSet() const { return m_endOffsetHasBeenSet; } /** *

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.

*/ inline void SetEndOffset(int value) { m_endOffsetHasBeenSet = true; m_endOffset = value; } /** *

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.

*/ inline SNOMEDCTEntity& WithEndOffset(int value) { SetEndOffset(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetAttributes() const{ return m_attributes; } /** *

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.

*/ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

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.

*/ inline void SetAttributes(const Aws::Vector& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

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.

*/ inline void SetAttributes(Aws::Vector&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

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.

*/ inline SNOMEDCTEntity& WithAttributes(const Aws::Vector& value) { SetAttributes(value); return *this;} /** *

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.

*/ inline SNOMEDCTEntity& WithAttributes(Aws::Vector&& value) { SetAttributes(std::move(value)); return *this;} /** *

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.

*/ inline SNOMEDCTEntity& AddAttributes(const SNOMEDCTAttribute& value) { m_attributesHasBeenSet = true; m_attributes.push_back(value); return *this; } /** *

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.

*/ inline SNOMEDCTEntity& AddAttributes(SNOMEDCTAttribute&& value) { m_attributesHasBeenSet = true; m_attributes.push_back(std::move(value)); return *this; } /** *

Contextual information for the entity.

*/ inline const Aws::Vector& GetTraits() const{ return m_traits; } /** *

Contextual information for the entity.

*/ inline bool TraitsHasBeenSet() const { return m_traitsHasBeenSet; } /** *

Contextual information for the entity.

*/ inline void SetTraits(const Aws::Vector& value) { m_traitsHasBeenSet = true; m_traits = value; } /** *

Contextual information for the entity.

*/ inline void SetTraits(Aws::Vector&& value) { m_traitsHasBeenSet = true; m_traits = std::move(value); } /** *

Contextual information for the entity.

*/ inline SNOMEDCTEntity& WithTraits(const Aws::Vector& value) { SetTraits(value); return *this;} /** *

Contextual information for the entity.

*/ inline SNOMEDCTEntity& WithTraits(Aws::Vector&& value) { SetTraits(std::move(value)); return *this;} /** *

Contextual information for the entity.

*/ inline SNOMEDCTEntity& AddTraits(const SNOMEDCTTrait& value) { m_traitsHasBeenSet = true; m_traits.push_back(value); return *this; } /** *

Contextual information for the entity.

*/ inline SNOMEDCTEntity& AddTraits(SNOMEDCTTrait&& value) { m_traitsHasBeenSet = true; m_traits.push_back(std::move(value)); return *this; } /** *

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

*/ inline const Aws::Vector& GetSNOMEDCTConcepts() const{ return m_sNOMEDCTConcepts; } /** *

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

*/ inline bool SNOMEDCTConceptsHasBeenSet() const { return m_sNOMEDCTConceptsHasBeenSet; } /** *

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

*/ inline void SetSNOMEDCTConcepts(const Aws::Vector& value) { m_sNOMEDCTConceptsHasBeenSet = true; m_sNOMEDCTConcepts = value; } /** *

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

*/ inline void SetSNOMEDCTConcepts(Aws::Vector&& value) { m_sNOMEDCTConceptsHasBeenSet = true; m_sNOMEDCTConcepts = std::move(value); } /** *

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

*/ inline SNOMEDCTEntity& WithSNOMEDCTConcepts(const Aws::Vector& value) { SetSNOMEDCTConcepts(value); return *this;} /** *

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

*/ inline SNOMEDCTEntity& WithSNOMEDCTConcepts(Aws::Vector&& value) { SetSNOMEDCTConcepts(std::move(value)); return *this;} /** *

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

*/ inline SNOMEDCTEntity& AddSNOMEDCTConcepts(const SNOMEDCTConcept& value) { m_sNOMEDCTConceptsHasBeenSet = true; m_sNOMEDCTConcepts.push_back(value); return *this; } /** *

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

*/ inline SNOMEDCTEntity& AddSNOMEDCTConcepts(SNOMEDCTConcept&& value) { m_sNOMEDCTConceptsHasBeenSet = true; m_sNOMEDCTConcepts.push_back(std::move(value)); return *this; } private: int m_id; bool m_idHasBeenSet = false; Aws::String m_text; bool m_textHasBeenSet = false; SNOMEDCTEntityCategory m_category; bool m_categoryHasBeenSet = false; SNOMEDCTEntityType m_type; bool m_typeHasBeenSet = false; double m_score; bool m_scoreHasBeenSet = false; int m_beginOffset; bool m_beginOffsetHasBeenSet = false; int m_endOffset; bool m_endOffsetHasBeenSet = false; Aws::Vector m_attributes; bool m_attributesHasBeenSet = false; Aws::Vector m_traits; bool m_traitsHasBeenSet = false; Aws::Vector m_sNOMEDCTConcepts; bool m_sNOMEDCTConceptsHasBeenSet = false; }; } // namespace Model } // namespace ComprehendMedical } // namespace Aws