Struct DocumentLabel

#[non_exhaustive]
pub struct DocumentLabel {
    pub name: Option<String>,
    pub score: Option<f32>,
    pub page: Option<i32>,
}

Specifies one of the label or labels that categorize the document being analyzed.

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.

name: Option<String>

The name of the label.

score: Option<f32>

The confidence score that Amazon Comprehend has this label correctly attributed.

page: Option<i32>

Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

Implementations

impl DocumentLabel

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

The name of the label.

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

The confidence score that Amazon Comprehend has this label correctly attributed.

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

Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

impl DocumentLabel

pub fn builder() -> DocumentLabelBuilder

Creates a new builder-style object to manufacture DocumentLabel.

Trait Implementations

impl Clone for DocumentLabel

fn clone(&self) -> DocumentLabel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentLabel

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

Formats the value using the given formatter.

impl PartialEq for DocumentLabel

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

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

const 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 DocumentLabel