aws_sdk_comprehend/client/batch_detect_syntax.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 [`BatchDetectSyntax`](crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`text_list(impl Into<String>)`](crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder::text_list) / [`set_text_list(Option<Vec::<String>>)`](crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder::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 for each document is 5 KB.</p><br>
7 /// - [`language_code(SyntaxLanguageCode)`](crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder::language_code) / [`set_language_code(Option<SyntaxLanguageCode>)`](crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder::set_language_code):<br>required: **true**<br><p>The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</p><br>
8 /// - On success, responds with [`BatchDetectSyntaxOutput`](crate::operation::batch_detect_syntax::BatchDetectSyntaxOutput) with field(s):
9 /// - [`result_list(Vec::<BatchDetectSyntaxItemResult>)`](crate::operation::batch_detect_syntax::BatchDetectSyntaxOutput::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_syntax::BatchDetectSyntaxOutput::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<BatchDetectSyntaxError>`](crate::operation::batch_detect_syntax::BatchDetectSyntaxError)
12 pub fn batch_detect_syntax(&self) -> crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder {
13 crate::operation::batch_detect_syntax::builders::BatchDetectSyntaxFluentBuilder::new(self.handle.clone())
14 }
15}