Struct aws_sdk_comprehend::input::DetectEntitiesInput

#[non_exhaustive]
pub struct DetectEntitiesInput {
    pub text: Option<String>,
    pub language_code: Option<LanguageCode>,
    pub endpoint_arn: Option<String>,
}

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.

text: Option<String>

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

language_code: Option<LanguageCode>

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

endpoint_arn: Option<String>

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Implementations

impl DetectEntitiesInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DetectEntities, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DetectEntities>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DetectEntitiesInput

impl DetectEntitiesInput

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

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

pub fn language_code(&self) -> Option<&LanguageCode>

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

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

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Trait Implementations

impl Clone for DetectEntitiesInput

fn clone(&self) -> DetectEntitiesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DetectEntitiesInput

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

Formats the value using the given formatter.

impl PartialEq<DetectEntitiesInput> for DetectEntitiesInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DetectEntitiesInput