Table of Contents
Comprehend.Client¶A low-level client representing Amazon Comprehend
Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.
import boto3
client = boto3.client('comprehend')
These are the available methods:
batch_detect_dominant_language()batch_detect_entities()batch_detect_key_phrases()batch_detect_sentiment()batch_detect_syntax()batch_detect_targeted_sentiment()can_paginate()classify_document()close()contains_pii_entities()create_document_classifier()create_endpoint()create_entity_recognizer()delete_document_classifier()delete_endpoint()delete_entity_recognizer()delete_resource_policy()describe_document_classification_job()describe_document_classifier()describe_dominant_language_detection_job()describe_endpoint()describe_entities_detection_job()describe_entity_recognizer()describe_events_detection_job()describe_key_phrases_detection_job()describe_pii_entities_detection_job()describe_resource_policy()describe_sentiment_detection_job()describe_targeted_sentiment_detection_job()describe_topics_detection_job()detect_dominant_language()detect_entities()detect_key_phrases()detect_pii_entities()detect_sentiment()detect_syntax()detect_targeted_sentiment()get_paginator()get_waiter()import_model()list_document_classification_jobs()list_document_classifier_summaries()list_document_classifiers()list_dominant_language_detection_jobs()list_endpoints()list_entities_detection_jobs()list_entity_recognizer_summaries()list_entity_recognizers()list_events_detection_jobs()list_key_phrases_detection_jobs()list_pii_entities_detection_jobs()list_sentiment_detection_jobs()list_tags_for_resource()list_targeted_sentiment_detection_jobs()list_topics_detection_jobs()put_resource_policy()start_document_classification_job()start_dominant_language_detection_job()start_entities_detection_job()start_events_detection_job()start_key_phrases_detection_job()start_pii_entities_detection_job()start_sentiment_detection_job()start_targeted_sentiment_detection_job()start_topics_detection_job()stop_dominant_language_detection_job()stop_entities_detection_job()stop_events_detection_job()stop_key_phrases_detection_job()stop_pii_entities_detection_job()stop_sentiment_detection_job()stop_targeted_sentiment_detection_job()stop_training_document_classifier()stop_training_entity_recognizer()tag_resource()untag_resource()update_endpoint()batch_detect_dominant_language(**kwargs)¶Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
See also: AWS API Documentation
Request Syntax
response = client.batch_detect_dominant_language(
TextList=[
'string',
]
)
[REQUIRED]
A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.
{
'ResultList': [
{
'Index': 123,
'Languages': [
{
'LanguageCode': 'string',
'Score': ...
},
]
},
],
'ErrorList': [
{
'Index': 123,
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
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.
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
The zero-based index of the document in the input list.
One or more DominantLanguage objects describing the dominant languages in the document.
Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
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.
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
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.
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
The zero-based index of the document in the input list.
The numeric error code of the error.
A text description of the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.BatchSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptionbatch_detect_entities(**kwargs)¶Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.batch_detect_entities(
TextList=[
'string',
],
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{
'ResultList': [
{
'Index': 123,
'Entities': [
{
'Score': ...,
'Type': 'PERSON'|'LOCATION'|'ORGANIZATION'|'COMMERCIAL_ITEM'|'EVENT'|'DATE'|'QUANTITY'|'TITLE'|'OTHER',
'Text': 'string',
'BeginOffset': 123,
'EndOffset': 123,
'BlockReferences': [
{
'BlockId': 'string',
'BeginOffset': 123,
'EndOffset': 123,
'ChildBlocks': [
{
'ChildBlockId': 'string',
'BeginOffset': 123,
'EndOffset': 123
},
]
},
]
},
]
},
],
'ErrorList': [
{
'Index': 123,
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ResultList (list) --
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.
(dict) --
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
Index (integer) --
The zero-based index of the document in the input list.
Entities (list) --
One or more Entity objects, one for each entity detected in the document.
(dict) --
Provides information about an entity.
Score (float) --
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Type (string) --
The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
Text (string) --
The text of the entity.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
BlockReferences (list) --
A reference to each block for this entity. This field is empty for plain-text input.
(dict) --
A reference to a block.
BlockId (string) --
Unique identifier for the block.
BeginOffset (integer) --
Offset of the start of the block within its parent block.
EndOffset (integer) --
Offset of the end of the block within its parent block.
ChildBlocks (list) --
List of child blocks within this block.
(dict) --
Nested block contained within a block.
ChildBlockId (string) --
Unique identifier for the child block.
BeginOffset (integer) --
Offset of the start of the child block within its parent block.
EndOffset (integer) --
Offset of the end of the child block within its parent block.
ErrorList (list) --
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.
(dict) --
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
Index (integer) --
The zero-based index of the document in the input list.
ErrorCode (string) --
The numeric error code of the error.
ErrorMessage (string) --
A text description of the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.BatchSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptionbatch_detect_key_phrases(**kwargs)¶Detects the key noun phrases found in a batch of documents.
See also: AWS API Documentation
Request Syntax
response = client.batch_detect_key_phrases(
TextList=[
'string',
],
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{
'ResultList': [
{
'Index': 123,
'KeyPhrases': [
{
'Score': ...,
'Text': 'string',
'BeginOffset': 123,
'EndOffset': 123
},
]
},
],
'ErrorList': [
{
'Index': 123,
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ResultList (list) --
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.
(dict) --
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
Index (integer) --
The zero-based index of the document in the input list.
KeyPhrases (list) --
One or more KeyPhrase objects, one for each key phrase detected in the document.
(dict) --
Describes a key noun phrase.
Score (float) --
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Text (string) --
The text of a key noun phrase.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the key phrase.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the key phrase.
ErrorList (list) --
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.
(dict) --
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
Index (integer) --
The zero-based index of the document in the input list.
ErrorCode (string) --
The numeric error code of the error.
ErrorMessage (string) --
A text description of the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.BatchSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptionbatch_detect_sentiment(**kwargs)¶Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE , NEUTRAL , MIXED , or NEGATIVE , in each one.
See also: AWS API Documentation
Request Syntax
response = client.batch_detect_sentiment(
TextList=[
'string',
],
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
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.
Note
Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
[REQUIRED]
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.
dict
Response Syntax
{
'ResultList': [
{
'Index': 123,
'Sentiment': 'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
'SentimentScore': {
'Positive': ...,
'Negative': ...,
'Neutral': ...,
'Mixed': ...
}
},
],
'ErrorList': [
{
'Index': 123,
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ResultList (list) --
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.
(dict) --
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
Index (integer) --
The zero-based index of the document in the input list.
Sentiment (string) --
The sentiment detected in the document.
SentimentScore (dict) --
The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
Positive (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
Negative (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
Neutral (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
Mixed (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
ErrorList (list) --
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.
(dict) --
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
Index (integer) --
The zero-based index of the document in the input list.
ErrorCode (string) --
The numeric error code of the error.
ErrorMessage (string) --
A text description of the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.BatchSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptionbatch_detect_syntax(**kwargs)¶Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.batch_detect_syntax(
TextList=[
'string',
],
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'
)
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{
'ResultList': [
{
'Index': 123,
'SyntaxTokens': [
{
'TokenId': 123,
'Text': 'string',
'BeginOffset': 123,
'EndOffset': 123,
'PartOfSpeech': {
'Tag': 'ADJ'|'ADP'|'ADV'|'AUX'|'CONJ'|'CCONJ'|'DET'|'INTJ'|'NOUN'|'NUM'|'O'|'PART'|'PRON'|'PROPN'|'PUNCT'|'SCONJ'|'SYM'|'VERB',
'Score': ...
}
},
]
},
],
'ErrorList': [
{
'Index': 123,
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ResultList (list) --
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.
(dict) --
The result of calling the operation. The operation returns one object that is successfully processed by the operation.
Index (integer) --
The zero-based index of the document in the input list.
SyntaxTokens (list) --
The syntax tokens for the words in the document, one token for each word.
(dict) --
Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
TokenId (integer) --
A unique identifier for a token.
Text (string) --
The word that was recognized in the source text.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the word.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the word.
PartOfSpeech (dict) --
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 Syntax in the Comprehend Developer Guide.
Tag (string) --
Identifies the part of speech that the token represents.
Score (float) --
The confidence that Amazon Comprehend has that the part of speech was correctly identified.
ErrorList (list) --
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.
(dict) --
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
Index (integer) --
The zero-based index of the document in the input list.
ErrorCode (string) --
The numeric error code of the error.
ErrorMessage (string) --
A text description of the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.BatchSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptionbatch_detect_targeted_sentiment(**kwargs)¶Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment.
See also: AWS API Documentation
Request Syntax
response = client.batch_detect_targeted_sentiment(
TextList=[
'string',
],
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
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.
[REQUIRED]
The language of the input documents. Currently, English is the only supported language.
dict
Response Syntax
{
'ResultList': [
{
'Index': 123,
'Entities': [
{
'DescriptiveMentionIndex': [
123,
],
'Mentions': [
{
'Score': ...,
'GroupScore': ...,
'Text': 'string',
'Type': 'PERSON'|'LOCATION'|'ORGANIZATION'|'FACILITY'|'BRAND'|'COMMERCIAL_ITEM'|'MOVIE'|'MUSIC'|'BOOK'|'SOFTWARE'|'GAME'|'PERSONAL_TITLE'|'EVENT'|'DATE'|'QUANTITY'|'ATTRIBUTE'|'OTHER',
'MentionSentiment': {
'Sentiment': 'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
'SentimentScore': {
'Positive': ...,
'Negative': ...,
'Neutral': ...,
'Mixed': ...
}
},
'BeginOffset': 123,
'EndOffset': 123
},
]
},
]
},
],
'ErrorList': [
{
'Index': 123,
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ResultList (list) --
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.
(dict) --
Analysis results for one of the documents in the batch.
Index (integer) --
The zero-based index of this result in the input list.
Entities (list) --
An array of targeted sentiment entities.
(dict) --
Information about one of the entities found by targeted sentiment analysis.
For more information about targeted sentiment, see Targeted sentiment.
DescriptiveMentionIndex (list) --
One or more index into the Mentions array that provides the best name for the entity group.
Mentions (list) --
An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.
(dict) --
Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.
For more information about targeted sentiment, see Targeted sentiment.
Score (float) --
Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
GroupScore (float) --
The confidence that all the entities mentioned in the group relate to the same entity.
Text (string) --
The text in the document that identifies the entity.
Type (string) --
The type of the entity. Amazon Comprehend supports a variety of entity types.
MentionSentiment (dict) --
Contains the sentiment and sentiment score for the mention.
Sentiment (string) --
The sentiment of the mention.
SentimentScore (dict) --
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
Positive (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
Negative (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
Neutral (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
Mixed (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
BeginOffset (integer) --
The offset into the document text where the mention begins.
EndOffset (integer) --
The offset into the document text where the mention ends.
ErrorList (list) --
List of errors that the operation can return.
(dict) --
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
Index (integer) --
The zero-based index of the document in the input list.
ErrorCode (string) --
The numeric error code of the error.
ErrorMessage (string) --
A text description of the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.BatchSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.classify_document(**kwargs)¶Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
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 that describes the errors.
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.
See also: AWS API Documentation
Request Syntax
response = client.classify_document(
Text='string',
EndpointArn='string',
Bytes=b'bytes',
DocumentReaderConfig={
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
)
Bytes parameter.[REQUIRED]
The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.
Use the Bytes parameter to input a text, PDF, Word or image file. 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 classify documents, 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.
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.dict
Response Syntax
{
'Classes': [
{
'Name': 'string',
'Score': ...,
'Page': 123
},
],
'Labels': [
{
'Name': 'string',
'Score': ...,
'Page': 123
},
],
'DocumentMetadata': {
'Pages': 123,
'ExtractedCharacters': [
{
'Page': 123,
'Count': 123
},
]
},
'DocumentType': [
{
'Page': 123,
'Type': 'NATIVE_PDF'|'SCANNED_PDF'|'MS_WORD'|'IMAGE'|'PLAIN_TEXT'|'TEXTRACT_DETECT_DOCUMENT_TEXT_JSON'|'TEXTRACT_ANALYZE_DOCUMENT_JSON'
},
],
'Errors': [
{
'Page': 123,
'ErrorCode': 'TEXTRACT_BAD_PAGE'|'TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED'|'PAGE_CHARACTERS_EXCEEDED'|'PAGE_SIZE_EXCEEDED'|'INTERNAL_SERVER_ERROR',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Classes (list) --
The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
(dict) --
Specifies the class that categorizes the document being analyzed
Name (string) --
The name of the class.
Score (float) --
The confidence score that Amazon Comprehend has this class correctly attributed.
Page (integer) --
Page number in the input document. This field is present in the response only if your request includes the Byte parameter.
Labels (list) --
The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.
(dict) --
Specifies one of the label or labels that categorize the document being analyzed.
Name (string) --
The name of the label.
Score (float) --
The confidence score that Amazon Comprehend has this label correctly attributed.
Page (integer) --
Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.
DocumentMetadata (dict) --
Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.
Pages (integer) --
Number of pages in the document.
ExtractedCharacters (list) --
List of pages in the document, with the number of characters extracted from each page.
(dict) --
Array of the number of characters extracted from each page.
Page (integer) --
Page number.
Count (integer) --
Number of characters extracted from each page.
DocumentType (list) --
The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.
(dict) --
Document type for each page in the document.
Page (integer) --
Page number.
Type (string) --
Document type.
Errors (list) --
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
(dict) --
Text extraction encountered one or more page-level errors in the input document.
The ErrorCode contains one of the following values:
Page (integer) --
Page number where the error occurred.
ErrorCode (string) --
Error code for the cause of the error.
ErrorMessage (string) --
Text message explaining the reason for the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptionclose()¶Closes underlying endpoint connections.
contains_pii_entities(**kwargs)¶Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
See also: AWS API Documentation
Request Syntax
response = client.contains_pii_entities(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
A UTF-8 text string. The maximum string size is 100 KB.
[REQUIRED]
The language of the input documents. Currently, English is the only valid language.
dict
Response Syntax
{
'Labels': [
{
'Name': 'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'DATE_TIME'|'PASSPORT_NUMBER'|'DRIVER_ID'|'URL'|'AGE'|'USERNAME'|'PASSWORD'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'IP_ADDRESS'|'MAC_ADDRESS'|'ALL'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'IN_PERMANENT_ACCOUNT_NUMBER'|'IN_NREGA'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'CA_HEALTH_NUMBER'|'IN_AADHAAR'|'IN_VOTER_NUMBER',
'Score': ...
},
]
}
Response Structure
(dict) --
Labels (list) --
The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.
(dict) --
Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.
Name (string) --
The name of the label.
Score (float) --
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptioncreate_document_classifier(**kwargs)¶Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.create_document_classifier(
DocumentClassifierName='string',
VersionName='string',
DataAccessRoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
InputDataConfig={
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'S3Uri': 'string',
'TestS3Uri': 'string',
'LabelDelimiter': 'string',
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
ClientRequestToken='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Mode='MULTI_CLASS'|'MULTI_LABEL',
ModelKmsKeyId='string',
ModelPolicy='string'
)
[REQUIRED]
The name of the document classifier.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
[REQUIRED]
Specifies the format and location of the input data for the job.
The format of your training data:
COMPREHEND_CSV : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
The Amazon S3 location of the augmented manifest file.
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
The S3 prefix to the annotation files that are referred in the augmented manifest file.
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.Enables the addition of output results configuration parameters for custom classifier jobs.
When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.
When the custom classifier job is finished, the service creates the 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 confusion matrix.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
[REQUIRED]
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.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
dict
Response Syntax
{
'DocumentClassifierArn': 'string'
}
Response Structure
(dict) --
DocumentClassifierArn (string) --
The Amazon Resource Name (ARN) that identifies the document classifier.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.InternalServerExceptioncreate_endpoint(**kwargs)¶Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.
See also: AWS API Documentation
Request Syntax
response = client.create_endpoint(
EndpointName='string',
ModelArn='string',
DesiredInferenceUnits=123,
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataAccessRoleArn='string'
)
[REQUIRED]
This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.
[REQUIRED]
The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
[REQUIRED]
The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException .
This field is autopopulated if not provided.
Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'EndpointArn': 'string'
}
Response Structure
(dict) --
EndpointArn (string) --
The Amazon Resource Number (ARN) of the endpoint being created.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.ResourceLimitExceededExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptioncreate_entity_recognizer(**kwargs)¶Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
See also: AWS API Documentation
Request Syntax
response = client.create_entity_recognizer(
RecognizerName='string',
VersionName='string',
DataAccessRoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
InputDataConfig={
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'EntityTypes': [
{
'Type': 'string'
},
],
'Documents': {
'S3Uri': 'string',
'TestS3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
},
'Annotations': {
'S3Uri': 'string',
'TestS3Uri': 'string'
},
'EntityList': {
'S3Uri': 'string'
},
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
ClientRequestToken='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
ModelKmsKeyId='string',
ModelPolicy='string'
)
[REQUIRED]
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
[REQUIRED]
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
The format of your training data:
COMPREHEND_CSV : A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list. If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: n (line break), \n (escaped line break), r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: n (line break), \n (escaped line break, r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
The S3 location of the folder that contains the training documents for your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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.
The S3 location of the CSV file that annotates your training documents.
Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
The S3 location of the CSV file that has the entity list for your custom entity recognizer.
Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
The Amazon S3 location of the augmented manifest file.
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
The S3 prefix to the annotation files that are referred in the augmented manifest file.
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
[REQUIRED]
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
dict
Response Syntax
{
'EntityRecognizerArn': 'string'
}
Response Structure
(dict) --
EntityRecognizerArn (string) --
The Amazon Resource Name (ARN) that identifies the entity recognizer.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.InternalServerExceptiondelete_document_classifier(**kwargs)¶Deletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
See also: AWS API Documentation
Request Syntax
response = client.delete_document_classifier(
DocumentClassifierArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the document classifier.
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.InternalServerExceptiondelete_endpoint(**kwargs)¶Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
EndpointArn='string'
)
[REQUIRED]
The Amazon Resource Number (ARN) of the endpoint being deleted.
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondelete_entity_recognizer(**kwargs)¶Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
See also: AWS API Documentation
Request Syntax
response = client.delete_entity_recognizer(
EntityRecognizerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the entity recognizer.
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.InternalServerExceptiondelete_resource_policy(**kwargs)¶Deletes a resource-based policy that is attached to a custom model.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
ResourceArn='string',
PolicyRevisionId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
dict
Response Syntax
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_document_classification_job(**kwargs)¶Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
See also: AWS API Documentation
Request Syntax
response = client.describe_document_classification_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'DocumentClassificationJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DocumentClassifierArn': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
An object that describes the properties associated with the document classification job.
The identifier assigned to the document classification job.
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned to the document classification job.
The current status of the document classification job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of the job.
The time that the document classification job was submitted for processing.
The time that the document classification job completed.
The Amazon Resource Name (ARN) that identifies the document classifier.
The input data configuration that you supplied when you created the document classification job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the document classification job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_document_classifier(**kwargs)¶Gets the properties associated with a document classifier.
See also: AWS API Documentation
Request Syntax
response = client.describe_document_classifier(
DocumentClassifierArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
{
'DocumentClassifierProperties': {
'DocumentClassifierArn': 'string',
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TrainingStartTime': datetime(2015, 1, 1),
'TrainingEndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'S3Uri': 'string',
'TestS3Uri': 'string',
'LabelDelimiter': 'string',
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'ClassifierMetadata': {
'NumberOfLabels': 123,
'NumberOfTrainedDocuments': 123,
'NumberOfTestDocuments': 123,
'EvaluationMetrics': {
'Accuracy': 123.0,
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0,
'MicroPrecision': 123.0,
'MicroRecall': 123.0,
'MicroF1Score': 123.0,
'HammingLoss': 123.0
}
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'Mode': 'MULTI_CLASS'|'MULTI_LABEL',
'ModelKmsKeyId': 'string',
'VersionName': 'string',
'SourceModelArn': 'string'
}
}
Response Structure
An object that contains the properties associated with a document classifier.
The Amazon Resource Name (ARN) that identifies the document classifier.
The language code for the language of the documents that the classifier was trained on.
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
Additional information about the status of the classifier.
The time that the document classifier was submitted for training.
The time that training the document classifier completed.
Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
The input data configuration that you supplied when you created the document classifier for training.
The format of your training data:
COMPREHEND_CSV : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
The Amazon S3 location of the augmented manifest file.
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
The S3 prefix to the annotation files that are referred in the augmented manifest file.
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.Provides output results configuration parameters for custom classifier jobs.
When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.
When the custom classifier job is finished, the service creates the 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 confusion matrix.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
The number of labels in the input data.
The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.
The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.
Describes the result metrics for the test data associated with an documentation classifier.
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"The version name that you assigned to the document classifier.
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_dominant_language_detection_job(**kwargs)¶Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_dominant_language_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'DominantLanguageDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
An object that contains the properties associated with a dominant language detection job.
The identifier assigned to the dominant language detection job.
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned to the dominant language detection job.
The current status of the dominant language detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description for the status of a job.
The time that the dominant language detection job was submitted for processing.
The time that the dominant language detection job completed.
The input data configuration that you supplied when you created the dominant language detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the dominant language detection job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_endpoint(**kwargs)¶Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.
See also: AWS API Documentation
Request Syntax
response = client.describe_endpoint(
EndpointArn='string'
)
[REQUIRED]
The Amazon Resource Number (ARN) of the endpoint being described.
{
'EndpointProperties': {
'EndpointArn': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
'Message': 'string',
'ModelArn': 'string',
'DesiredModelArn': 'string',
'DesiredInferenceUnits': 123,
'CurrentInferenceUnits': 123,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DesiredDataAccessRoleArn': 'string'
}
}
Response Structure
Describes information associated with the specific endpoint.
The Amazon Resource Number (ARN) of the endpoint.
Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.
Specifies a reason for failure in cases of Failed status.
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
The number of inference units currently used by the model using this endpoint.
The creation date and time of the endpoint.
The date and time that the endpoint was last modified.
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
Data access role ARN to use in case the new model is encrypted with a customer KMS key.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_entities_detection_job(**kwargs)¶Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_entities_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'EntitiesDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'EntityRecognizerArn': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
An object that contains the properties associated with an entities detection job.
The identifier assigned to the entities detection job.
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned the entities detection job.
The current status of the entities detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the entities detection job was submitted for processing.
The time that the entities detection job completed
The Amazon Resource Name (ARN) that identifies the entity recognizer.
The input data configuration that you supplied when you created the entities detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the entities detection job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The language code of the input documents.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_entity_recognizer(**kwargs)¶Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
See also: AWS API Documentation
Request Syntax
response = client.describe_entity_recognizer(
EntityRecognizerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the entity recognizer.
{
'EntityRecognizerProperties': {
'EntityRecognizerArn': 'string',
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TrainingStartTime': datetime(2015, 1, 1),
'TrainingEndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'EntityTypes': [
{
'Type': 'string'
},
],
'Documents': {
'S3Uri': 'string',
'TestS3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
},
'Annotations': {
'S3Uri': 'string',
'TestS3Uri': 'string'
},
'EntityList': {
'S3Uri': 'string'
},
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
'RecognizerMetadata': {
'NumberOfTrainedDocuments': 123,
'NumberOfTestDocuments': 123,
'EvaluationMetrics': {
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0
},
'EntityTypes': [
{
'Type': 'string',
'EvaluationMetrics': {
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0
},
'NumberOfTrainMentions': 123
},
]
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ModelKmsKeyId': 'string',
'VersionName': 'string',
'SourceModelArn': 'string'
}
}
Response Structure
Describes information associated with an entity recognizer.
The Amazon Resource Name (ARN) that identifies the entity recognizer.
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
Provides the status of the entity recognizer.
A description of the status of the recognizer.
The time that the recognizer was submitted for processing.
The time that the recognizer creation completed.
The time that training of the entity recognizer started.
The time that training of the entity recognizer was completed.
The input data properties of an entity recognizer.
The format of your training data:
COMPREHEND_CSV : A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list. If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: n (line break), \n (escaped line break), r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: n (line break), \n (escaped line break, r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
The S3 location of the folder that contains the training documents for your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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.
The S3 location of the CSV file that annotates your training documents.
Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
The S3 location of the CSV file that has the entity list for your custom entity recognizer.
Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
The Amazon S3 location of the augmented manifest file.
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
The S3 prefix to the annotation files that are referred in the augmented manifest file.
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.Provides information about an entity recognizer.
The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
Detailed information about the accuracy of an entity recognizer.
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.
Entity types from the metadata of an entity recognizer.
Individual item from the list of entity types in the metadata of an entity recognizer.
Type of entity from the list of entity types in the metadata of an entity recognizer.
Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.
A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.
A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
Indicates the number of times the given entity type was seen in the training data.
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"The version name you assigned to the entity recognizer.
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_events_detection_job(**kwargs)¶Gets the status and details of an events detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_events_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the events detection job.
{
'EventsDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'TargetEventTypes': [
'string',
]
}
}
Response Structure
An object that contains the properties associated with an event detection job.
The identifier assigned to the events detection job.
The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
The name you assigned the events detection job.
The current status of the events detection job.
A description of the status of the events detection job.
The time that the events detection job was submitted for processing.
The time that the events detection job completed.
The input data configuration that you supplied when you created the events detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the events detection job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The language code of the input documents.
The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
The types of events that are detected by the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_key_phrases_detection_job(**kwargs)¶Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_key_phrases_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'KeyPhrasesDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
An object that contains the properties associated with a key phrases detection job.
The identifier assigned to the key phrases detection job.
The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned the key phrases detection job.
The current status of the key phrases detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the key phrases detection job was submitted for processing.
The time that the key phrases detection job completed.
The input data configuration that you supplied when you created the key phrases detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the key phrases detection job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The language code of the input documents.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_pii_entities_detection_job(**kwargs)¶Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
See also: AWS API Documentation
Request Syntax
response = client.describe_pii_entities_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'PiiEntitiesDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'RedactionConfig': {
'PiiEntityTypes': [
'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'DATE_TIME'|'PASSPORT_NUMBER'|'DRIVER_ID'|'URL'|'AGE'|'USERNAME'|'PASSWORD'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'IP_ADDRESS'|'MAC_ADDRESS'|'ALL'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'IN_PERMANENT_ACCOUNT_NUMBER'|'IN_NREGA'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'CA_HEALTH_NUMBER'|'IN_AADHAAR'|'IN_VOTER_NUMBER',
],
'MaskMode': 'MASK'|'REPLACE_WITH_PII_ENTITY_TYPE',
'MaskCharacter': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'Mode': 'ONLY_REDACTION'|'ONLY_OFFSETS'
}
}
Response Structure
Provides information about a PII entities detection job.
The identifier assigned to the PII entities detection job.
The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned the PII entities detection job.
The current status of the PII entities detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the PII entities detection job was submitted for processing.
The time that the PII entities detection job completed.
The input properties for a PII entities detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the PII entities detection job.
When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION . In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
Specifies whether the PII entity is redacted with the mask character or the entity type.
A character that replaces each character in the redacted PII entity.
The language code of the input documents
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_resource_policy(**kwargs)¶Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
See also: AWS API Documentation
Request Syntax
response = client.describe_resource_policy(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the custom model version that has the resource policy.
{
'ResourcePolicy': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'PolicyRevisionId': 'string'
}
Response Structure
The JSON body of the resource-based policy.
The time at which the policy was created.
The time at which the policy was last modified.
The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_sentiment_detection_job(**kwargs)¶Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_sentiment_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'SentimentDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
An object that contains the properties associated with a sentiment detection job.
The identifier assigned to the sentiment detection job.
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned to the sentiment detection job
The current status of the sentiment detection job. If the status is FAILED , the Messages field shows the reason for the failure.
A description of the status of a job.
The time that the sentiment detection job was submitted for processing.
The time that the sentiment detection job ended.
The input data configuration that you supplied when you created the sentiment detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration that you supplied when you created the sentiment detection job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The language code of the input documents.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_targeted_sentiment_detection_job(**kwargs)¶Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
See also: AWS API Documentation
Request Syntax
response = client.describe_targeted_sentiment_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
{
'TargetedSentimentDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
An object that contains the properties associated with a targeted sentiment detection job.
The identifier assigned to the targeted sentiment detection job.
The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The name that you assigned to the targeted sentiment detection job.
The current status of the targeted sentiment detection job. If the status is FAILED , the Messages field shows the reason for the failure.
A description of the status of a job.
The time that the targeted sentiment detection job was submitted for processing.
The time that the targeted sentiment detection job ended.
The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.Provides configuration parameters for the output of inference jobs.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The language code of the input documents.
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondescribe_topics_detection_job(**kwargs)¶Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_topics_detection_job(
JobId='string'
)
[REQUIRED]
The identifier assigned by the user to the detection job.
{
'TopicsDetectionJobProperties': {
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'NumberOfTopics': 123,
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
}
}
Response Structure
The list of properties for the requested job.
The identifier assigned to the topic detection job.
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
The name of the topic detection job.
The current status of the topic detection job. If the status is Failed , the reason for the failure is shown in the Message field.
A description for the status of a job.
The time that the topic detection job was submitted for processing.
The time that the topic detection job was completed.
The input data configuration supplied when you created the topic detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.The output data configuration supplied when you created the topic detection job.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"The number of topics to detect supplied when you created the topic detection job. The default is 10.
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_dominant_language(**kwargs)¶Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
See also: AWS API Documentation
Request Syntax
response = client.detect_dominant_language(
Text='string'
)
[REQUIRED]
A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
{
'Languages': [
{
'LanguageCode': 'string',
'Score': ...
},
]
}
Response Structure
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.
Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
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.
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_entities(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.detect_entities(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
EndpointArn='string',
Bytes=b'bytes',
DocumentReaderConfig={
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
)
Bytes parameter.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.
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.
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.
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.dict
Response Syntax
{
'Entities': [
{
'Score': ...,
'Type': 'PERSON'|'LOCATION'|'ORGANIZATION'|'COMMERCIAL_ITEM'|'EVENT'|'DATE'|'QUANTITY'|'TITLE'|'OTHER',
'Text': 'string',
'BeginOffset': 123,
'EndOffset': 123,
'BlockReferences': [
{
'BlockId': 'string',
'BeginOffset': 123,
'EndOffset': 123,
'ChildBlocks': [
{
'ChildBlockId': 'string',
'BeginOffset': 123,
'EndOffset': 123
},
]
},
]
},
],
'DocumentMetadata': {
'Pages': 123,
'ExtractedCharacters': [
{
'Page': 123,
'Count': 123
},
]
},
'DocumentType': [
{
'Page': 123,
'Type': 'NATIVE_PDF'|'SCANNED_PDF'|'MS_WORD'|'IMAGE'|'PLAIN_TEXT'|'TEXTRACT_DETECT_DOCUMENT_TEXT_JSON'|'TEXTRACT_ANALYZE_DOCUMENT_JSON'
},
],
'Blocks': [
{
'Id': 'string',
'BlockType': 'LINE'|'WORD',
'Text': 'string',
'Page': 123,
'Geometry': {
'BoundingBox': {
'Height': ...,
'Left': ...,
'Top': ...,
'Width': ...
},
'Polygon': [
{
'X': ...,
'Y': ...
},
]
},
'Relationships': [
{
'Ids': [
'string',
],
'Type': 'CHILD'
},
]
},
],
'Errors': [
{
'Page': 123,
'ErrorCode': 'TEXTRACT_BAD_PAGE'|'TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED'|'PAGE_CHARACTERS_EXCEEDED'|'PAGE_SIZE_EXCEEDED'|'INTERNAL_SERVER_ERROR',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Entities (list) --
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.
If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.
(dict) --
Provides information about an entity.
Score (float) --
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Type (string) --
The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
Text (string) --
The text of the entity.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
BlockReferences (list) --
A reference to each block for this entity. This field is empty for plain-text input.
(dict) --
A reference to a block.
BlockId (string) --
Unique identifier for the block.
BeginOffset (integer) --
Offset of the start of the block within its parent block.
EndOffset (integer) --
Offset of the end of the block within its parent block.
ChildBlocks (list) --
List of child blocks within this block.
(dict) --
Nested block contained within a block.
ChildBlockId (string) --
Unique identifier for the child block.
BeginOffset (integer) --
Offset of the start of the child block within its parent block.
EndOffset (integer) --
Offset of the end of the child block within its parent block.
DocumentMetadata (dict) --
Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.
Pages (integer) --
Number of pages in the document.
ExtractedCharacters (list) --
List of pages in the document, with the number of characters extracted from each page.
(dict) --
Array of the number of characters extracted from each page.
Page (integer) --
Page number.
Count (integer) --
Number of characters extracted from each page.
DocumentType (list) --
The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.
(dict) --
Document type for each page in the document.
Page (integer) --
Page number.
Type (string) --
Document type.
Blocks (list) --
Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.
The Block content for a Word input document does not include a Geometry field.
The Block field is not present in the response for plain-text inputs.
(dict) --
Information about each word or line of text in the input document.
For additional information, see Block in the Amazon Textract API reference.
Id (string) --
Unique identifier for the block.
BlockType (string) --
The block represents a line of text or one word of text.
Text (string) --
The word or line of text extracted from the block.
Page (integer) --
Page number where the block appears.
Geometry (dict) --
Co-ordinates of the rectangle or polygon that contains the text.
BoundingBox (dict) --
An axis-aligned coarse representation of the location of the recognized item on the document page.
Height (float) --
The height of the bounding box as a ratio of the overall document page height.
Left (float) --
The left coordinate of the bounding box as a ratio of overall document page width.
Top (float) --
The top coordinate of the bounding box as a ratio of overall document page height.
Width (float) --
The width of the bounding box as a ratio of the overall document page width.
Polygon (list) --
Within the bounding box, a fine-grained polygon around the recognized item.
(dict) --
The X and Y coordinates of a point on a document page.
For additional information, see Point in the Amazon Textract API reference.
X (float) --
The value of the X coordinate for a point on a polygon
Y (float) --
The value of the Y coordinate for a point on a polygon
Relationships (list) --
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.
(dict) --
List of child blocks for the current block.
Ids (list) --
Identifers of the child blocks.
Type (string) --
Only supported relationship is a child relationship.
Errors (list) --
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
(dict) --
Text extraction encountered one or more page-level errors in the input document.
The ErrorCode contains one of the following values:
Page (integer) --
Page number where the error occurred.
ErrorCode (string) --
Error code for the cause of the error.
ErrorMessage (string) --
Text message explaining the reason for the error.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_key_phrases(**kwargs)¶Detects the key noun phrases found in the text.
See also: AWS API Documentation
Request Syntax
response = client.detect_key_phrases(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
[REQUIRED]
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.
dict
Response Syntax
{
'KeyPhrases': [
{
'Score': ...,
'Text': 'string',
'BeginOffset': 123,
'EndOffset': 123
},
]
}
Response Structure
(dict) --
KeyPhrases (list) --
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.
(dict) --
Describes a key noun phrase.
Score (float) --
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Text (string) --
The text of a key noun phrase.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the key phrase.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the key phrase.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_pii_entities(**kwargs)¶Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
See also: AWS API Documentation
Request Syntax
response = client.detect_pii_entities(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
A UTF-8 text string. The maximum string size is 100 KB.
[REQUIRED]
The language of the input documents. Currently, English is the only valid language.
dict
Response Syntax
{
'Entities': [
{
'Score': ...,
'Type': 'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'DATE_TIME'|'PASSPORT_NUMBER'|'DRIVER_ID'|'URL'|'AGE'|'USERNAME'|'PASSWORD'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'IP_ADDRESS'|'MAC_ADDRESS'|'ALL'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'IN_PERMANENT_ACCOUNT_NUMBER'|'IN_NREGA'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'CA_HEALTH_NUMBER'|'IN_AADHAAR'|'IN_VOTER_NUMBER',
'BeginOffset': 123,
'EndOffset': 123
},
]
}
Response Structure
(dict) --
Entities (list) --
A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.
(dict) --
Provides information about a PII entity.
Score (float) --
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Type (string) --
The entity's type.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the entity.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the entity.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_sentiment(**kwargs)¶Inspects text and returns an inference of the prevailing sentiment ( POSITIVE , NEUTRAL , MIXED , or NEGATIVE ).
See also: AWS API Documentation
Request Syntax
response = client.detect_sentiment(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
A UTF-8 text string. The maximum string size is 5 KB.
Note
Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
[REQUIRED]
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.
dict
Response Syntax
{
'Sentiment': 'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
'SentimentScore': {
'Positive': ...,
'Negative': ...,
'Neutral': ...,
'Mixed': ...
}
}
Response Structure
(dict) --
Sentiment (string) --
The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
SentimentScore (dict) --
An object that lists the sentiments, and their corresponding confidence levels.
Positive (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
Negative (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
Neutral (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
Mixed (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_syntax(**kwargs)¶Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.detect_syntax(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'
)
[REQUIRED]
A UTF-8 string. The maximum string size is 5 KB.
[REQUIRED]
The language code 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").
dict
Response Syntax
{
'SyntaxTokens': [
{
'TokenId': 123,
'Text': 'string',
'BeginOffset': 123,
'EndOffset': 123,
'PartOfSpeech': {
'Tag': 'ADJ'|'ADP'|'ADV'|'AUX'|'CONJ'|'CCONJ'|'DET'|'INTJ'|'NOUN'|'NUM'|'O'|'PART'|'PRON'|'PROPN'|'PUNCT'|'SCONJ'|'SYM'|'VERB',
'Score': ...
}
},
]
}
Response Structure
(dict) --
SyntaxTokens (list) --
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 Syntax in the Comprehend Developer Guide.
(dict) --
Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
TokenId (integer) --
A unique identifier for a token.
Text (string) --
The word that was recognized in the source text.
BeginOffset (integer) --
The zero-based offset from the beginning of the source text to the first character in the word.
EndOffset (integer) --
The zero-based offset from the beginning of the source text to the last character in the word.
PartOfSpeech (dict) --
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 Syntax in the Comprehend Developer Guide.
Tag (string) --
Identifies the part of speech that the token represents.
Score (float) --
The confidence that Amazon Comprehend has that the part of speech was correctly identified.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptiondetect_targeted_sentiment(**kwargs)¶Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment.
See also: AWS API Documentation
Request Syntax
response = client.detect_targeted_sentiment(
Text='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
[REQUIRED]
A UTF-8 text string. The maximum string length is 5 KB.
[REQUIRED]
The language of the input documents. Currently, English is the only supported language.
dict
Response Syntax
{
'Entities': [
{
'DescriptiveMentionIndex': [
123,
],
'Mentions': [
{
'Score': ...,
'GroupScore': ...,
'Text': 'string',
'Type': 'PERSON'|'LOCATION'|'ORGANIZATION'|'FACILITY'|'BRAND'|'COMMERCIAL_ITEM'|'MOVIE'|'MUSIC'|'BOOK'|'SOFTWARE'|'GAME'|'PERSONAL_TITLE'|'EVENT'|'DATE'|'QUANTITY'|'ATTRIBUTE'|'OTHER',
'MentionSentiment': {
'Sentiment': 'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
'SentimentScore': {
'Positive': ...,
'Negative': ...,
'Neutral': ...,
'Mixed': ...
}
},
'BeginOffset': 123,
'EndOffset': 123
},
]
},
]
}
Response Structure
(dict) --
Entities (list) --
Targeted sentiment analysis for each of the entities identified in the input text.
(dict) --
Information about one of the entities found by targeted sentiment analysis.
For more information about targeted sentiment, see Targeted sentiment.
DescriptiveMentionIndex (list) --
One or more index into the Mentions array that provides the best name for the entity group.
Mentions (list) --
An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.
(dict) --
Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.
For more information about targeted sentiment, see Targeted sentiment.
Score (float) --
Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
GroupScore (float) --
The confidence that all the entities mentioned in the group relate to the same entity.
Text (string) --
The text in the document that identifies the entity.
Type (string) --
The type of the entity. Amazon Comprehend supports a variety of entity types.
MentionSentiment (dict) --
Contains the sentiment and sentiment score for the mention.
Sentiment (string) --
The sentiment of the mention.
SentimentScore (dict) --
Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
Positive (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
Negative (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
Neutral (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
Mixed (float) --
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
BeginOffset (integer) --
The offset into the document text where the mention begins.
EndOffset (integer) --
The offset into the document text where the mention ends.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TextSizeLimitExceededExceptionComprehend.Client.exceptions.UnsupportedLanguageExceptionComprehend.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
import_model(**kwargs)¶Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
See also: AWS API Documentation
Request Syntax
response = client.import_model(
SourceModelArn='string',
ModelName='string',
VersionName='string',
ModelKmsKeyId='string',
DataAccessRoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the custom model to import.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'ModelArn': 'string'
}
Response Structure
(dict) --
ModelArn (string) --
The Amazon Resource Name (ARN) of the custom model being imported.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceLimitExceededExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.InternalServerExceptionlist_document_classification_jobs(**kwargs)¶Gets a list of the documentation classification jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_document_classification_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
Filters on the name of the job.
Filters the list based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'DocumentClassificationJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DocumentClassifierArn': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DocumentClassificationJobPropertiesList (list) --
A list containing the properties of each job returned.
(dict) --
Provides information about a document classification job.
JobId (string) --
The identifier assigned to the document classification job.
JobArn (string) --
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the document classification job.
JobStatus (string) --
The current status of the document classification job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of the job.
SubmitTime (datetime) --
The time that the document classification job was submitted for processing.
EndTime (datetime) --
The time that the document classification job completed.
DocumentClassifierArn (string) --
The Amazon Resource Name (ARN) that identifies the document classifier.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the document classification job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the document classification job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_document_classifier_summaries(**kwargs)¶Gets a list of summaries of the document classifiers that you have created
See also: AWS API Documentation
Request Syntax
response = client.list_document_classifier_summaries(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'DocumentClassifierSummariesList': [
{
'DocumentClassifierName': 'string',
'NumberOfVersions': 123,
'LatestVersionCreatedAt': datetime(2015, 1, 1),
'LatestVersionName': 'string',
'LatestVersionStatus': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DocumentClassifierSummariesList (list) --
The list of summaries of document classifiers.
(dict) --
Describes information about a document classifier and its versions.
DocumentClassifierName (string) --
The name that you assigned the document classifier.
NumberOfVersions (integer) --
The number of versions you created.
LatestVersionCreatedAt (datetime) --
The time that the latest document classifier version was submitted for processing.
LatestVersionName (string) --
The version name you assigned to the latest document classifier version.
LatestVersionStatus (string) --
Provides the status of the latest document classifier version.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptionlist_document_classifiers(**kwargs)¶Gets a list of the document classifiers that you have created.
See also: AWS API Documentation
Request Syntax
response = client.list_document_classifiers(
Filter={
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'DocumentClassifierName': 'string',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters the list of classifiers based on status.
The name that you assigned to the document classifier
Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.
Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.
dict
Response Syntax
{
'DocumentClassifierPropertiesList': [
{
'DocumentClassifierArn': 'string',
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TrainingStartTime': datetime(2015, 1, 1),
'TrainingEndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'S3Uri': 'string',
'TestS3Uri': 'string',
'LabelDelimiter': 'string',
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'ClassifierMetadata': {
'NumberOfLabels': 123,
'NumberOfTrainedDocuments': 123,
'NumberOfTestDocuments': 123,
'EvaluationMetrics': {
'Accuracy': 123.0,
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0,
'MicroPrecision': 123.0,
'MicroRecall': 123.0,
'MicroF1Score': 123.0,
'HammingLoss': 123.0
}
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'Mode': 'MULTI_CLASS'|'MULTI_LABEL',
'ModelKmsKeyId': 'string',
'VersionName': 'string',
'SourceModelArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DocumentClassifierPropertiesList (list) --
A list containing the properties of each job returned.
(dict) --
Provides information about a document classifier.
DocumentClassifierArn (string) --
The Amazon Resource Name (ARN) that identifies the document classifier.
LanguageCode (string) --
The language code for the language of the documents that the classifier was trained on.
Status (string) --
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
Message (string) --
Additional information about the status of the classifier.
SubmitTime (datetime) --
The time that the document classifier was submitted for training.
EndTime (datetime) --
The time that training the document classifier completed.
TrainingStartTime (datetime) --
Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
TrainingEndTime (datetime) --
The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the document classifier for training.
DataFormat (string) --
The format of your training data:
COMPREHEND_CSV : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
S3Uri (string) --
The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
TestS3Uri (string) --
This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
LabelDelimiter (string) --
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
AugmentedManifests (list) --
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
(dict) --
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
S3Uri (string) --
The Amazon S3 location of the augmented manifest file.
Split (string) --
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
AttributeNames (list) --
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
AnnotationDataS3Uri (string) --
The S3 prefix to the annotation files that are referred in the augmented manifest file.
SourceDocumentsS3Uri (string) --
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
DocumentType (string) --
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.OutputDataConfig (dict) --
Provides output results configuration parameters for custom classifier jobs.
S3Uri (string) --
When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.
When the custom classifier job is finished, the service creates the 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 confusion matrix.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"ClassifierMetadata (dict) --
Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
NumberOfLabels (integer) --
The number of labels in the input data.
NumberOfTrainedDocuments (integer) --
The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.
NumberOfTestDocuments (integer) --
The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.
EvaluationMetrics (dict) --
Describes the result metrics for the test data associated with an documentation classifier.
Accuracy (float) --
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
Precision (float) --
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
Recall (float) --
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
F1Score (float) --
A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
MicroPrecision (float) --
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
MicroRecall (float) --
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
MicroF1Score (float) --
A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
HammingLoss (float) --
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Mode (string) --
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
ModelKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VersionName (string) --
The version name that you assigned to the document classifier.
SourceModelArn (string) --
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_dominant_language_detection_jobs(**kwargs)¶Gets a list of the dominant language detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_dominant_language_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'DominantLanguageDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DominantLanguageDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a dominant language detection job.
JobId (string) --
The identifier assigned to the dominant language detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the dominant language detection job.
JobStatus (string) --
The current status of the dominant language detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description for the status of a job.
SubmitTime (datetime) --
The time that the dominant language detection job was submitted for processing.
EndTime (datetime) --
The time that the dominant language detection job completed.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the dominant language detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the dominant language detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_endpoints(**kwargs)¶Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
See also: AWS API Documentation
Request Syntax
response = client.list_endpoints(
Filter={
'ModelArn': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
'CreationTimeBefore': datetime(2015, 1, 1),
'CreationTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.
Specifies a date before which the returned endpoint or endpoints were created.
Specifies a date after which the returned endpoint or endpoints were created.
dict
Response Syntax
{
'EndpointPropertiesList': [
{
'EndpointArn': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
'Message': 'string',
'ModelArn': 'string',
'DesiredModelArn': 'string',
'DesiredInferenceUnits': 123,
'CurrentInferenceUnits': 123,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DesiredDataAccessRoleArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EndpointPropertiesList (list) --
Displays a list of endpoint properties being retrieved by the service in response to the request.
(dict) --
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
EndpointArn (string) --
The Amazon Resource Number (ARN) of the endpoint.
Status (string) --
Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.
Message (string) --
Specifies a reason for failure in cases of Failed status.
ModelArn (string) --
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
DesiredModelArn (string) --
ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
DesiredInferenceUnits (integer) --
The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
CurrentInferenceUnits (integer) --
The number of inference units currently used by the model using this endpoint.
CreationTime (datetime) --
The creation date and time of the endpoint.
LastModifiedTime (datetime) --
The date and time that the endpoint was last modified.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
DesiredDataAccessRoleArn (string) --
Data access role ARN to use in case the new model is encrypted with a customer KMS key.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptionlist_entities_detection_jobs(**kwargs)¶Gets a list of the entity detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_entities_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'EntitiesDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'EntityRecognizerArn': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EntitiesDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about an entities detection job.
JobId (string) --
The identifier assigned to the entities detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned the entities detection job.
JobStatus (string) --
The current status of the entities detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the entities detection job was submitted for processing.
EndTime (datetime) --
The time that the entities detection job completed
EntityRecognizerArn (string) --
The Amazon Resource Name (ARN) that identifies the entity recognizer.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the entities detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the entities detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_entity_recognizer_summaries(**kwargs)¶Gets a list of summaries for the entity recognizers that you have created.
See also: AWS API Documentation
Request Syntax
response = client.list_entity_recognizer_summaries(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'EntityRecognizerSummariesList': [
{
'RecognizerName': 'string',
'NumberOfVersions': 123,
'LatestVersionCreatedAt': datetime(2015, 1, 1),
'LatestVersionName': 'string',
'LatestVersionStatus': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EntityRecognizerSummariesList (list) --
The list entity recognizer summaries.
(dict) --
Describes the information about an entity recognizer and its versions.
RecognizerName (string) --
The name that you assigned the entity recognizer.
NumberOfVersions (integer) --
The number of versions you created.
LatestVersionCreatedAt (datetime) --
The time that the latest entity recognizer version was submitted for processing.
LatestVersionName (string) --
The version name you assigned to the latest entity recognizer version.
LatestVersionStatus (string) --
Provides the status of the latest entity recognizer version.
NextToken (string) --
The list entity recognizer summaries.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InternalServerExceptionlist_entity_recognizers(**kwargs)¶Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
See also: AWS API Documentation
Request Syntax
response = client.list_entity_recognizers(
Filter={
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'RecognizerName': 'string',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the list of entities returned. You can filter on Status , SubmitTimeBefore , or SubmitTimeAfter . You can only set one filter at a time.
The status of an entity recognizer.
The name that you assigned the entity recognizer.
Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
dict
Response Syntax
{
'EntityRecognizerPropertiesList': [
{
'EntityRecognizerArn': 'string',
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TrainingStartTime': datetime(2015, 1, 1),
'TrainingEndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'EntityTypes': [
{
'Type': 'string'
},
],
'Documents': {
'S3Uri': 'string',
'TestS3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
},
'Annotations': {
'S3Uri': 'string',
'TestS3Uri': 'string'
},
'EntityList': {
'S3Uri': 'string'
},
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
'RecognizerMetadata': {
'NumberOfTrainedDocuments': 123,
'NumberOfTestDocuments': 123,
'EvaluationMetrics': {
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0
},
'EntityTypes': [
{
'Type': 'string',
'EvaluationMetrics': {
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0
},
'NumberOfTrainMentions': 123
},
]
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ModelKmsKeyId': 'string',
'VersionName': 'string',
'SourceModelArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EntityRecognizerPropertiesList (list) --
The list of properties of an entity recognizer.
(dict) --
Describes information about an entity recognizer.
EntityRecognizerArn (string) --
The Amazon Resource Name (ARN) that identifies the entity recognizer.
LanguageCode (string) --
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
Status (string) --
Provides the status of the entity recognizer.
Message (string) --
A description of the status of the recognizer.
SubmitTime (datetime) --
The time that the recognizer was submitted for processing.
EndTime (datetime) --
The time that the recognizer creation completed.
TrainingStartTime (datetime) --
The time that training of the entity recognizer started.
TrainingEndTime (datetime) --
The time that training of the entity recognizer was completed.
InputDataConfig (dict) --
The input data properties of an entity recognizer.
DataFormat (string) --
The format of your training data:
COMPREHEND_CSV : A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list. If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
EntityTypes (list) --
The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: n (line break), \n (escaped line break), r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
(dict) --
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Type (string) --
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: n (line break), \n (escaped line break, r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
Documents (dict) --
The S3 location of the folder that contains the training documents for your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
S3Uri (string) --
Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
TestS3Uri (string) --
Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
InputFormat (string) --
Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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.
Annotations (dict) --
The S3 location of the CSV file that annotates your training documents.
S3Uri (string) --
Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
TestS3Uri (string) --
Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
EntityList (dict) --
The S3 location of the CSV file that has the entity list for your custom entity recognizer.
S3Uri (string) --
Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
AugmentedManifests (list) --
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
(dict) --
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
S3Uri (string) --
The Amazon S3 location of the augmented manifest file.
Split (string) --
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
AttributeNames (list) --
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
AnnotationDataS3Uri (string) --
The S3 prefix to the annotation files that are referred in the augmented manifest file.
SourceDocumentsS3Uri (string) --
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
DocumentType (string) --
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.RecognizerMetadata (dict) --
Provides information about an entity recognizer.
NumberOfTrainedDocuments (integer) --
The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
NumberOfTestDocuments (integer) --
The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
EvaluationMetrics (dict) --
Detailed information about the accuracy of an entity recognizer.
Precision (float) --
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
Recall (float) --
A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
F1Score (float) --
A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.
EntityTypes (list) --
Entity types from the metadata of an entity recognizer.
(dict) --
Individual item from the list of entity types in the metadata of an entity recognizer.
Type (string) --
Type of entity from the list of entity types in the metadata of an entity recognizer.
EvaluationMetrics (dict) --
Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.
Precision (float) --
A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
Recall (float) --
A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.
F1Score (float) --
A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
NumberOfTrainMentions (integer) --
Indicates the number of times the given entity type was seen in the training data.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
ModelKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VersionName (string) --
The version name you assigned to the entity recognizer.
SourceModelArn (string) --
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_events_detection_jobs(**kwargs)¶Gets a list of the events detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_events_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the events detection job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'EventsDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'TargetEventTypes': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EventsDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about an events detection job.
JobId (string) --
The identifier assigned to the events detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name you assigned the events detection job.
JobStatus (string) --
The current status of the events detection job.
Message (string) --
A description of the status of the events detection job.
SubmitTime (datetime) --
The time that the events detection job was submitted for processing.
EndTime (datetime) --
The time that the events detection job completed.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the events detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the events detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
TargetEventTypes (list) --
The types of events that are detected by the job.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_key_phrases_detection_jobs(**kwargs)¶Get a list of key phrase detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_key_phrases_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'KeyPhrasesDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
KeyPhrasesDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a key phrases detection job.
JobId (string) --
The identifier assigned to the key phrases detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned the key phrases detection job.
JobStatus (string) --
The current status of the key phrases detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the key phrases detection job was submitted for processing.
EndTime (datetime) --
The time that the key phrases detection job completed.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the key phrases detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the key phrases detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_pii_entities_detection_jobs(**kwargs)¶Gets a list of the PII entity detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_pii_entities_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'PiiEntitiesDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'RedactionConfig': {
'PiiEntityTypes': [
'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'DATE_TIME'|'PASSPORT_NUMBER'|'DRIVER_ID'|'URL'|'AGE'|'USERNAME'|'PASSWORD'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'IP_ADDRESS'|'MAC_ADDRESS'|'ALL'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'IN_PERMANENT_ACCOUNT_NUMBER'|'IN_NREGA'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'CA_HEALTH_NUMBER'|'IN_AADHAAR'|'IN_VOTER_NUMBER',
],
'MaskMode': 'MASK'|'REPLACE_WITH_PII_ENTITY_TYPE',
'MaskCharacter': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'Mode': 'ONLY_REDACTION'|'ONLY_OFFSETS'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PiiEntitiesDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a PII entities detection job.
JobId (string) --
The identifier assigned to the PII entities detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned the PII entities detection job.
JobStatus (string) --
The current status of the PII entities detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the PII entities detection job was submitted for processing.
EndTime (datetime) --
The time that the PII entities detection job completed.
InputDataConfig (dict) --
The input properties for a PII entities detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the PII entities detection job.
S3Uri (string) --
When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
RedactionConfig (dict) --
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION . In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
PiiEntityTypes (list) --
An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
MaskMode (string) --
Specifies whether the PII entity is redacted with the mask character or the entity type.
MaskCharacter (string) --
A character that replaces each character in the redacted PII entity.
LanguageCode (string) --
The language code of the input documents
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
Mode (string) --
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_sentiment_detection_jobs(**kwargs)¶Gets a list of sentiment detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_sentiment_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'SentimentDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SentimentDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a sentiment detection job.
JobId (string) --
The identifier assigned to the sentiment detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the sentiment detection job
JobStatus (string) --
The current status of the sentiment detection job. If the status is FAILED , the Messages field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the sentiment detection job was submitted for processing.
EndTime (datetime) --
The time that the sentiment detection job ended.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the sentiment detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the sentiment detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionLists all tags associated with a given Amazon Comprehend resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
{
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionlist_targeted_sentiment_detection_jobs(**kwargs)¶Gets a list of targeted sentiment detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_targeted_sentiment_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'TargetedSentimentDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TargetedSentimentDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a targeted sentiment detection job.
JobId (string) --
The identifier assigned to the targeted sentiment detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the targeted sentiment detection job.
JobStatus (string) --
The current status of the targeted sentiment detection job. If the status is FAILED , the Messages field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the targeted sentiment detection job was submitted for processing.
EndTime (datetime) --
The time that the targeted sentiment detection job ended.
InputDataConfig (dict) --
The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
Provides configuration parameters for the output of inference jobs.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionlist_topics_detection_jobs(**kwargs)¶Gets a list of the topic detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_topics_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
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.
Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
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.
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.
dict
Response Syntax
{
'TopicsDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'NumberOfTopics': 123,
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TopicsDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a topic detection job.
JobId (string) --
The identifier assigned to the topic detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name of the topic detection job.
JobStatus (string) --
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) --
A description for the status of a job.
SubmitTime (datetime) --
The time that the topic detection job was submitted for processing.
EndTime (datetime) --
The time that the topic detection job was completed.
InputDataConfig (dict) --
The input data configuration supplied when you created the topic detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration supplied when you created the topic detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"NumberOfTopics (integer) --
The number of topics to detect supplied when you created the topic detection job. The default is 10.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.InvalidFilterExceptionComprehend.Client.exceptions.InternalServerExceptionput_resource_policy(**kwargs)¶Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
ResourceArn='string',
ResourcePolicy='string',
PolicyRevisionId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the custom model to attach the policy to.
[REQUIRED]
The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
dict
Response Syntax
{
'PolicyRevisionId': 'string'
}
Response Structure
(dict) --
PolicyRevisionId (string) --
The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstart_document_classification_job(**kwargs)¶Starts an asynchronous document classification job. Use the operation to track the progress of the job.
See also: AWS API Documentation
Request Syntax
response = client.start_document_classification_job(
JobName='string',
DocumentClassifierArn='string',
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the document classifier to use to process the job.
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of the job, use this identifier with the operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job:
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_dominant_language_detection_job(**kwargs)¶Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_dominant_language_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
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 unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_entities_detection_job(**kwargs)¶Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
See also: AWS API Documentation
Request Syntax
response = client.start_entities_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
EntityRecognizerArn='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
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.
StartEntitiesDetectionJob . This ARN is optional and is only used for a custom entity recognition job.[REQUIRED]
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of job, use this identifier with the operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_events_detection_job(**kwargs)¶Starts an asynchronous event detection job for a collection of documents.
See also: AWS API Documentation
Request Syntax
response = client.start_events_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
ClientRequestToken='string',
TargetEventTypes=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
[REQUIRED]
The language code of the input documents.
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
[REQUIRED]
The types of events to detect in the input documents.
Tags to be associated with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
JobArn (string) --
The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the events detection job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_key_phrases_detection_job(**kwargs)¶Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_key_phrases_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
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.
[REQUIRED]
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.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_pii_entities_detection_job(**kwargs)¶Starts an asynchronous PII entity detection job for a collection of documents.
See also: AWS API Documentation
Request Syntax
response = client.start_pii_entities_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
Mode='ONLY_REDACTION'|'ONLY_OFFSETS',
RedactionConfig={
'PiiEntityTypes': [
'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'DATE_TIME'|'PASSPORT_NUMBER'|'DRIVER_ID'|'URL'|'AGE'|'USERNAME'|'PASSWORD'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'IP_ADDRESS'|'MAC_ADDRESS'|'ALL'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'IN_PERMANENT_ACCOUNT_NUMBER'|'IN_NREGA'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'CA_HEALTH_NUMBER'|'IN_AADHAAR'|'IN_VOTER_NUMBER',
],
'MaskMode': 'MASK'|'REPLACE_WITH_PII_ENTITY_TYPE',
'MaskCharacter': 'string'
},
DataAccessRoleArn='string',
JobName='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The input properties for a PII entities detection job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Provides configuration parameters for the output of PII entity detection jobs.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION . In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
Specifies whether the PII entity is redacted with the mask character or the entity type.
A character that replaces each character in the redacted PII entity.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
[REQUIRED]
The language of the input documents. Currently, English is the only valid language.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job.
JobArn (string) --
The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_sentiment_detection_job(**kwargs)¶Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_sentiment_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
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.
[REQUIRED]
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.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_targeted_sentiment_detection_job(**kwargs)¶Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_targeted_sentiment_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
Specifies where to send the output files.
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
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 Role-based permissions.
[REQUIRED]
The language of the input documents. Currently, English is the only supported language.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstart_topics_detection_job(**kwargs)¶Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_topics_detection_job(
InputDataConfig={
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
OutputDataConfig={
'S3Uri': 'string',
'KmsKeyId': 'string'
},
DataAccessRoleArn='string',
JobName='string',
NumberOfTopics=123,
ClientRequestToken='string',
VolumeKmsKeyId='string',
VpcConfig={
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the format and location of the input data for the job.
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.
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.Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.[REQUIRED]
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
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"[REQUIRED]
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 unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
This field is autopopulated if not provided.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Tags to be associated with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{
'JobId': 'string',
'JobArn': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.
JobArn (string) --
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
JobStatus (string) --
The status of the job:
DescribeTopicDetectionJob operation.Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.KmsKeyValidationExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionstop_dominant_language_detection_job(**kwargs)¶Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
See also: AWS API Documentation
Request Syntax
response = client.stop_dominant_language_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the dominant language detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the dominant language detection job to stop.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_entities_detection_job(**kwargs)¶Stops an entities detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
See also: AWS API Documentation
Request Syntax
response = client.stop_entities_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the entities detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the entities detection job to stop.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_events_detection_job(**kwargs)¶Stops an events detection job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_events_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the events detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the events detection job to stop.
The status of the events detection job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_key_phrases_detection_job(**kwargs)¶Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
See also: AWS API Documentation
Request Syntax
response = client.stop_key_phrases_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the key phrases detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the key phrases detection job to stop.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_pii_entities_detection_job(**kwargs)¶Stops a PII entities detection job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_pii_entities_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the PII entities detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the PII entities detection job to stop.
The status of the PII entities detection job.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_sentiment_detection_job(**kwargs)¶Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS , the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
See also: AWS API Documentation
Request Syntax
response = client.stop_sentiment_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the sentiment detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the sentiment detection job to stop.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_targeted_sentiment_detection_job(**kwargs)¶Stops a targeted sentiment detection job in progress.
If the job state is IN_PROGRESS , the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
See also: AWS API Documentation
Request Syntax
response = client.stop_targeted_sentiment_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the targeted sentiment detection job to stop.
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}
Response Structure
The identifier of the targeted sentiment detection job to stop.
Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.JobNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_training_document_classifier(**kwargs)¶Stops a document classifier training job while in progress.
If the training job state is TRAINING , the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED ; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
See also: AWS API Documentation
Request Syntax
response = client.stop_training_document_classifier(
DocumentClassifierArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionstop_training_entity_recognizer(**kwargs)¶Stops an entity recognizer training job while in progress.
If the training job state is TRAINING , the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED ; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
See also: AWS API Documentation
Request Syntax
response = client.stop_training_entity_recognizer(
EntityRecognizerArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
[REQUIRED]
Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”
The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.
dict
Response Syntax
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ConcurrentModificationExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.TooManyTagsExceptionComprehend.Client.exceptions.InternalServerExceptionuntag_resource(**kwargs)¶Removes a specific tag associated with an Amazon Comprehend resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
[REQUIRED]
The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.TooManyTagKeysExceptionComprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.ConcurrentModificationExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.InternalServerExceptionupdate_endpoint(**kwargs)¶Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
See also: AWS API Documentation
Request Syntax
response = client.update_endpoint(
EndpointArn='string',
DesiredModelArn='string',
DesiredInferenceUnits=123,
DesiredDataAccessRoleArn='string'
)
[REQUIRED]
The Amazon Resource Number (ARN) of the endpoint being updated.
dict
Response Syntax
{}
Response Structure
Exceptions
Comprehend.Client.exceptions.InvalidRequestExceptionComprehend.Client.exceptions.TooManyRequestsExceptionComprehend.Client.exceptions.ResourceInUseExceptionComprehend.Client.exceptions.ResourceLimitExceededExceptionComprehend.Client.exceptions.ResourceNotFoundExceptionComprehend.Client.exceptions.ResourceUnavailableExceptionComprehend.Client.exceptions.InternalServerExceptionThe available paginators are:
Comprehend.Paginator.ListDocumentClassificationJobsComprehend.Paginator.ListDocumentClassifiersComprehend.Paginator.ListDominantLanguageDetectionJobsComprehend.Paginator.ListEndpointsComprehend.Paginator.ListEntitiesDetectionJobsComprehend.Paginator.ListEntityRecognizersComprehend.Paginator.ListKeyPhrasesDetectionJobsComprehend.Paginator.ListPiiEntitiesDetectionJobsComprehend.Paginator.ListSentimentDetectionJobsComprehend.Paginator.ListTopicsDetectionJobsComprehend.Paginator.ListDocumentClassificationJobs¶paginator = client.get_paginator('list_document_classification_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_document_classification_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
Filters on the name of the job.
Filters the list based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DocumentClassificationJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DocumentClassifierArn': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
}
Response Structure
(dict) --
DocumentClassificationJobPropertiesList (list) --
A list containing the properties of each job returned.
(dict) --
Provides information about a document classification job.
JobId (string) --
The identifier assigned to the document classification job.
JobArn (string) --
The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the document classification job.
JobStatus (string) --
The current status of the document classification job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of the job.
SubmitTime (datetime) --
The time that the document classification job was submitted for processing.
EndTime (datetime) --
The time that the document classification job completed.
DocumentClassifierArn (string) --
The Amazon Resource Name (ARN) that identifies the document classifier.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the document classification job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the document classification job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Comprehend.Paginator.ListDocumentClassifiers¶paginator = client.get_paginator('list_document_classifiers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_document_classifiers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'DocumentClassifierName': 'string',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters the list of classifiers based on status.
The name that you assigned to the document classifier
Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.
Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DocumentClassifierPropertiesList': [
{
'DocumentClassifierArn': 'string',
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TrainingStartTime': datetime(2015, 1, 1),
'TrainingEndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'S3Uri': 'string',
'TestS3Uri': 'string',
'LabelDelimiter': 'string',
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'ClassifierMetadata': {
'NumberOfLabels': 123,
'NumberOfTrainedDocuments': 123,
'NumberOfTestDocuments': 123,
'EvaluationMetrics': {
'Accuracy': 123.0,
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0,
'MicroPrecision': 123.0,
'MicroRecall': 123.0,
'MicroF1Score': 123.0,
'HammingLoss': 123.0
}
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'Mode': 'MULTI_CLASS'|'MULTI_LABEL',
'ModelKmsKeyId': 'string',
'VersionName': 'string',
'SourceModelArn': 'string'
},
],
}
Response Structure
(dict) --
DocumentClassifierPropertiesList (list) --
A list containing the properties of each job returned.
(dict) --
Provides information about a document classifier.
DocumentClassifierArn (string) --
The Amazon Resource Name (ARN) that identifies the document classifier.
LanguageCode (string) --
The language code for the language of the documents that the classifier was trained on.
Status (string) --
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
Message (string) --
Additional information about the status of the classifier.
SubmitTime (datetime) --
The time that the document classifier was submitted for training.
EndTime (datetime) --
The time that training the document classifier completed.
TrainingStartTime (datetime) --
Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
TrainingEndTime (datetime) --
The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the document classifier for training.
DataFormat (string) --
The format of your training data:
COMPREHEND_CSV : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri parameter in your request.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
S3Uri (string) --
The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
TestS3Uri (string) --
This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
LabelDelimiter (string) --
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
AugmentedManifests (list) --
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
(dict) --
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
S3Uri (string) --
The Amazon S3 location of the augmented manifest file.
Split (string) --
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
AttributeNames (list) --
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
AnnotationDataS3Uri (string) --
The S3 prefix to the annotation files that are referred in the augmented manifest file.
SourceDocumentsS3Uri (string) --
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
DocumentType (string) --
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.OutputDataConfig (dict) --
Provides output results configuration parameters for custom classifier jobs.
S3Uri (string) --
When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. 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 this output file.
When the custom classifier job is finished, the service creates the 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 confusion matrix.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"ClassifierMetadata (dict) --
Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
NumberOfLabels (integer) --
The number of labels in the input data.
NumberOfTrainedDocuments (integer) --
The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.
NumberOfTestDocuments (integer) --
The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.
EvaluationMetrics (dict) --
Describes the result metrics for the test data associated with an documentation classifier.
Accuracy (float) --
The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.
Precision (float) --
A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.
Recall (float) --
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.
F1Score (float) --
A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
MicroPrecision (float) --
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.
MicroRecall (float) --
A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.
MicroF1Score (float) --
A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.
HammingLoss (float) --
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Mode (string) --
Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
ModelKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VersionName (string) --
The version name that you assigned to the document classifier.
SourceModelArn (string) --
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
Comprehend.Paginator.ListDominantLanguageDetectionJobs¶paginator = client.get_paginator('list_dominant_language_detection_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_dominant_language_detection_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DominantLanguageDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
}
Response Structure
(dict) --
DominantLanguageDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a dominant language detection job.
JobId (string) --
The identifier assigned to the dominant language detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the dominant language detection job.
JobStatus (string) --
The current status of the dominant language detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description for the status of a job.
SubmitTime (datetime) --
The time that the dominant language detection job was submitted for processing.
EndTime (datetime) --
The time that the dominant language detection job completed.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the dominant language detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the dominant language detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Comprehend.Paginator.ListEndpoints¶paginator = client.get_paginator('list_endpoints')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'ModelArn': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
'CreationTimeBefore': datetime(2015, 1, 1),
'CreationTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.
Specifies a date before which the returned endpoint or endpoints were created.
Specifies a date after which the returned endpoint or endpoints were created.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EndpointPropertiesList': [
{
'EndpointArn': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'IN_SERVICE'|'UPDATING',
'Message': 'string',
'ModelArn': 'string',
'DesiredModelArn': 'string',
'DesiredInferenceUnits': 123,
'CurrentInferenceUnits': 123,
'CreationTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DesiredDataAccessRoleArn': 'string'
},
],
}
Response Structure
(dict) --
EndpointPropertiesList (list) --
Displays a list of endpoint properties being retrieved by the service in response to the request.
(dict) --
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.
EndpointArn (string) --
The Amazon Resource Number (ARN) of the endpoint.
Status (string) --
Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.
Message (string) --
Specifies a reason for failure in cases of Failed status.
ModelArn (string) --
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
DesiredModelArn (string) --
ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress
DesiredInferenceUnits (integer) --
The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
CurrentInferenceUnits (integer) --
The number of inference units currently used by the model using this endpoint.
CreationTime (datetime) --
The creation date and time of the endpoint.
LastModifiedTime (datetime) --
The date and time that the endpoint was last modified.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
DesiredDataAccessRoleArn (string) --
Data access role ARN to use in case the new model is encrypted with a customer KMS key.
Comprehend.Paginator.ListEntitiesDetectionJobs¶paginator = client.get_paginator('list_entities_detection_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_entities_detection_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EntitiesDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'EntityRecognizerArn': 'string',
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
}
Response Structure
(dict) --
EntitiesDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about an entities detection job.
JobId (string) --
The identifier assigned to the entities detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned the entities detection job.
JobStatus (string) --
The current status of the entities detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the entities detection job was submitted for processing.
EndTime (datetime) --
The time that the entities detection job completed
EntityRecognizerArn (string) --
The Amazon Resource Name (ARN) that identifies the entity recognizer.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the entities detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the entities detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Comprehend.Paginator.ListEntityRecognizers¶paginator = client.get_paginator('list_entity_recognizers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_entity_recognizers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'RecognizerName': 'string',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the list of entities returned. You can filter on Status , SubmitTimeBefore , or SubmitTimeAfter . You can only set one filter at a time.
The status of an entity recognizer.
The name that you assigned the entity recognizer.
Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.
Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EntityRecognizerPropertiesList': [
{
'EntityRecognizerArn': 'string',
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TrainingStartTime': datetime(2015, 1, 1),
'TrainingEndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
'EntityTypes': [
{
'Type': 'string'
},
],
'Documents': {
'S3Uri': 'string',
'TestS3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
},
'Annotations': {
'S3Uri': 'string',
'TestS3Uri': 'string'
},
'EntityList': {
'S3Uri': 'string'
},
'AugmentedManifests': [
{
'S3Uri': 'string',
'Split': 'TRAIN'|'TEST',
'AttributeNames': [
'string',
],
'AnnotationDataS3Uri': 'string',
'SourceDocumentsS3Uri': 'string',
'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
},
]
},
'RecognizerMetadata': {
'NumberOfTrainedDocuments': 123,
'NumberOfTestDocuments': 123,
'EvaluationMetrics': {
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0
},
'EntityTypes': [
{
'Type': 'string',
'EvaluationMetrics': {
'Precision': 123.0,
'Recall': 123.0,
'F1Score': 123.0
},
'NumberOfTrainMentions': 123
},
]
},
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
},
'ModelKmsKeyId': 'string',
'VersionName': 'string',
'SourceModelArn': 'string'
},
],
}
Response Structure
(dict) --
EntityRecognizerPropertiesList (list) --
The list of properties of an entity recognizer.
(dict) --
Describes information about an entity recognizer.
EntityRecognizerArn (string) --
The Amazon Resource Name (ARN) that identifies the entity recognizer.
LanguageCode (string) --
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
Status (string) --
Provides the status of the entity recognizer.
Message (string) --
A description of the status of the recognizer.
SubmitTime (datetime) --
The time that the recognizer was submitted for processing.
EndTime (datetime) --
The time that the recognizer creation completed.
TrainingStartTime (datetime) --
The time that training of the entity recognizer started.
TrainingEndTime (datetime) --
The time that training of the entity recognizer was completed.
InputDataConfig (dict) --
The input data properties of an entity recognizer.
DataFormat (string) --
The format of your training data:
COMPREHEND_CSV : A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list. If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.AUGMENTED_MANIFEST : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. If you use this value, you must provide the AugmentedManifests parameter in your request.If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
EntityTypes (list) --
The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.
A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: n (line break), \n (escaped line break), r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
(dict) --
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Type (string) --
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
Entity types must not contain the following invalid characters: n (line break), \n (escaped line break, r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).
Documents (dict) --
The S3 location of the folder that contains the training documents for your custom entity recognizer.
This parameter is required if you set DataFormat to COMPREHEND_CSV .
S3Uri (string) --
Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
TestS3Uri (string) --
Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
InputFormat (string) --
Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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.
Annotations (dict) --
The S3 location of the CSV file that annotates your training documents.
S3Uri (string) --
Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
TestS3Uri (string) --
Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
EntityList (dict) --
The S3 location of the CSV file that has the entity list for your custom entity recognizer.
S3Uri (string) --
Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.
AugmentedManifests (list) --
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
This parameter is required if you set DataFormat to AUGMENTED_MANIFEST .
(dict) --
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
S3Uri (string) --
The Amazon S3 location of the augmented manifest file.
Split (string) --
The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.
TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.
TEST - all of the documents in the manifest will be used for testing.
AttributeNames (list) --
The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.
If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.
If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.
AnnotationDataS3Uri (string) --
The S3 prefix to the annotation files that are referred in the augmented manifest file.
SourceDocumentsS3Uri (string) --
The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
DocumentType (string) --
The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.
PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.RecognizerMetadata (dict) --
Provides information about an entity recognizer.
NumberOfTrainedDocuments (integer) --
The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.
NumberOfTestDocuments (integer) --
The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.
EvaluationMetrics (dict) --
Detailed information about the accuracy of an entity recognizer.
Precision (float) --
A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
Recall (float) --
A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
F1Score (float) --
A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.
EntityTypes (list) --
Entity types from the metadata of an entity recognizer.
(dict) --
Individual item from the list of entity types in the metadata of an entity recognizer.
Type (string) --
Type of entity from the list of entity types in the metadata of an entity recognizer.
EvaluationMetrics (dict) --
Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.
Precision (float) --
A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
Recall (float) --
A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.
F1Score (float) --
A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.
NumberOfTrainMentions (integer) --
Indicates the number of times the given entity type was seen in the training data.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
ModelKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VersionName (string) --
The version name you assigned to the entity recognizer.
SourceModelArn (string) --
The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
Comprehend.Paginator.ListKeyPhrasesDetectionJobs¶paginator = client.get_paginator('list_key_phrases_detection_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_key_phrases_detection_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'KeyPhrasesDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
}
Response Structure
(dict) --
KeyPhrasesDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a key phrases detection job.
JobId (string) --
The identifier assigned to the key phrases detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned the key phrases detection job.
JobStatus (string) --
The current status of the key phrases detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the key phrases detection job was submitted for processing.
EndTime (datetime) --
The time that the key phrases detection job completed.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the key phrases detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the key phrases detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Comprehend.Paginator.ListPiiEntitiesDetectionJobs¶paginator = client.get_paginator('list_pii_entities_detection_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_pii_entities_detection_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PiiEntitiesDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'RedactionConfig': {
'PiiEntityTypes': [
'BANK_ACCOUNT_NUMBER'|'BANK_ROUTING'|'CREDIT_DEBIT_NUMBER'|'CREDIT_DEBIT_CVV'|'CREDIT_DEBIT_EXPIRY'|'PIN'|'EMAIL'|'ADDRESS'|'NAME'|'PHONE'|'SSN'|'DATE_TIME'|'PASSPORT_NUMBER'|'DRIVER_ID'|'URL'|'AGE'|'USERNAME'|'PASSWORD'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'IP_ADDRESS'|'MAC_ADDRESS'|'ALL'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'IN_PERMANENT_ACCOUNT_NUMBER'|'IN_NREGA'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'CA_HEALTH_NUMBER'|'IN_AADHAAR'|'IN_VOTER_NUMBER',
],
'MaskMode': 'MASK'|'REPLACE_WITH_PII_ENTITY_TYPE',
'MaskCharacter': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'Mode': 'ONLY_REDACTION'|'ONLY_OFFSETS'
},
],
}
Response Structure
(dict) --
PiiEntitiesDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a PII entities detection job.
JobId (string) --
The identifier assigned to the PII entities detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned the PII entities detection job.
JobStatus (string) --
The current status of the PII entities detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the PII entities detection job was submitted for processing.
EndTime (datetime) --
The time that the PII entities detection job completed.
InputDataConfig (dict) --
The input properties for a PII entities detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the PII entities detection job.
S3Uri (string) --
When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
RedactionConfig (dict) --
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION . In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
PiiEntityTypes (list) --
An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
MaskMode (string) --
Specifies whether the PII entity is redacted with the mask character or the entity type.
MaskCharacter (string) --
A character that replaces each character in the redacted PII entity.
LanguageCode (string) --
The language code of the input documents
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
Mode (string) --
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
Comprehend.Paginator.ListSentimentDetectionJobs¶paginator = client.get_paginator('list_sentiment_detection_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_sentiment_detection_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SentimentDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
}
Response Structure
(dict) --
SentimentDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a sentiment detection job.
JobId (string) --
The identifier assigned to the sentiment detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name that you assigned to the sentiment detection job
JobStatus (string) --
The current status of the sentiment detection job. If the status is FAILED , the Messages field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the sentiment detection job was submitted for processing.
EndTime (datetime) --
The time that the sentiment detection job ended.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the sentiment detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration that you supplied when you created the sentiment detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Comprehend.Paginator.ListTopicsDetectionJobs¶paginator = client.get_paginator('list_topics_detection_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Comprehend.Client.list_topics_detection_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
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.
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.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TopicsDetectionJobPropertiesList': [
{
'JobId': 'string',
'JobArn': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Uri': 'string',
'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE',
'DocumentReaderConfig': {
'DocumentReadAction': 'TEXTRACT_DETECT_DOCUMENT_TEXT'|'TEXTRACT_ANALYZE_DOCUMENT',
'DocumentReadMode': 'SERVICE_DEFAULT'|'FORCE_DOCUMENT_READ_ACTION',
'FeatureTypes': [
'TABLES'|'FORMS',
]
}
},
'OutputDataConfig': {
'S3Uri': 'string',
'KmsKeyId': 'string'
},
'NumberOfTopics': 123,
'DataAccessRoleArn': 'string',
'VolumeKmsKeyId': 'string',
'VpcConfig': {
'SecurityGroupIds': [
'string',
],
'Subnets': [
'string',
]
}
},
],
}
Response Structure
(dict) --
TopicsDetectionJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a topic detection job.
JobId (string) --
The identifier assigned to the topic detection job.
JobArn (string) --
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
JobName (string) --
The name of the topic detection job.
JobStatus (string) --
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) --
A description for the status of a job.
SubmitTime (datetime) --
The time that the topic detection job was submitted for processing.
EndTime (datetime) --
The time that the topic detection job was completed.
InputDataConfig (dict) --
The input data configuration supplied when you created the topic detection job.
S3Uri (string) --
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) --
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.DocumentReaderConfig (dict) --
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
DocumentReadAction (string) --
This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.DocumentReadMode (string) --
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.FeatureTypes (list) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.FORMS - Returns information and the data from any forms that are detected in the input document.(string) --
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.FORMS - Returns additional information about any forms that are detected in the input document.OutputDataConfig (dict) --
The output data configuration supplied when you created the topic detection job.
S3Uri (string) --
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.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
KmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab""alias/ExampleAlias""arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"NumberOfTopics (integer) --
The number of topics to detect supplied when you created the topic detection job. The default is 10.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.
VolumeKmsKeyId (string) --
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
"1234abcd-12ab-34cd-56ef-1234567890ab""arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"VpcConfig (dict) --
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
SecurityGroupIds (list) --
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Subnets (list) --
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.