aws_sdk_comprehend/client/
batch_detect_entities.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`BatchDetectEntities`](crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`text_list(impl Into<String>)`](crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder::text_list) / [`set_text_list(Option<Vec::<String>>)`](crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder::set_text_list):<br>required: **true**<br><p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.</p><br>
7    ///   - [`language_code(LanguageCode)`](crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder::language_code) / [`set_language_code(Option<LanguageCode>)`](crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder::set_language_code):<br>required: **true**<br><p>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.</p><br>
8    /// - On success, responds with [`BatchDetectEntitiesOutput`](crate::operation::batch_detect_entities::BatchDetectEntitiesOutput) with field(s):
9    ///   - [`result_list(Vec::<BatchDetectEntitiesItemResult>)`](crate::operation::batch_detect_entities::BatchDetectEntitiesOutput::result_list): <p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>
10    ///   - [`error_list(Vec::<BatchItemError>)`](crate::operation::batch_detect_entities::BatchDetectEntitiesOutput::error_list): <p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>
11    /// - On failure, responds with [`SdkError<BatchDetectEntitiesError>`](crate::operation::batch_detect_entities::BatchDetectEntitiesError)
12    pub fn batch_detect_entities(&self) -> crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder {
13        crate::operation::batch_detect_entities::builders::BatchDetectEntitiesFluentBuilder::new(self.handle.clone())
14    }
15}