Struct SyntaxToken

#[non_exhaustive]
pub struct SyntaxToken {
    pub token_id: Option<i32>,
    pub text: Option<String>,
    pub begin_offset: Option<i32>,
    pub end_offset: Option<i32>,
    pub part_of_speech: Option<PartOfSpeechTag>,
}

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source 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.

token_id: Option<i32>

A unique identifier for a token.

text: Option<String>

The word that was recognized in the source text.

begin_offset: Option<i32>

The zero-based offset from the beginning of the source text to the first character in the word.

end_offset: Option<i32>

The zero-based offset from the beginning of the source text to the last character in the word.

part_of_speech: Option<PartOfSpeechTag>

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

Implementations

impl SyntaxToken

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

A unique identifier for a token.

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

The word that was recognized in the source text.

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

The zero-based offset from the beginning of the source text to the first character in the word.

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

The zero-based offset from the beginning of the source text to the last character in the word.

pub fn part_of_speech(&self) -> Option<&PartOfSpeechTag>

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

impl SyntaxToken

pub fn builder() -> SyntaxTokenBuilder

Creates a new builder-style object to manufacture SyntaxToken.

Trait Implementations

impl Clone for SyntaxToken

fn clone(&self) -> SyntaxToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxToken

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

Formats the value using the given formatter.

impl PartialEq for SyntaxToken

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SyntaxToken