Integer index
The zero-based index of the document in the input list.
List<E> languages
One or more DominantLanguage objects describing the dominant languages in the document.
List<E> resultList
A list of objects containing the results of the operation. The results are sorted in ascending order by the
Index field and match the order of the documents in the input list. If all of the documents contain
an error, the ResultList is empty.
List<E> errorList
A list containing one object for each document that contained an error. The results are sorted in ascending order
by the Index field and match the order of the documents in the input list. If there are no errors in
the batch, the ErrorList is empty.
List<E> textList
A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
List<E> resultList
A list of objects containing the results of the operation. The results are sorted in ascending order by the
Index field and match the order of the documents in the input list. If all of the documents contain
an error, the ResultList is empty.
List<E> errorList
A list containing one object for each document that contained an error. The results are sorted in ascending order
by the Index field and match the order of the documents in the input list. If there are no errors in
the batch, the ErrorList is empty.
List<E> textList
A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
List<E> resultList
A list of objects containing the results of the operation. The results are sorted in ascending order by the
Index field and match the order of the documents in the input list. If all of the documents contain
an error, the ResultList is empty.
List<E> errorList
A list containing one object for each document that contained an error. The results are sorted in ascending order
by the Index field and match the order of the documents in the input list. If there are no errors in
the batch, the ErrorList is empty.
Integer index
The zero-based index of the document in the input list.
String sentiment
The sentiment detected in the document.
SentimentScore sentimentScore
The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
List<E> textList
A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
List<E> resultList
A list of objects containing the results of the operation. The results are sorted in ascending order by the
Index field and match the order of the documents in the input list. If all of the documents contain
an error, the ResultList is empty.
List<E> errorList
A list containing one object for each document that contained an error. The results are sorted in ascending order
by the Index field and match the order of the documents in the input list. If there are no errors in
the batch, the ErrorList is empty.
List<E> textList
A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
List<E> resultList
A list of objects containing the results of the operation. The results are sorted in ascending order by the
Index field and match the order of the documents in the input list. If all of the documents contain
an error, the ResultList is empty.
List<E> errorList
A list containing one object for each document that contained an error. The results are sorted in ascending order
by the Index field and match the order of the documents in the input list. If there are no errors in
the batch, the ErrorList is empty.
String jobId
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
DominantLanguageDetectionJobProperties dominantLanguageDetectionJobProperties
An object that contains the properties associated with a dominant language detection job.
String jobId
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
EntitiesDetectionJobProperties entitiesDetectionJobProperties
An object that contains the properties associated with an entities detection job.
String jobId
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
KeyPhrasesDetectionJobProperties keyPhrasesDetectionJobProperties
An object that contains the properties associated with a key phrases detection job.
String jobId
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
SentimentDetectionJobProperties sentimentDetectionJobProperties
An object that contains the properties associated with a sentiment detection job.
String jobId
The identifier assigned by the user to the detection job.
TopicsDetectionJobProperties topicsDetectionJobProperties
The list of properties for the requested job.
String text
A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
List<E> languages
The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
List<E> entities
A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see how-entities.
List<E> keyPhrases
A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
String sentiment
The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
SentimentScore sentimentScore
An object that lists the sentiments, and their corresponding confidence levels.
List<E> syntaxTokens
A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.
String languageCode
The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
Float score
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
String jobName
Filters on the name of the job.
String jobStatus
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Date submitTimeBefore
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Date submitTimeAfter
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
String jobId
The identifier assigned to the dominant language detection job.
String jobName
The name that you assigned to the dominant language detection job.
String jobStatus
The current status of the dominant language detection job. If the status is FAILED, the
Message field shows the reason for the failure.
String message
A description for the status of a job.
Date submitTime
The time that the dominant language detection job was submitted for processing.
Date endTime
The time that the dominant language detection job completed.
InputDataConfig inputDataConfig
The input data configuration that you supplied when you created the dominant language detection job.
OutputDataConfig outputDataConfig
The output data configuration that you supplied when you created the dominant language detection job.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
String jobName
Filters on the name of the job.
String jobStatus
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Date submitTimeBefore
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Date submitTimeAfter
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
String jobId
The identifier assigned to the entities detection job.
String jobName
The name that you assigned the entities detection job.
String jobStatus
The current status of the entities detection job. If the status is FAILED, the Message
field shows the reason for the failure.
String message
A description of the status of a job.
Date submitTime
The time that the entities detection job was submitted for processing.
Date endTime
The time that the entities detection job completed
InputDataConfig inputDataConfig
The input data configuration that you supplied when you created the entities detection job.
OutputDataConfig outputDataConfig
The output data configuration that you supplied when you created the entities detection job.
String languageCode
The language code of the input documents.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
Float score
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
String type
The entity's type.
String text
The text of the entity.
Integer beginOffset
A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
Integer endOffset
A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
String s3Uri
The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
them as input.
String inputFormat
Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
processing large documents, such as newspaper articles or scientific papers.
ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
are processing many short documents, such as text messages.
Float score
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
String text
The text of a key noun phrase.
Integer beginOffset
A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
Integer endOffset
A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8
code point in the string. A code point is the abstract character from a particular graphical
representation. For example, a multi-byte UTF-8 character maps to a single code point.
String jobName
Filters on the name of the job.
String jobStatus
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Date submitTimeBefore
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Date submitTimeAfter
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
String jobId
The identifier assigned to the key phrases detection job.
String jobName
The name that you assigned the key phrases detection job.
String jobStatus
The current status of the key phrases detection job. If the status is FAILED, the
Message field shows the reason for the failure.
String message
A description of the status of a job.
Date submitTime
The time that the key phrases detection job was submitted for processing.
Date endTime
The time that the key phrases detection job completed.
InputDataConfig inputDataConfig
The input data configuration that you supplied when you created the key phrases detection job.
OutputDataConfig outputDataConfig
The output data configuration that you supplied when you created the key phrases detection job.
String languageCode
The language code of the input documents.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
DominantLanguageDetectionJobFilter filter
Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
EntitiesDetectionJobFilter filter
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
KeyPhrasesDetectionJobFilter filter
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
SentimentDetectionJobFilter filter
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
TopicsDetectionJobFilter filter
Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.
String nextToken
Identifies the next page of results to return.
Integer maxResults
The maximum number of results to return in each page. The default is 100.
String s3Uri
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
location where you want to write the output data. The URI must be in the same region as the API endpoint that you
are calling. The location is used as the prefix for the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a directory specific to the job.
The S3Uri field contains the location of the output file, called output.tar.gz. It is a
compressed archive that contains the ouput of the operation.
String jobName
Filters on the name of the job.
String jobStatus
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Date submitTimeBefore
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Date submitTimeAfter
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
String jobId
The identifier assigned to the sentiment detection job.
String jobName
The name that you assigned to the sentiment detection job
String jobStatus
The current status of the sentiment detection job. If the status is FAILED, the
Messages field shows the reason for the failure.
String message
A description of the status of a job.
Date submitTime
The time that the sentiment detection job was submitted for processing.
Date endTime
The time that the sentiment detection job ended.
InputDataConfig inputDataConfig
The input data configuration that you supplied when you created the sentiment detection job.
OutputDataConfig outputDataConfig
The output data configuration that you supplied when you created the sentiment detection job.
String languageCode
The language code of the input documents.
String dataAccessRoleArn
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
Float positive
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE
sentiment.
Float negative
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE
sentiment.
Float neutral
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL
sentiment.
Float mixed
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED
sentiment.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
String jobName
An identifier for the job.
String clientRequestToken
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
String jobId
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
String jobStatus
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
String jobName
The identifier of the job.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
String clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
String jobId
The identifier generated for the job. To get the status of job, use this identifier with the operation.
String jobStatus
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
String jobName
The identifier of the job.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
String clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
String jobId
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
String jobStatus
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
String jobName
The identifier of the job.
String languageCode
The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.
String clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
String jobId
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
String jobStatus
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.
InputDataConfig inputDataConfig
Specifies the format and location of the input data for the job.
OutputDataConfig outputDataConfig
Specifies where to send the output files. The output is a compressed archive with two files,
topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv
that lists the documents associated with each topic
String dataAccessRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
String jobName
The identifier of the job.
Integer numberOfTopics
The number of topics to detect.
String clientRequestToken
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
String jobId
The identifier generated for the job. To get the status of the job, use this identifier with the
DescribeTopicDetectionJob operation.
String jobStatus
The status of the job:
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.
String jobId
The identifier of the dominant language detection job to stop.
String jobId
The identifier of the entities detection job to stop.
String jobId
The identifier of the key phrases detection job to stop.
String jobId
The identifier of the sentiment detection job to stop.
Integer tokenId
A unique identifier for a token.
String text
The word that was recognized in the source text.
Integer beginOffset
The zero-based offset from the beginning of the source text to the first character in the word.
Integer endOffset
The zero-based offset from the beginning of the source text to the last character in the word.
PartOfSpeechTag partOfSpeech
Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
String jobName
String jobStatus
Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
Date submitTimeBefore
Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
Date submitTimeAfter
Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
String jobId
The identifier assigned to the topic detection job.
String jobName
The name of the topic detection job.
String jobStatus
The current status of the topic detection job. If the status is Failed, the reason for the failure
is shown in the Message field.
String message
A description for the status of a job.
Date submitTime
The time that the topic detection job was submitted for processing.
Date endTime
The time that the topic detection job was completed.
InputDataConfig inputDataConfig
The input data configuration supplied when you created the topic detection job.
OutputDataConfig outputDataConfig
The output data configuration supplied when you created the topic detection job.
Integer numberOfTopics
The number of topics to detect supplied when you created the topic detection job. The default is 10.
Copyright © 2018. All rights reserved.