Struct aws_sdk_comprehend::operation::detect_entities::builders::DetectEntitiesInputBuilder

#[non_exhaustive]
pub struct DetectEntitiesInputBuilder { /* private fields */ }

A builder for DetectEntitiesInput.

Implementations

impl DetectEntitiesInputBuilder

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

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.

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

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.

pub fn get_text(&self) -> &Option<String>

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.

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. 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.

All input documents must be in the same language.

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. 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.

All input documents must be in the same language.

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.

All input documents must be in the same language.

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.

pub fn get_endpoint_arn(&self) -> &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.

For information about endpoints, see Managing endpoints.

pub fn bytes(self, input: Blob) -> Self

This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.

Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).

You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

If you use the Bytes parameter, do not use the Text parameter.

pub fn set_bytes(self, input: Option<Blob>) -> Self

This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.

Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).

You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

If you use the Bytes parameter, do not use the Text parameter.

pub fn get_bytes(&self) -> &Option<Blob>

This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.

Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).

You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

If you use the Bytes parameter, do not use the Text parameter.

pub fn document_reader_config(self, input: DocumentReaderConfig) -> Self

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

pub fn set_document_reader_config( self, input: Option<DocumentReaderConfig>, ) -> Self

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

pub fn get_document_reader_config(&self) -> &Option<DocumentReaderConfig>

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

pub fn build(self) -> Result<DetectEntitiesInput, BuildError>

Consumes the builder and constructs a DetectEntitiesInput.

impl DetectEntitiesInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<DetectEntitiesOutput, SdkError<DetectEntitiesError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for DetectEntitiesInputBuilder

fn clone(&self) -> DetectEntitiesInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DetectEntitiesInputBuilder

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

Formats the value using the given formatter.

impl Default for DetectEntitiesInputBuilder

fn default() -> DetectEntitiesInputBuilder

Returns the “default value” for a type.

impl PartialEq for DetectEntitiesInputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DetectEntitiesInputBuilder