AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::Entity Class Reference

#include <Entity.h>

Public Member Functions

 Entity ()
 
 Entity (Aws::Utils::Json::JsonView jsonValue)
 
Entityoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
double GetScore () const
 
bool ScoreHasBeenSet () const
 
void SetScore (double value)
 
EntityWithScore (double value)
 
const EntityTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const EntityType &value)
 
void SetType (EntityType &&value)
 
EntityWithType (const EntityType &value)
 
EntityWithType (EntityType &&value)
 
const Aws::StringGetText () const
 
bool TextHasBeenSet () const
 
void SetText (const Aws::String &value)
 
void SetText (Aws::String &&value)
 
void SetText (const char *value)
 
EntityWithText (const Aws::String &value)
 
EntityWithText (Aws::String &&value)
 
EntityWithText (const char *value)
 
int GetBeginOffset () const
 
bool BeginOffsetHasBeenSet () const
 
void SetBeginOffset (int value)
 
EntityWithBeginOffset (int value)
 
int GetEndOffset () const
 
bool EndOffsetHasBeenSet () const
 
void SetEndOffset (int value)
 
EntityWithEndOffset (int value)
 

Detailed Description

Provides information about an entity.

See Also:

AWS API Reference

Definition at line 32 of file Entity.h.

Constructor & Destructor Documentation

◆ Entity() [1/2]

Aws::Comprehend::Model::Entity::Entity ( )

◆ Entity() [2/2]

Aws::Comprehend::Model::Entity::Entity ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BeginOffsetHasBeenSet()

bool Aws::Comprehend::Model::Entity::BeginOffsetHasBeenSet ( ) const
inline

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 154 of file Entity.h.

◆ EndOffsetHasBeenSet()

bool Aws::Comprehend::Model::Entity::EndOffsetHasBeenSet ( ) const
inline

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 189 of file Entity.h.

◆ GetBeginOffset()

int Aws::Comprehend::Model::Entity::GetBeginOffset ( ) const
inline

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 145 of file Entity.h.

◆ GetEndOffset()

int Aws::Comprehend::Model::Entity::GetEndOffset ( ) const
inline

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 181 of file Entity.h.

◆ GetScore()

double Aws::Comprehend::Model::Entity::GetScore ( ) const
inline

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Definition at line 45 of file Entity.h.

◆ GetText()

const Aws::String& Aws::Comprehend::Model::Entity::GetText ( ) const
inline

The text of the entity.

Definition at line 100 of file Entity.h.

◆ GetType()

const EntityType& Aws::Comprehend::Model::Entity::GetType ( ) const
inline

The entity's type.

Definition at line 69 of file Entity.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Comprehend::Model::Entity::Jsonize ( ) const

◆ operator=()

Entity& Aws::Comprehend::Model::Entity::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ScoreHasBeenSet()

bool Aws::Comprehend::Model::Entity::ScoreHasBeenSet ( ) const
inline

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Definition at line 51 of file Entity.h.

◆ SetBeginOffset()

void Aws::Comprehend::Model::Entity::SetBeginOffset ( int  value)
inline

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 163 of file Entity.h.

◆ SetEndOffset()

void Aws::Comprehend::Model::Entity::SetEndOffset ( int  value)
inline

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 197 of file Entity.h.

◆ SetScore()

void Aws::Comprehend::Model::Entity::SetScore ( double  value)
inline

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Definition at line 57 of file Entity.h.

◆ SetText() [1/3]

void Aws::Comprehend::Model::Entity::SetText ( const Aws::String value)
inline

The text of the entity.

Definition at line 110 of file Entity.h.

◆ SetText() [2/3]

void Aws::Comprehend::Model::Entity::SetText ( Aws::String &&  value)
inline

The text of the entity.

Definition at line 115 of file Entity.h.

◆ SetText() [3/3]

void Aws::Comprehend::Model::Entity::SetText ( const char *  value)
inline

The text of the entity.

Definition at line 120 of file Entity.h.

◆ SetType() [1/2]

void Aws::Comprehend::Model::Entity::SetType ( const EntityType value)
inline

The entity's type.

Definition at line 79 of file Entity.h.

◆ SetType() [2/2]

void Aws::Comprehend::Model::Entity::SetType ( EntityType &&  value)
inline

The entity's type.

Definition at line 84 of file Entity.h.

◆ TextHasBeenSet()

bool Aws::Comprehend::Model::Entity::TextHasBeenSet ( ) const
inline

The text of the entity.

Definition at line 105 of file Entity.h.

◆ TypeHasBeenSet()

bool Aws::Comprehend::Model::Entity::TypeHasBeenSet ( ) const
inline

The entity's type.

Definition at line 74 of file Entity.h.

◆ WithBeginOffset()

Entity& Aws::Comprehend::Model::Entity::WithBeginOffset ( int  value)
inline

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 172 of file Entity.h.

◆ WithEndOffset()

Entity& Aws::Comprehend::Model::Entity::WithEndOffset ( int  value)
inline

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Definition at line 205 of file Entity.h.

◆ WithScore()

Entity& Aws::Comprehend::Model::Entity::WithScore ( double  value)
inline

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Definition at line 63 of file Entity.h.

◆ WithText() [1/3]

Entity& Aws::Comprehend::Model::Entity::WithText ( const Aws::String value)
inline

The text of the entity.

Definition at line 125 of file Entity.h.

◆ WithText() [2/3]

Entity& Aws::Comprehend::Model::Entity::WithText ( Aws::String &&  value)
inline

The text of the entity.

Definition at line 130 of file Entity.h.

◆ WithText() [3/3]

Entity& Aws::Comprehend::Model::Entity::WithText ( const char *  value)
inline

The text of the entity.

Definition at line 135 of file Entity.h.

◆ WithType() [1/2]

Entity& Aws::Comprehend::Model::Entity::WithType ( const EntityType value)
inline

The entity's type.

Definition at line 89 of file Entity.h.

◆ WithType() [2/2]

Entity& Aws::Comprehend::Model::Entity::WithType ( EntityType &&  value)
inline

The entity's type.

Definition at line 94 of file Entity.h.


The documentation for this class was generated from the following file: