Struct aws_sdk_comprehend::client::fluent_builders::DetectEntities

pub struct DetectEntities { /* private fields */ }

Fluent builder constructing a request to DetectEntities.

Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.

Implementations

impl DetectEntities

pub async fn customize(
    self
) -> Result<CustomizableOperation<DetectEntities, AwsResponseRetryClassifier>, SdkError<DetectEntitiesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DetectEntitiesOutput, SdkError<DetectEntitiesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn text(self, input: impl Into<String>) -> Self

A UTF-8 text string. The maximum string size is 100 KB.

pub fn set_text(self, input: Option<String>) -> Self

A UTF-8 text string. The maximum string size is 100 KB.

pub fn language_code(self, input: LanguageCode) -> Self

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 set_language_code(self, input: Option<LanguageCode>) -> Self

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, input: impl Into<String>) -> Self

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.

For information about endpoints, see Managing endpoints.

pub fn set_endpoint_arn(self, input: Option<String>) -> Self

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.

For information about endpoints, see Managing endpoints.

Trait Implementations

impl Clone for DetectEntities

fn clone(&self) -> DetectEntities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DetectEntities

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

Formats the value using the given formatter.