Serialized Form (AWS Java SDK for Amazon Comprehend 1.11.301 API)

Package com.amazonaws.services.comprehend.model
- Class com.amazonaws.services.comprehend.model.AmazonComprehendException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - languages
```
List<E> languages
```
      One or more DominantLanguage objects describing the dominant languages in the document.
- Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
- Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
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.
    - errorList
```
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.
- Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - entities
```
List<E> entities
```
      One or more Entity objects, one for each entity detected in the document.
- Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
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.
    - languageCode
```
String languageCode
```
      The language of the input documents. All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
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.
    - errorList
```
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.
- Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - keyPhrases
```
List<E> keyPhrases
```
      One or more KeyPhrase objects, one for each key phrase detected in the document.
- Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
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.
    - languageCode
```
String languageCode
```
      The language of the input documents. All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
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.
    - errorList
```
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.
- Class com.amazonaws.services.comprehend.model.BatchDetectSentimentItemResult extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - sentiment
```
String sentiment
```
      The sentiment detected in the document.
    - sentimentScore
```
SentimentScore sentimentScore
```
      The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
- Class com.amazonaws.services.comprehend.model.BatchDetectSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - textList
```
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.
    - languageCode
```
String languageCode
```
      The language of the input documents. All documents must be in the same language.
- Class com.amazonaws.services.comprehend.model.BatchDetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resultList
```
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.
    - errorList
```
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.
- Class com.amazonaws.services.comprehend.model.BatchItemError extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      The zero-based index of the document in the input list.
    - errorCode
```
String errorCode
```
      The numeric error code of the error.
    - errorMessage
```
String errorMessage
```
      A text description of the error.
- Class com.amazonaws.services.comprehend.model.BatchSizeLimitExceededException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned by the user to the detection job.
- Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - topicsDetectionJobProperties
```
TopicsDetectionJobProperties topicsDetectionJobProperties
```
      The list of properties for the requested job.
- Class com.amazonaws.services.comprehend.model.DetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
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.
- Class com.amazonaws.services.comprehend.model.DetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - languages
```
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.
- Class com.amazonaws.services.comprehend.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The RFC 5646 language code of the input text. If the request does not specify the language code, the service detects the dominant language. If you specify a language code that the service does not support, it returns UnsupportedLanguageException exception. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
- Class com.amazonaws.services.comprehend.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
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.
- Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and UnsupportedLanguageException. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
- Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyPhrases
```
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.
- Class com.amazonaws.services.comprehend.model.DetectSentimentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    - languageCode
```
String languageCode
```
      The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and UnsupportedLanguageException. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
- Class com.amazonaws.services.comprehend.model.DetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sentiment
```
String sentiment
```
      The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
    - sentimentScore
```
SentimentScore sentimentScore
```
      An object that lists the sentiments, and their corresponding confidence levels.
- Class com.amazonaws.services.comprehend.model.DominantLanguage extends Object implements Serializable
  - Serialized Fields
    - languageCode
```
String languageCode
```
      The RFC 5646 language code for the dominant language.
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
- Class com.amazonaws.services.comprehend.model.Entity extends Object implements Serializable
  - Serialized Fields
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    - type
```
String type
```
      The entity's type.
    - text
```
String text
```
      The text of the entity.
    - beginOffset
```
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.
    - endOffset
```
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.
- Class com.amazonaws.services.comprehend.model.InputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
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.
    - inputFormat
```
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.
- Class com.amazonaws.services.comprehend.model.InternalServerException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.InvalidFilterException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.InvalidRequestException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.JobNotFoundException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.KeyPhrase extends Object implements Serializable
  - Serialized Fields
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    - text
```
String text
```
      The text of a key noun phrase.
    - beginOffset
```
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.
    - endOffset
```
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.
- Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
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.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page.
- Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - topicsDetectionJobPropertiesList
```
List<E> topicsDetectionJobPropertiesList
```
      A list containing the properties of each job that is returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehend.model.OutputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Uri
```
String s3Uri
```
      The Amazon S3 URI 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 service creates an output file called output.tar.gz. It is a compressed archive that contains 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. For more information, see topic-modeling.
- Class com.amazonaws.services.comprehend.model.SentimentScore extends Object implements Serializable
  - Serialized Fields
    - positive
```
Float positive
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
    - negative
```
Float negative
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
    - neutral
```
Float neutral
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
    - mixed
```
Float mixed
```
      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
- Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
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.
    - jobName
```
String jobName
```
      The identifier of the job.
    - numberOfTopics
```
Integer numberOfTopics
```
      The number of topics to detect.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
- Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
    - jobStatus
```
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.
- Class com.amazonaws.services.comprehend.model.TextSizeLimitExceededException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.TooManyRequestsException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehend.model.TopicsDetectionJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
    - jobStatus
```
String jobStatus
```
      Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
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.
    - submitTimeAfter
```
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.
- Class com.amazonaws.services.comprehend.model.TopicsDetectionJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the topic detection job.
    - jobName
```
String jobName
```
      The name of the topic detection job.
    - jobStatus
```
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.
    - message
```
String message
```
      A description for the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the topic detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the topic detection job was completed.
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      The input data configuration supplied when you created the topic detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration supplied when you created the topic detection job.
    - numberOfTopics
```
Integer numberOfTopics
```
      The number of topics to detect supplied when you created the topic detection job. The default is 10.
- Class com.amazonaws.services.comprehend.model.UnsupportedLanguageException extends AmazonComprehendException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.amazonaws.services.comprehend.model

Class com.amazonaws.services.comprehend.model.AmazonComprehendException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageItemResult extends Object implements Serializable

Serialized Fields

index

languages

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult extends Object implements Serializable

Serialized Fields

index

entities

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult extends Object implements Serializable

Serialized Fields

index

keyPhrases

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentItemResult extends Object implements Serializable

Serialized Fields

index

sentiment

sentimentScore

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

textList

languageCode

Class com.amazonaws.services.comprehend.model.BatchDetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resultList

errorList

Class com.amazonaws.services.comprehend.model.BatchItemError extends Object implements Serializable

Serialized Fields

index

errorCode

errorMessage

Class com.amazonaws.services.comprehend.model.BatchSizeLimitExceededException extends AmazonComprehendException implements Serializable

Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

topicsDetectionJobProperties

Class com.amazonaws.services.comprehend.model.DetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

Class com.amazonaws.services.comprehend.model.DetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

languages

Class com.amazonaws.services.comprehend.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

languageCode

Class com.amazonaws.services.comprehend.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

entities

Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

languageCode