Struct aws_sdk_comprehend::operation::detect_entities::builders::DetectEntitiesFluentBuilder
source · pub struct DetectEntitiesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DetectEntities
.
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors
for each error.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException
error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.
Implementations§
source§impl DetectEntitiesFluentBuilder
impl DetectEntitiesFluentBuilder
sourcepub fn as_input(&self) -> &DetectEntitiesInputBuilder
pub fn as_input(&self) -> &DetectEntitiesInputBuilder
Access the DetectEntities as a reference.
sourcepub async fn send(
self
) -> Result<DetectEntitiesOutput, SdkError<DetectEntitiesError, HttpResponse>>
pub async fn send( self ) -> Result<DetectEntitiesOutput, SdkError<DetectEntitiesError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<DetectEntitiesOutput, DetectEntitiesError, Self>
pub fn customize( self ) -> CustomizableOperation<DetectEntitiesOutput, DetectEntitiesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn text(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_text(self, input: Option<String>) -> Self
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.
sourcepub fn get_text(&self) -> &Option<String>
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.
sourcepub fn language_code(self, input: LanguageCode) -> Self
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.
sourcepub fn set_language_code(self, input: Option<LanguageCode>) -> Self
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.
sourcepub fn get_language_code(&self) -> &Option<LanguageCode>
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.
sourcepub fn endpoint_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_endpoint_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_endpoint_arn(&self) -> &Option<String>
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.
sourcepub fn bytes(self, input: Blob) -> Self
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.
sourcepub fn set_bytes(self, input: Option<Blob>) -> Self
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.
sourcepub fn get_bytes(&self) -> &Option<Blob>
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.
sourcepub fn document_reader_config(self, input: DocumentReaderConfig) -> Self
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.
sourcepub fn set_document_reader_config(
self,
input: Option<DocumentReaderConfig>
) -> Self
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.
sourcepub fn get_document_reader_config(&self) -> &Option<DocumentReaderConfig>
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.
Trait Implementations§
source§impl Clone for DetectEntitiesFluentBuilder
impl Clone for DetectEntitiesFluentBuilder
source§fn clone(&self) -> DetectEntitiesFluentBuilder
fn clone(&self) -> DetectEntitiesFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for DetectEntitiesFluentBuilder
impl !RefUnwindSafe for DetectEntitiesFluentBuilder
impl Send for DetectEntitiesFluentBuilder
impl Sync for DetectEntitiesFluentBuilder
impl Unpin for DetectEntitiesFluentBuilder
impl !UnwindSafe for DetectEntitiesFluentBuilder
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> 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 more