Struct EntityRecognizerMetadata

#[non_exhaustive]
pub struct EntityRecognizerMetadata {
    pub number_of_trained_documents: Option<i32>,
    pub number_of_test_documents: Option<i32>,
    pub evaluation_metrics: Option<EntityRecognizerEvaluationMetrics>,
    pub entity_types: Option<Vec<EntityRecognizerMetadataEntityTypesListItem>>,
}

Detailed information about an entity recognizer.

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.

number_of_trained_documents: Option<i32>

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

number_of_test_documents: Option<i32>

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

evaluation_metrics: Option<EntityRecognizerEvaluationMetrics>

Detailed information about the accuracy of an entity recognizer.

entity_types: Option<Vec<EntityRecognizerMetadataEntityTypesListItem>>

Entity types from the metadata of an entity recognizer.

Implementations

impl EntityRecognizerMetadata

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

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

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

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

pub fn evaluation_metrics(&self) -> Option<&EntityRecognizerEvaluationMetrics>

Detailed information about the accuracy of an entity recognizer.

pub fn entity_types(&self) -> &[EntityRecognizerMetadataEntityTypesListItem]

Entity types from the metadata of an entity recognizer.

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

impl EntityRecognizerMetadata

pub fn builder() -> EntityRecognizerMetadataBuilder

Creates a new builder-style object to manufacture EntityRecognizerMetadata.

Trait Implementations

impl Clone for EntityRecognizerMetadata

fn clone(&self) -> EntityRecognizerMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRecognizerMetadata

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

Formats the value using the given formatter.

impl PartialEq for EntityRecognizerMetadata

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