#[non_exhaustive]pub struct DocumentClassifierProperties {Show 19 fields
pub document_classifier_arn: Option<String>,
pub language_code: Option<LanguageCode>,
pub status: Option<ModelStatus>,
pub message: Option<String>,
pub submit_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub training_start_time: Option<DateTime>,
pub training_end_time: Option<DateTime>,
pub input_data_config: Option<DocumentClassifierInputDataConfig>,
pub output_data_config: Option<DocumentClassifierOutputDataConfig>,
pub classifier_metadata: Option<ClassifierMetadata>,
pub data_access_role_arn: Option<String>,
pub volume_kms_key_id: Option<String>,
pub vpc_config: Option<VpcConfig>,
pub mode: Option<DocumentClassifierMode>,
pub model_kms_key_id: Option<String>,
pub version_name: Option<String>,
pub source_model_arn: Option<String>,
pub flywheel_arn: Option<String>,
}Expand description
Provides information about a document classifier.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.document_classifier_arn: Option<String>The Amazon Resource Name (ARN) that identifies the document classifier.
language_code: Option<LanguageCode>The language code for the language of the documents that the classifier was trained on.
status: Option<ModelStatus>The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.
If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
message: Option<String>Additional information about the status of the classifier.
submit_time: Option<DateTime>The time that the document classifier was submitted for training.
end_time: Option<DateTime>The time that training the document classifier completed.
training_start_time: Option<DateTime>Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
training_end_time: Option<DateTime>The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
input_data_config: Option<DocumentClassifierInputDataConfig>The input data configuration that you supplied when you created the document classifier for training.
output_data_config: Option<DocumentClassifierOutputDataConfig>Provides output results configuration parameters for custom classifier jobs.
classifier_metadata: Option<ClassifierMetadata>Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
data_access_role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
volume_kms_key_id: Option<String>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
vpc_config: Option<VpcConfig>Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
mode: Option<DocumentClassifierMode>Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
model_kms_key_id: Option<String>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
version_name: Option<String>The version name that you assigned to the document classifier.
source_model_arn: Option<String>The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.
flywheel_arn: Option<String>The Amazon Resource Number (ARN) of the flywheel
Implementations§
Source§impl DocumentClassifierProperties
impl DocumentClassifierProperties
Sourcepub fn document_classifier_arn(&self) -> Option<&str>
pub fn document_classifier_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that identifies the document classifier.
Sourcepub fn language_code(&self) -> Option<&LanguageCode>
pub fn language_code(&self) -> Option<&LanguageCode>
The language code for the language of the documents that the classifier was trained on.
Sourcepub fn status(&self) -> Option<&ModelStatus>
pub fn status(&self) -> Option<&ModelStatus>
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.
If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
Sourcepub fn message(&self) -> Option<&str>
pub fn message(&self) -> Option<&str>
Additional information about the status of the classifier.
Sourcepub fn submit_time(&self) -> Option<&DateTime>
pub fn submit_time(&self) -> Option<&DateTime>
The time that the document classifier was submitted for training.
Sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
The time that training the document classifier completed.
Sourcepub fn training_start_time(&self) -> Option<&DateTime>
pub fn training_start_time(&self) -> Option<&DateTime>
Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
Sourcepub fn training_end_time(&self) -> Option<&DateTime>
pub fn training_end_time(&self) -> Option<&DateTime>
The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
Sourcepub fn input_data_config(&self) -> Option<&DocumentClassifierInputDataConfig>
pub fn input_data_config(&self) -> Option<&DocumentClassifierInputDataConfig>
The input data configuration that you supplied when you created the document classifier for training.
Sourcepub fn output_data_config(&self) -> Option<&DocumentClassifierOutputDataConfig>
pub fn output_data_config(&self) -> Option<&DocumentClassifierOutputDataConfig>
Provides output results configuration parameters for custom classifier jobs.
Sourcepub fn classifier_metadata(&self) -> Option<&ClassifierMetadata>
pub fn classifier_metadata(&self) -> Option<&ClassifierMetadata>
Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
Sourcepub fn data_access_role_arn(&self) -> Option<&str>
pub fn data_access_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
Sourcepub fn volume_kms_key_id(&self) -> Option<&str>
pub fn volume_kms_key_id(&self) -> Option<&str>
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Sourcepub fn vpc_config(&self) -> Option<&VpcConfig>
pub fn vpc_config(&self) -> Option<&VpcConfig>
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
Sourcepub fn mode(&self) -> Option<&DocumentClassifierMode>
pub fn mode(&self) -> Option<&DocumentClassifierMode>
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
Sourcepub fn model_kms_key_id(&self) -> Option<&str>
pub fn model_kms_key_id(&self) -> Option<&str>
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab" -
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Sourcepub fn version_name(&self) -> Option<&str>
pub fn version_name(&self) -> Option<&str>
The version name that you assigned to the document classifier.
Sourcepub fn source_model_arn(&self) -> Option<&str>
pub fn source_model_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.
Sourcepub fn flywheel_arn(&self) -> Option<&str>
pub fn flywheel_arn(&self) -> Option<&str>
The Amazon Resource Number (ARN) of the flywheel
Source§impl DocumentClassifierProperties
impl DocumentClassifierProperties
Sourcepub fn builder() -> DocumentClassifierPropertiesBuilder
pub fn builder() -> DocumentClassifierPropertiesBuilder
Creates a new builder-style object to manufacture DocumentClassifierProperties.
Trait Implementations§
Source§impl Clone for DocumentClassifierProperties
impl Clone for DocumentClassifierProperties
Source§fn clone(&self) -> DocumentClassifierProperties
fn clone(&self) -> DocumentClassifierProperties
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DocumentClassifierProperties
impl Debug for DocumentClassifierProperties
Source§impl PartialEq for DocumentClassifierProperties
impl PartialEq for DocumentClassifierProperties
Source§fn eq(&self, other: &DocumentClassifierProperties) -> bool
fn eq(&self, other: &DocumentClassifierProperties) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for DocumentClassifierProperties
Auto Trait Implementations§
impl Freeze for DocumentClassifierProperties
impl RefUnwindSafe for DocumentClassifierProperties
impl Send for DocumentClassifierProperties
impl Sync for DocumentClassifierProperties
impl Unpin for DocumentClassifierProperties
impl UnwindSafe for DocumentClassifierProperties
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);