aws-sdk-comprehend 1.8.0 → 1.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +388 -5
- data/lib/aws-sdk-comprehend/client_api.rb +232 -0
- data/lib/aws-sdk-comprehend/types.rb +691 -3
- metadata +2 -2
@@ -30,7 +30,18 @@ module Aws::Comprehend
|
|
30
30
|
BatchItemError = Shapes::StructureShape.new(name: 'BatchItemError')
|
31
31
|
BatchItemErrorList = Shapes::ListShape.new(name: 'BatchItemErrorList')
|
32
32
|
BatchSizeLimitExceededException = Shapes::StructureShape.new(name: 'BatchSizeLimitExceededException')
|
33
|
+
ClassifierEvaluationMetrics = Shapes::StructureShape.new(name: 'ClassifierEvaluationMetrics')
|
34
|
+
ClassifierMetadata = Shapes::StructureShape.new(name: 'ClassifierMetadata')
|
33
35
|
ClientRequestTokenString = Shapes::StringShape.new(name: 'ClientRequestTokenString')
|
36
|
+
ComprehendArnName = Shapes::StringShape.new(name: 'ComprehendArnName')
|
37
|
+
CreateDocumentClassifierRequest = Shapes::StructureShape.new(name: 'CreateDocumentClassifierRequest')
|
38
|
+
CreateDocumentClassifierResponse = Shapes::StructureShape.new(name: 'CreateDocumentClassifierResponse')
|
39
|
+
DeleteDocumentClassifierRequest = Shapes::StructureShape.new(name: 'DeleteDocumentClassifierRequest')
|
40
|
+
DeleteDocumentClassifierResponse = Shapes::StructureShape.new(name: 'DeleteDocumentClassifierResponse')
|
41
|
+
DescribeDocumentClassificationJobRequest = Shapes::StructureShape.new(name: 'DescribeDocumentClassificationJobRequest')
|
42
|
+
DescribeDocumentClassificationJobResponse = Shapes::StructureShape.new(name: 'DescribeDocumentClassificationJobResponse')
|
43
|
+
DescribeDocumentClassifierRequest = Shapes::StructureShape.new(name: 'DescribeDocumentClassifierRequest')
|
44
|
+
DescribeDocumentClassifierResponse = Shapes::StructureShape.new(name: 'DescribeDocumentClassifierResponse')
|
34
45
|
DescribeDominantLanguageDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeDominantLanguageDetectionJobRequest')
|
35
46
|
DescribeDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeDominantLanguageDetectionJobResponse')
|
36
47
|
DescribeEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionJobRequest')
|
@@ -51,10 +62,19 @@ module Aws::Comprehend
|
|
51
62
|
DetectSentimentResponse = Shapes::StructureShape.new(name: 'DetectSentimentResponse')
|
52
63
|
DetectSyntaxRequest = Shapes::StructureShape.new(name: 'DetectSyntaxRequest')
|
53
64
|
DetectSyntaxResponse = Shapes::StructureShape.new(name: 'DetectSyntaxResponse')
|
65
|
+
DocumentClassificationJobFilter = Shapes::StructureShape.new(name: 'DocumentClassificationJobFilter')
|
66
|
+
DocumentClassificationJobProperties = Shapes::StructureShape.new(name: 'DocumentClassificationJobProperties')
|
67
|
+
DocumentClassificationJobPropertiesList = Shapes::ListShape.new(name: 'DocumentClassificationJobPropertiesList')
|
68
|
+
DocumentClassifierArn = Shapes::StringShape.new(name: 'DocumentClassifierArn')
|
69
|
+
DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
|
70
|
+
DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
|
71
|
+
DocumentClassifierProperties = Shapes::StructureShape.new(name: 'DocumentClassifierProperties')
|
72
|
+
DocumentClassifierPropertiesList = Shapes::ListShape.new(name: 'DocumentClassifierPropertiesList')
|
54
73
|
DominantLanguage = Shapes::StructureShape.new(name: 'DominantLanguage')
|
55
74
|
DominantLanguageDetectionJobFilter = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobFilter')
|
56
75
|
DominantLanguageDetectionJobProperties = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobProperties')
|
57
76
|
DominantLanguageDetectionJobPropertiesList = Shapes::ListShape.new(name: 'DominantLanguageDetectionJobPropertiesList')
|
77
|
+
Double = Shapes::FloatShape.new(name: 'Double')
|
58
78
|
EntitiesDetectionJobFilter = Shapes::StructureShape.new(name: 'EntitiesDetectionJobFilter')
|
59
79
|
EntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'EntitiesDetectionJobProperties')
|
60
80
|
EntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EntitiesDetectionJobPropertiesList')
|
@@ -77,6 +97,10 @@ module Aws::Comprehend
|
|
77
97
|
KeyPhrasesDetectionJobProperties = Shapes::StructureShape.new(name: 'KeyPhrasesDetectionJobProperties')
|
78
98
|
KeyPhrasesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'KeyPhrasesDetectionJobPropertiesList')
|
79
99
|
LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
|
100
|
+
ListDocumentClassificationJobsRequest = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsRequest')
|
101
|
+
ListDocumentClassificationJobsResponse = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsResponse')
|
102
|
+
ListDocumentClassifiersRequest = Shapes::StructureShape.new(name: 'ListDocumentClassifiersRequest')
|
103
|
+
ListDocumentClassifiersResponse = Shapes::StructureShape.new(name: 'ListDocumentClassifiersResponse')
|
80
104
|
ListDominantLanguageDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListDominantLanguageDetectionJobsRequest')
|
81
105
|
ListDominantLanguageDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListDominantLanguageDetectionJobsResponse')
|
82
106
|
ListEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsRequest')
|
@@ -97,16 +121,23 @@ module Aws::Comprehend
|
|
97
121
|
ListTopicsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsRequest')
|
98
122
|
ListTopicsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsResponse')
|
99
123
|
MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
|
124
|
+
ModelStatus = Shapes::StringShape.new(name: 'ModelStatus')
|
100
125
|
NumberOfTopicsInteger = Shapes::IntegerShape.new(name: 'NumberOfTopicsInteger')
|
101
126
|
OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
|
102
127
|
PartOfSpeechTag = Shapes::StructureShape.new(name: 'PartOfSpeechTag')
|
103
128
|
PartOfSpeechTagType = Shapes::StringShape.new(name: 'PartOfSpeechTagType')
|
129
|
+
ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
|
130
|
+
ResourceLimitExceededException = Shapes::StructureShape.new(name: 'ResourceLimitExceededException')
|
131
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
132
|
+
ResourceUnavailableException = Shapes::StructureShape.new(name: 'ResourceUnavailableException')
|
104
133
|
S3Uri = Shapes::StringShape.new(name: 'S3Uri')
|
105
134
|
SentimentDetectionJobFilter = Shapes::StructureShape.new(name: 'SentimentDetectionJobFilter')
|
106
135
|
SentimentDetectionJobProperties = Shapes::StructureShape.new(name: 'SentimentDetectionJobProperties')
|
107
136
|
SentimentDetectionJobPropertiesList = Shapes::ListShape.new(name: 'SentimentDetectionJobPropertiesList')
|
108
137
|
SentimentScore = Shapes::StructureShape.new(name: 'SentimentScore')
|
109
138
|
SentimentType = Shapes::StringShape.new(name: 'SentimentType')
|
139
|
+
StartDocumentClassificationJobRequest = Shapes::StructureShape.new(name: 'StartDocumentClassificationJobRequest')
|
140
|
+
StartDocumentClassificationJobResponse = Shapes::StructureShape.new(name: 'StartDocumentClassificationJobResponse')
|
110
141
|
StartDominantLanguageDetectionJobRequest = Shapes::StructureShape.new(name: 'StartDominantLanguageDetectionJobRequest')
|
111
142
|
StartDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'StartDominantLanguageDetectionJobResponse')
|
112
143
|
StartEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobRequest')
|
@@ -204,6 +235,45 @@ module Aws::Comprehend
|
|
204
235
|
|
205
236
|
BatchItemErrorList.member = Shapes::ShapeRef.new(shape: BatchItemError)
|
206
237
|
|
238
|
+
ClassifierEvaluationMetrics.add_member(:accuracy, Shapes::ShapeRef.new(shape: Double, location_name: "Accuracy"))
|
239
|
+
ClassifierEvaluationMetrics.add_member(:precision, Shapes::ShapeRef.new(shape: Double, location_name: "Precision"))
|
240
|
+
ClassifierEvaluationMetrics.add_member(:recall, Shapes::ShapeRef.new(shape: Double, location_name: "Recall"))
|
241
|
+
ClassifierEvaluationMetrics.add_member(:f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "F1Score"))
|
242
|
+
ClassifierEvaluationMetrics.struct_class = Types::ClassifierEvaluationMetrics
|
243
|
+
|
244
|
+
ClassifierMetadata.add_member(:number_of_labels, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfLabels"))
|
245
|
+
ClassifierMetadata.add_member(:number_of_trained_documents, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfTrainedDocuments"))
|
246
|
+
ClassifierMetadata.add_member(:number_of_test_documents, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfTestDocuments"))
|
247
|
+
ClassifierMetadata.add_member(:evaluation_metrics, Shapes::ShapeRef.new(shape: ClassifierEvaluationMetrics, location_name: "EvaluationMetrics"))
|
248
|
+
ClassifierMetadata.struct_class = Types::ClassifierMetadata
|
249
|
+
|
250
|
+
CreateDocumentClassifierRequest.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "DocumentClassifierName"))
|
251
|
+
CreateDocumentClassifierRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
252
|
+
CreateDocumentClassifierRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, required: true, location_name: "InputDataConfig"))
|
253
|
+
CreateDocumentClassifierRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
254
|
+
CreateDocumentClassifierRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
255
|
+
CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
|
256
|
+
|
257
|
+
CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
258
|
+
CreateDocumentClassifierResponse.struct_class = Types::CreateDocumentClassifierResponse
|
259
|
+
|
260
|
+
DeleteDocumentClassifierRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
|
261
|
+
DeleteDocumentClassifierRequest.struct_class = Types::DeleteDocumentClassifierRequest
|
262
|
+
|
263
|
+
DeleteDocumentClassifierResponse.struct_class = Types::DeleteDocumentClassifierResponse
|
264
|
+
|
265
|
+
DescribeDocumentClassificationJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
266
|
+
DescribeDocumentClassificationJobRequest.struct_class = Types::DescribeDocumentClassificationJobRequest
|
267
|
+
|
268
|
+
DescribeDocumentClassificationJobResponse.add_member(:document_classification_job_properties, Shapes::ShapeRef.new(shape: DocumentClassificationJobProperties, location_name: "DocumentClassificationJobProperties"))
|
269
|
+
DescribeDocumentClassificationJobResponse.struct_class = Types::DescribeDocumentClassificationJobResponse
|
270
|
+
|
271
|
+
DescribeDocumentClassifierRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
|
272
|
+
DescribeDocumentClassifierRequest.struct_class = Types::DescribeDocumentClassifierRequest
|
273
|
+
|
274
|
+
DescribeDocumentClassifierResponse.add_member(:document_classifier_properties, Shapes::ShapeRef.new(shape: DocumentClassifierProperties, location_name: "DocumentClassifierProperties"))
|
275
|
+
DescribeDocumentClassifierResponse.struct_class = Types::DescribeDocumentClassifierResponse
|
276
|
+
|
207
277
|
DescribeDominantLanguageDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
208
278
|
DescribeDominantLanguageDetectionJobRequest.struct_class = Types::DescribeDominantLanguageDetectionJobRequest
|
209
279
|
|
@@ -269,6 +339,49 @@ module Aws::Comprehend
|
|
269
339
|
DetectSyntaxResponse.add_member(:syntax_tokens, Shapes::ShapeRef.new(shape: ListOfSyntaxTokens, location_name: "SyntaxTokens"))
|
270
340
|
DetectSyntaxResponse.struct_class = Types::DetectSyntaxResponse
|
271
341
|
|
342
|
+
DocumentClassificationJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
343
|
+
DocumentClassificationJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
344
|
+
DocumentClassificationJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
345
|
+
DocumentClassificationJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
346
|
+
DocumentClassificationJobFilter.struct_class = Types::DocumentClassificationJobFilter
|
347
|
+
|
348
|
+
DocumentClassificationJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
349
|
+
DocumentClassificationJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
350
|
+
DocumentClassificationJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
351
|
+
DocumentClassificationJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
352
|
+
DocumentClassificationJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
353
|
+
DocumentClassificationJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
354
|
+
DocumentClassificationJobProperties.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
355
|
+
DocumentClassificationJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
356
|
+
DocumentClassificationJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
357
|
+
DocumentClassificationJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
358
|
+
DocumentClassificationJobProperties.struct_class = Types::DocumentClassificationJobProperties
|
359
|
+
|
360
|
+
DocumentClassificationJobPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassificationJobProperties)
|
361
|
+
|
362
|
+
DocumentClassifierFilter.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
363
|
+
DocumentClassifierFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
364
|
+
DocumentClassifierFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
365
|
+
DocumentClassifierFilter.struct_class = Types::DocumentClassifierFilter
|
366
|
+
|
367
|
+
DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
368
|
+
DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
|
369
|
+
|
370
|
+
DocumentClassifierProperties.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
371
|
+
DocumentClassifierProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
372
|
+
DocumentClassifierProperties.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
373
|
+
DocumentClassifierProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
374
|
+
DocumentClassifierProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
375
|
+
DocumentClassifierProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
376
|
+
DocumentClassifierProperties.add_member(:training_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingStartTime"))
|
377
|
+
DocumentClassifierProperties.add_member(:training_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingEndTime"))
|
378
|
+
DocumentClassifierProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, location_name: "InputDataConfig"))
|
379
|
+
DocumentClassifierProperties.add_member(:classifier_metadata, Shapes::ShapeRef.new(shape: ClassifierMetadata, location_name: "ClassifierMetadata"))
|
380
|
+
DocumentClassifierProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
381
|
+
DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
|
382
|
+
|
383
|
+
DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
|
384
|
+
|
272
385
|
DominantLanguage.add_member(:language_code, Shapes::ShapeRef.new(shape: String, location_name: "LanguageCode"))
|
273
386
|
DominantLanguage.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
274
387
|
DominantLanguage.struct_class = Types::DominantLanguage
|
@@ -349,6 +462,24 @@ module Aws::Comprehend
|
|
349
462
|
|
350
463
|
KeyPhrasesDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobProperties)
|
351
464
|
|
465
|
+
ListDocumentClassificationJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: DocumentClassificationJobFilter, location_name: "Filter"))
|
466
|
+
ListDocumentClassificationJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
467
|
+
ListDocumentClassificationJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
468
|
+
ListDocumentClassificationJobsRequest.struct_class = Types::ListDocumentClassificationJobsRequest
|
469
|
+
|
470
|
+
ListDocumentClassificationJobsResponse.add_member(:document_classification_job_properties_list, Shapes::ShapeRef.new(shape: DocumentClassificationJobPropertiesList, location_name: "DocumentClassificationJobPropertiesList"))
|
471
|
+
ListDocumentClassificationJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
472
|
+
ListDocumentClassificationJobsResponse.struct_class = Types::ListDocumentClassificationJobsResponse
|
473
|
+
|
474
|
+
ListDocumentClassifiersRequest.add_member(:filter, Shapes::ShapeRef.new(shape: DocumentClassifierFilter, location_name: "Filter"))
|
475
|
+
ListDocumentClassifiersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
476
|
+
ListDocumentClassifiersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
477
|
+
ListDocumentClassifiersRequest.struct_class = Types::ListDocumentClassifiersRequest
|
478
|
+
|
479
|
+
ListDocumentClassifiersResponse.add_member(:document_classifier_properties_list, Shapes::ShapeRef.new(shape: DocumentClassifierPropertiesList, location_name: "DocumentClassifierPropertiesList"))
|
480
|
+
ListDocumentClassifiersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
481
|
+
ListDocumentClassifiersResponse.struct_class = Types::ListDocumentClassifiersResponse
|
482
|
+
|
352
483
|
ListDominantLanguageDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: DominantLanguageDetectionJobFilter, location_name: "Filter"))
|
353
484
|
ListDominantLanguageDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
354
485
|
ListDominantLanguageDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -445,6 +576,18 @@ module Aws::Comprehend
|
|
445
576
|
SentimentScore.add_member(:mixed, Shapes::ShapeRef.new(shape: Float, location_name: "Mixed"))
|
446
577
|
SentimentScore.struct_class = Types::SentimentScore
|
447
578
|
|
579
|
+
StartDocumentClassificationJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
580
|
+
StartDocumentClassificationJobRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
|
581
|
+
StartDocumentClassificationJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
582
|
+
StartDocumentClassificationJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
583
|
+
StartDocumentClassificationJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
584
|
+
StartDocumentClassificationJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
585
|
+
StartDocumentClassificationJobRequest.struct_class = Types::StartDocumentClassificationJobRequest
|
586
|
+
|
587
|
+
StartDocumentClassificationJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
|
588
|
+
StartDocumentClassificationJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
589
|
+
StartDocumentClassificationJobResponse.struct_class = Types::StartDocumentClassificationJobResponse
|
590
|
+
|
448
591
|
StartDominantLanguageDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
449
592
|
StartDominantLanguageDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
450
593
|
StartDominantLanguageDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
@@ -643,6 +786,58 @@ module Aws::Comprehend
|
|
643
786
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
644
787
|
end)
|
645
788
|
|
789
|
+
api.add_operation(:create_document_classifier, Seahorse::Model::Operation.new.tap do |o|
|
790
|
+
o.name = "CreateDocumentClassifier"
|
791
|
+
o.http_method = "POST"
|
792
|
+
o.http_request_uri = "/"
|
793
|
+
o.input = Shapes::ShapeRef.new(shape: CreateDocumentClassifierRequest)
|
794
|
+
o.output = Shapes::ShapeRef.new(shape: CreateDocumentClassifierResponse)
|
795
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
796
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
797
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
798
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceLimitExceededException)
|
799
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
800
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
801
|
+
end)
|
802
|
+
|
803
|
+
api.add_operation(:delete_document_classifier, Seahorse::Model::Operation.new.tap do |o|
|
804
|
+
o.name = "DeleteDocumentClassifier"
|
805
|
+
o.http_method = "POST"
|
806
|
+
o.http_request_uri = "/"
|
807
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteDocumentClassifierRequest)
|
808
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteDocumentClassifierResponse)
|
809
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
810
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
811
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
812
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
813
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
814
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
815
|
+
end)
|
816
|
+
|
817
|
+
api.add_operation(:describe_document_classification_job, Seahorse::Model::Operation.new.tap do |o|
|
818
|
+
o.name = "DescribeDocumentClassificationJob"
|
819
|
+
o.http_method = "POST"
|
820
|
+
o.http_request_uri = "/"
|
821
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeDocumentClassificationJobRequest)
|
822
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeDocumentClassificationJobResponse)
|
823
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
824
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
825
|
+
o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
|
826
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
827
|
+
end)
|
828
|
+
|
829
|
+
api.add_operation(:describe_document_classifier, Seahorse::Model::Operation.new.tap do |o|
|
830
|
+
o.name = "DescribeDocumentClassifier"
|
831
|
+
o.http_method = "POST"
|
832
|
+
o.http_request_uri = "/"
|
833
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeDocumentClassifierRequest)
|
834
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeDocumentClassifierResponse)
|
835
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
836
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
837
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
838
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
839
|
+
end)
|
840
|
+
|
646
841
|
api.add_operation(:describe_dominant_language_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
647
842
|
o.name = "DescribeDominantLanguageDetectionJob"
|
648
843
|
o.http_method = "POST"
|
@@ -762,6 +957,30 @@ module Aws::Comprehend
|
|
762
957
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
763
958
|
end)
|
764
959
|
|
960
|
+
api.add_operation(:list_document_classification_jobs, Seahorse::Model::Operation.new.tap do |o|
|
961
|
+
o.name = "ListDocumentClassificationJobs"
|
962
|
+
o.http_method = "POST"
|
963
|
+
o.http_request_uri = "/"
|
964
|
+
o.input = Shapes::ShapeRef.new(shape: ListDocumentClassificationJobsRequest)
|
965
|
+
o.output = Shapes::ShapeRef.new(shape: ListDocumentClassificationJobsResponse)
|
966
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
967
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
968
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
969
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
970
|
+
end)
|
971
|
+
|
972
|
+
api.add_operation(:list_document_classifiers, Seahorse::Model::Operation.new.tap do |o|
|
973
|
+
o.name = "ListDocumentClassifiers"
|
974
|
+
o.http_method = "POST"
|
975
|
+
o.http_request_uri = "/"
|
976
|
+
o.input = Shapes::ShapeRef.new(shape: ListDocumentClassifiersRequest)
|
977
|
+
o.output = Shapes::ShapeRef.new(shape: ListDocumentClassifiersResponse)
|
978
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
979
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
980
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
981
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
982
|
+
end)
|
983
|
+
|
765
984
|
api.add_operation(:list_dominant_language_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
766
985
|
o.name = "ListDominantLanguageDetectionJobs"
|
767
986
|
o.http_method = "POST"
|
@@ -852,6 +1071,19 @@ module Aws::Comprehend
|
|
852
1071
|
)
|
853
1072
|
end)
|
854
1073
|
|
1074
|
+
api.add_operation(:start_document_classification_job, Seahorse::Model::Operation.new.tap do |o|
|
1075
|
+
o.name = "StartDocumentClassificationJob"
|
1076
|
+
o.http_method = "POST"
|
1077
|
+
o.http_request_uri = "/"
|
1078
|
+
o.input = Shapes::ShapeRef.new(shape: StartDocumentClassificationJobRequest)
|
1079
|
+
o.output = Shapes::ShapeRef.new(shape: StartDocumentClassificationJobResponse)
|
1080
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1081
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1082
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1083
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
1084
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1085
|
+
end)
|
1086
|
+
|
855
1087
|
api.add_operation(:start_dominant_language_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
856
1088
|
o.name = "StartDominantLanguageDetectionJob"
|
857
1089
|
o.http_method = "POST"
|
@@ -381,6 +381,227 @@ module Aws::Comprehend
|
|
381
381
|
include Aws::Structure
|
382
382
|
end
|
383
383
|
|
384
|
+
# Describes the result metrics for the test data associated with an
|
385
|
+
# documentation classifier.
|
386
|
+
#
|
387
|
+
# @!attribute [rw] accuracy
|
388
|
+
# The fraction of the labels that were correct recognized. It is
|
389
|
+
# computed by dividing the number of labels in the test documents that
|
390
|
+
# were correctly recognized by the total number of labels in the test
|
391
|
+
# documents.
|
392
|
+
# @return [Float]
|
393
|
+
#
|
394
|
+
# @!attribute [rw] precision
|
395
|
+
# A measure of the usefulness of the classifier results in the test
|
396
|
+
# data. High precision means that the classifier returned
|
397
|
+
# substantially more relevant results than irrelevant ones.
|
398
|
+
# @return [Float]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] recall
|
401
|
+
# A measure of how complete the classifier results are for the test
|
402
|
+
# data. High recall means that the classifier returned most of the
|
403
|
+
# relevant results.
|
404
|
+
# @return [Float]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] f1_score
|
407
|
+
# A measure of how accurate the classifier results are for the test
|
408
|
+
# data. It is derived from the `Precision` and `Recall` values. The
|
409
|
+
# `F1Score` is the harmonic average of the two scores. The highest
|
410
|
+
# score is 1, and the worst score is 0.
|
411
|
+
# @return [Float]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierEvaluationMetrics AWS API Documentation
|
414
|
+
#
|
415
|
+
class ClassifierEvaluationMetrics < Struct.new(
|
416
|
+
:accuracy,
|
417
|
+
:precision,
|
418
|
+
:recall,
|
419
|
+
:f1_score)
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
423
|
+
# Provides information about a document classifier.
|
424
|
+
#
|
425
|
+
# @!attribute [rw] number_of_labels
|
426
|
+
# The number of labels in the input data.
|
427
|
+
# @return [Integer]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] number_of_trained_documents
|
430
|
+
# The number of documents in the input data that were used to train
|
431
|
+
# the classifier. Typically this is 80 to 90 percent of the input
|
432
|
+
# documents.
|
433
|
+
# @return [Integer]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] number_of_test_documents
|
436
|
+
# The number of documents in the input data that were used to test the
|
437
|
+
# classifier. Typically this is 10 to 20 percent of the input
|
438
|
+
# documents.
|
439
|
+
# @return [Integer]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] evaluation_metrics
|
442
|
+
# Describes the result metrics for the test data associated with an
|
443
|
+
# documentation classifier.
|
444
|
+
# @return [Types::ClassifierEvaluationMetrics]
|
445
|
+
#
|
446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierMetadata AWS API Documentation
|
447
|
+
#
|
448
|
+
class ClassifierMetadata < Struct.new(
|
449
|
+
:number_of_labels,
|
450
|
+
:number_of_trained_documents,
|
451
|
+
:number_of_test_documents,
|
452
|
+
:evaluation_metrics)
|
453
|
+
include Aws::Structure
|
454
|
+
end
|
455
|
+
|
456
|
+
# @note When making an API call, you may pass CreateDocumentClassifierRequest
|
457
|
+
# data as a hash:
|
458
|
+
#
|
459
|
+
# {
|
460
|
+
# document_classifier_name: "ComprehendArnName", # required
|
461
|
+
# data_access_role_arn: "IamRoleArn", # required
|
462
|
+
# input_data_config: { # required
|
463
|
+
# s3_uri: "S3Uri", # required
|
464
|
+
# },
|
465
|
+
# client_request_token: "ClientRequestTokenString",
|
466
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
467
|
+
# }
|
468
|
+
#
|
469
|
+
# @!attribute [rw] document_classifier_name
|
470
|
+
# The name of the document classifier.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] data_access_role_arn
|
474
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
475
|
+
# (IAM) role that grants Amazon Comprehend read access to your input
|
476
|
+
# data.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] input_data_config
|
480
|
+
# Specifies the format and location of the input data for the job.
|
481
|
+
# @return [Types::DocumentClassifierInputDataConfig]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] client_request_token
|
484
|
+
# A unique identifier for the request. If you don't set the client
|
485
|
+
# request token, Amazon Comprehend generates one.
|
486
|
+
#
|
487
|
+
# **A suitable default value is auto-generated.** You should normally
|
488
|
+
# not need to pass this option.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] language_code
|
492
|
+
# The language of the input documents. You can create a document
|
493
|
+
# classifier in any of the languages supported by Amazon Comprehend.
|
494
|
+
# However, all documents must be in the same language.
|
495
|
+
# @return [String]
|
496
|
+
#
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
|
498
|
+
#
|
499
|
+
class CreateDocumentClassifierRequest < Struct.new(
|
500
|
+
:document_classifier_name,
|
501
|
+
:data_access_role_arn,
|
502
|
+
:input_data_config,
|
503
|
+
:client_request_token,
|
504
|
+
:language_code)
|
505
|
+
include Aws::Structure
|
506
|
+
end
|
507
|
+
|
508
|
+
# @!attribute [rw] document_classifier_arn
|
509
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
510
|
+
# classifier.
|
511
|
+
# @return [String]
|
512
|
+
#
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierResponse AWS API Documentation
|
514
|
+
#
|
515
|
+
class CreateDocumentClassifierResponse < Struct.new(
|
516
|
+
:document_classifier_arn)
|
517
|
+
include Aws::Structure
|
518
|
+
end
|
519
|
+
|
520
|
+
# @note When making an API call, you may pass DeleteDocumentClassifierRequest
|
521
|
+
# data as a hash:
|
522
|
+
#
|
523
|
+
# {
|
524
|
+
# document_classifier_arn: "DocumentClassifierArn", # required
|
525
|
+
# }
|
526
|
+
#
|
527
|
+
# @!attribute [rw] document_classifier_arn
|
528
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
529
|
+
# classifier.
|
530
|
+
# @return [String]
|
531
|
+
#
|
532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteDocumentClassifierRequest AWS API Documentation
|
533
|
+
#
|
534
|
+
class DeleteDocumentClassifierRequest < Struct.new(
|
535
|
+
:document_classifier_arn)
|
536
|
+
include Aws::Structure
|
537
|
+
end
|
538
|
+
|
539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteDocumentClassifierResponse AWS API Documentation
|
540
|
+
#
|
541
|
+
class DeleteDocumentClassifierResponse < Aws::EmptyStructure; end
|
542
|
+
|
543
|
+
# @note When making an API call, you may pass DescribeDocumentClassificationJobRequest
|
544
|
+
# data as a hash:
|
545
|
+
#
|
546
|
+
# {
|
547
|
+
# job_id: "JobId", # required
|
548
|
+
# }
|
549
|
+
#
|
550
|
+
# @!attribute [rw] job_id
|
551
|
+
# The identifier that Amazon Comprehend generated for the job. The
|
552
|
+
# operation returns this identifier in its response.
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJobRequest AWS API Documentation
|
556
|
+
#
|
557
|
+
class DescribeDocumentClassificationJobRequest < Struct.new(
|
558
|
+
:job_id)
|
559
|
+
include Aws::Structure
|
560
|
+
end
|
561
|
+
|
562
|
+
# @!attribute [rw] document_classification_job_properties
|
563
|
+
# An object that describes the properties associated with the document
|
564
|
+
# classification job.
|
565
|
+
# @return [Types::DocumentClassificationJobProperties]
|
566
|
+
#
|
567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJobResponse AWS API Documentation
|
568
|
+
#
|
569
|
+
class DescribeDocumentClassificationJobResponse < Struct.new(
|
570
|
+
:document_classification_job_properties)
|
571
|
+
include Aws::Structure
|
572
|
+
end
|
573
|
+
|
574
|
+
# @note When making an API call, you may pass DescribeDocumentClassifierRequest
|
575
|
+
# data as a hash:
|
576
|
+
#
|
577
|
+
# {
|
578
|
+
# document_classifier_arn: "DocumentClassifierArn", # required
|
579
|
+
# }
|
580
|
+
#
|
581
|
+
# @!attribute [rw] document_classifier_arn
|
582
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
583
|
+
# classifier. The operation returns this identifier in its response.
|
584
|
+
# @return [String]
|
585
|
+
#
|
586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifierRequest AWS API Documentation
|
587
|
+
#
|
588
|
+
class DescribeDocumentClassifierRequest < Struct.new(
|
589
|
+
:document_classifier_arn)
|
590
|
+
include Aws::Structure
|
591
|
+
end
|
592
|
+
|
593
|
+
# @!attribute [rw] document_classifier_properties
|
594
|
+
# An object that contains the properties associated with a document
|
595
|
+
# classifier.
|
596
|
+
# @return [Types::DocumentClassifierProperties]
|
597
|
+
#
|
598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifierResponse AWS API Documentation
|
599
|
+
#
|
600
|
+
class DescribeDocumentClassifierResponse < Struct.new(
|
601
|
+
:document_classifier_properties)
|
602
|
+
include Aws::Structure
|
603
|
+
end
|
604
|
+
|
384
605
|
# @note When making an API call, you may pass DescribeDominantLanguageDetectionJobRequest
|
385
606
|
# data as a hash:
|
386
607
|
#
|
@@ -743,6 +964,267 @@ module Aws::Comprehend
|
|
743
964
|
include Aws::Structure
|
744
965
|
end
|
745
966
|
|
967
|
+
# Provides information for filtering a list of document classification
|
968
|
+
# jobs. For more information, see the operation. You can provide only
|
969
|
+
# one filter parameter in each request.
|
970
|
+
#
|
971
|
+
# @note When making an API call, you may pass DocumentClassificationJobFilter
|
972
|
+
# data as a hash:
|
973
|
+
#
|
974
|
+
# {
|
975
|
+
# job_name: "JobName",
|
976
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
977
|
+
# submit_time_before: Time.now,
|
978
|
+
# submit_time_after: Time.now,
|
979
|
+
# }
|
980
|
+
#
|
981
|
+
# @!attribute [rw] job_name
|
982
|
+
# Filters on the name of the job.
|
983
|
+
# @return [String]
|
984
|
+
#
|
985
|
+
# @!attribute [rw] job_status
|
986
|
+
# Filters the list based on job status. Returns only jobs with the
|
987
|
+
# specified status.
|
988
|
+
# @return [String]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] submit_time_before
|
991
|
+
# Filters the list of jobs based on the time that the job was
|
992
|
+
# submitted for processing. Returns only jobs submitted after the
|
993
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
994
|
+
# newest.
|
995
|
+
# @return [Time]
|
996
|
+
#
|
997
|
+
# @!attribute [rw] submit_time_after
|
998
|
+
# Filters the list of jobs based on the time that the job was
|
999
|
+
# submitted for processing. Returns only jobs submitted before the
|
1000
|
+
# specified time. Jobs are returned in descending order, newest to
|
1001
|
+
# oldest.
|
1002
|
+
# @return [Time]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobFilter AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class DocumentClassificationJobFilter < Struct.new(
|
1007
|
+
:job_name,
|
1008
|
+
:job_status,
|
1009
|
+
:submit_time_before,
|
1010
|
+
:submit_time_after)
|
1011
|
+
include Aws::Structure
|
1012
|
+
end
|
1013
|
+
|
1014
|
+
# Provides information about a document classification job.
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] job_id
|
1017
|
+
# The identifier assigned to the document classification job.
|
1018
|
+
# @return [String]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] job_name
|
1021
|
+
# The name that you assigned to the document classification job.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] job_status
|
1025
|
+
# The current status of the document classification job. If the status
|
1026
|
+
# is `FAILED`, the `Message` field shows the reason for the failure.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] message
|
1030
|
+
# A description of the status of the job.
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @!attribute [rw] submit_time
|
1034
|
+
# The time that the document classification job was submitted for
|
1035
|
+
# processing.
|
1036
|
+
# @return [Time]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] end_time
|
1039
|
+
# The time that the document classification job completed.
|
1040
|
+
# @return [Time]
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] document_classifier_arn
|
1043
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
1044
|
+
# classifier.
|
1045
|
+
# @return [String]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] input_data_config
|
1048
|
+
# The input data configuration that you supplied when you created the
|
1049
|
+
# document classification job.
|
1050
|
+
# @return [Types::InputDataConfig]
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] output_data_config
|
1053
|
+
# The output data configuration that you supplied when you created the
|
1054
|
+
# document classification job.
|
1055
|
+
# @return [Types::OutputDataConfig]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] data_access_role_arn
|
1058
|
+
# The Amazon Resource Name (ARN) of the AWS identity and Access
|
1059
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1060
|
+
# your input data.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation
|
1064
|
+
#
|
1065
|
+
class DocumentClassificationJobProperties < Struct.new(
|
1066
|
+
:job_id,
|
1067
|
+
:job_name,
|
1068
|
+
:job_status,
|
1069
|
+
:message,
|
1070
|
+
:submit_time,
|
1071
|
+
:end_time,
|
1072
|
+
:document_classifier_arn,
|
1073
|
+
:input_data_config,
|
1074
|
+
:output_data_config,
|
1075
|
+
:data_access_role_arn)
|
1076
|
+
include Aws::Structure
|
1077
|
+
end
|
1078
|
+
|
1079
|
+
# Provides information for filtering a list of document classifiers. You
|
1080
|
+
# can only specify one filtering parameter in a request. For more
|
1081
|
+
# information, see the operation.
|
1082
|
+
#
|
1083
|
+
# @note When making an API call, you may pass DocumentClassifierFilter
|
1084
|
+
# data as a hash:
|
1085
|
+
#
|
1086
|
+
# {
|
1087
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
|
1088
|
+
# submit_time_before: Time.now,
|
1089
|
+
# submit_time_after: Time.now,
|
1090
|
+
# }
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] status
|
1093
|
+
# Filters the list of classifiers based on status.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] submit_time_before
|
1097
|
+
# Filters the list of classifiers based on the time that the
|
1098
|
+
# classifier was submitted for processing. Returns only classifiers
|
1099
|
+
# submitted before the specified time. Classifiers are returned in
|
1100
|
+
# ascending order, oldest to newest.
|
1101
|
+
# @return [Time]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] submit_time_after
|
1104
|
+
# Filters the list of classifiers based on the time that the
|
1105
|
+
# classifier was submitted for processing. Returns only classifiers
|
1106
|
+
# submitted after the specified time. Classifiers are returned in
|
1107
|
+
# descending order, newest to oldest.
|
1108
|
+
# @return [Time]
|
1109
|
+
#
|
1110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierFilter AWS API Documentation
|
1111
|
+
#
|
1112
|
+
class DocumentClassifierFilter < Struct.new(
|
1113
|
+
:status,
|
1114
|
+
:submit_time_before,
|
1115
|
+
:submit_time_after)
|
1116
|
+
include Aws::Structure
|
1117
|
+
end
|
1118
|
+
|
1119
|
+
# The input properties for training a document classifier.
|
1120
|
+
#
|
1121
|
+
# For more information on how the input file is formatted, see
|
1122
|
+
# how-document-classification-training-data.
|
1123
|
+
#
|
1124
|
+
# @note When making an API call, you may pass DocumentClassifierInputDataConfig
|
1125
|
+
# data as a hash:
|
1126
|
+
#
|
1127
|
+
# {
|
1128
|
+
# s3_uri: "S3Uri", # required
|
1129
|
+
# }
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] s3_uri
|
1132
|
+
# The Amazon S3 URI for the input data. The S3 bucket must be in the
|
1133
|
+
# same region as the API endpoint that you are calling. The URI can
|
1134
|
+
# point to a single input file or it can provide the prefix for a
|
1135
|
+
# collection of input files.
|
1136
|
+
#
|
1137
|
+
# For example, if you use the URI `S3://bucketName/prefix`, if the
|
1138
|
+
# prefix is a single file, Amazon Comprehend uses that file as input.
|
1139
|
+
# If more than one file begins with the prefix, Amazon Comprehend uses
|
1140
|
+
# all of them as input.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class DocumentClassifierInputDataConfig < Struct.new(
|
1146
|
+
:s3_uri)
|
1147
|
+
include Aws::Structure
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# Provides information about a document classifier.
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] document_classifier_arn
|
1153
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
1154
|
+
# classifier.
|
1155
|
+
# @return [String]
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] language_code
|
1158
|
+
# The language code for the language of the documents that the
|
1159
|
+
# classifier was trained on.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] status
|
1163
|
+
# The status of the document classifier. The the status is `TRAINED`
|
1164
|
+
# the classifier is ready to use. If the status is `FAILED` you can
|
1165
|
+
# see additional information about why the classifier wasn't trained
|
1166
|
+
# in the `Message` field.
|
1167
|
+
# @return [String]
|
1168
|
+
#
|
1169
|
+
# @!attribute [rw] message
|
1170
|
+
# Additional information about the status of the classifier.
|
1171
|
+
# @return [String]
|
1172
|
+
#
|
1173
|
+
# @!attribute [rw] submit_time
|
1174
|
+
# The time that the document classifier was submitted for training.
|
1175
|
+
# @return [Time]
|
1176
|
+
#
|
1177
|
+
# @!attribute [rw] end_time
|
1178
|
+
# The time that training the document classifier completed.
|
1179
|
+
# @return [Time]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] training_start_time
|
1182
|
+
# Indicates the time when the training starts on documentation
|
1183
|
+
# classifiers. You are billed for the time interval between this time
|
1184
|
+
# and the value of TrainingEndTime.
|
1185
|
+
# @return [Time]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] training_end_time
|
1188
|
+
# The time that training of the document classifier was completed.
|
1189
|
+
# Indicates the time when the training completes on documentation
|
1190
|
+
# classifiers. You are billed for the time interval between this time
|
1191
|
+
# and the value of TrainingStartTime.
|
1192
|
+
# @return [Time]
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] input_data_config
|
1195
|
+
# The input data configuration that you supplied when you created the
|
1196
|
+
# document classifier for training.
|
1197
|
+
# @return [Types::DocumentClassifierInputDataConfig]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] classifier_metadata
|
1200
|
+
# Information about the document classifier, including the number of
|
1201
|
+
# documents used for training the classifier, the number of documents
|
1202
|
+
# used for test the classifier, and an accuracy rating.
|
1203
|
+
# @return [Types::ClassifierMetadata]
|
1204
|
+
#
|
1205
|
+
# @!attribute [rw] data_access_role_arn
|
1206
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
1207
|
+
# (IAM) role that grants Amazon Comprehend read access to your input
|
1208
|
+
# data.
|
1209
|
+
# @return [String]
|
1210
|
+
#
|
1211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
1212
|
+
#
|
1213
|
+
class DocumentClassifierProperties < Struct.new(
|
1214
|
+
:document_classifier_arn,
|
1215
|
+
:language_code,
|
1216
|
+
:status,
|
1217
|
+
:message,
|
1218
|
+
:submit_time,
|
1219
|
+
:end_time,
|
1220
|
+
:training_start_time,
|
1221
|
+
:training_end_time,
|
1222
|
+
:input_data_config,
|
1223
|
+
:classifier_metadata,
|
1224
|
+
:data_access_role_arn)
|
1225
|
+
include Aws::Structure
|
1226
|
+
end
|
1227
|
+
|
746
1228
|
# Returns the code for the dominant language in the input text and the
|
747
1229
|
# level of confidence that Amazon Comprehend has in the accuracy of the
|
748
1230
|
# detection.
|
@@ -1216,6 +1698,113 @@ module Aws::Comprehend
|
|
1216
1698
|
include Aws::Structure
|
1217
1699
|
end
|
1218
1700
|
|
1701
|
+
# @note When making an API call, you may pass ListDocumentClassificationJobsRequest
|
1702
|
+
# data as a hash:
|
1703
|
+
#
|
1704
|
+
# {
|
1705
|
+
# filter: {
|
1706
|
+
# job_name: "JobName",
|
1707
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
1708
|
+
# submit_time_before: Time.now,
|
1709
|
+
# submit_time_after: Time.now,
|
1710
|
+
# },
|
1711
|
+
# next_token: "String",
|
1712
|
+
# max_results: 1,
|
1713
|
+
# }
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] filter
|
1716
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
1717
|
+
# names, status, or the date and time that they were submitted. You
|
1718
|
+
# can only set one filter at a time.
|
1719
|
+
# @return [Types::DocumentClassificationJobFilter]
|
1720
|
+
#
|
1721
|
+
# @!attribute [rw] next_token
|
1722
|
+
# Identifies the next page of results to return.
|
1723
|
+
# @return [String]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] max_results
|
1726
|
+
# The maximum number of results to return in each page. The default is
|
1727
|
+
# 100.
|
1728
|
+
# @return [Integer]
|
1729
|
+
#
|
1730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobsRequest AWS API Documentation
|
1731
|
+
#
|
1732
|
+
class ListDocumentClassificationJobsRequest < Struct.new(
|
1733
|
+
:filter,
|
1734
|
+
:next_token,
|
1735
|
+
:max_results)
|
1736
|
+
include Aws::Structure
|
1737
|
+
end
|
1738
|
+
|
1739
|
+
# @!attribute [rw] document_classification_job_properties_list
|
1740
|
+
# A list containing the properties of each job returned.
|
1741
|
+
# @return [Array<Types::DocumentClassificationJobProperties>]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] next_token
|
1744
|
+
# Identifies the next page of results to return.
|
1745
|
+
# @return [String]
|
1746
|
+
#
|
1747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobsResponse AWS API Documentation
|
1748
|
+
#
|
1749
|
+
class ListDocumentClassificationJobsResponse < Struct.new(
|
1750
|
+
:document_classification_job_properties_list,
|
1751
|
+
:next_token)
|
1752
|
+
include Aws::Structure
|
1753
|
+
end
|
1754
|
+
|
1755
|
+
# @note When making an API call, you may pass ListDocumentClassifiersRequest
|
1756
|
+
# data as a hash:
|
1757
|
+
#
|
1758
|
+
# {
|
1759
|
+
# filter: {
|
1760
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
|
1761
|
+
# submit_time_before: Time.now,
|
1762
|
+
# submit_time_after: Time.now,
|
1763
|
+
# },
|
1764
|
+
# next_token: "String",
|
1765
|
+
# max_results: 1,
|
1766
|
+
# }
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] filter
|
1769
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
1770
|
+
# name, status, or the date and time that they were submitted. You can
|
1771
|
+
# only set one filter at a time.
|
1772
|
+
# @return [Types::DocumentClassifierFilter]
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] next_token
|
1775
|
+
# Identifies the next page of results to return.
|
1776
|
+
# @return [String]
|
1777
|
+
#
|
1778
|
+
# @!attribute [rw] max_results
|
1779
|
+
# The maximum number of results to return in each page. The default is
|
1780
|
+
# 100.
|
1781
|
+
# @return [Integer]
|
1782
|
+
#
|
1783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiersRequest AWS API Documentation
|
1784
|
+
#
|
1785
|
+
class ListDocumentClassifiersRequest < Struct.new(
|
1786
|
+
:filter,
|
1787
|
+
:next_token,
|
1788
|
+
:max_results)
|
1789
|
+
include Aws::Structure
|
1790
|
+
end
|
1791
|
+
|
1792
|
+
# @!attribute [rw] document_classifier_properties_list
|
1793
|
+
# A list containing the properties of each job returned.
|
1794
|
+
# @return [Array<Types::DocumentClassifierProperties>]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] next_token
|
1797
|
+
# Identifies the next page of results to return.
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiersResponse AWS API Documentation
|
1801
|
+
#
|
1802
|
+
class ListDocumentClassifiersResponse < Struct.new(
|
1803
|
+
:document_classifier_properties_list,
|
1804
|
+
:next_token)
|
1805
|
+
include Aws::Structure
|
1806
|
+
end
|
1807
|
+
|
1219
1808
|
# @note When making an API call, you may pass ListDominantLanguageDetectionJobsRequest
|
1220
1809
|
# data as a hash:
|
1221
1810
|
#
|
@@ -1680,6 +2269,97 @@ module Aws::Comprehend
|
|
1680
2269
|
include Aws::Structure
|
1681
2270
|
end
|
1682
2271
|
|
2272
|
+
# @note When making an API call, you may pass StartDocumentClassificationJobRequest
|
2273
|
+
# data as a hash:
|
2274
|
+
#
|
2275
|
+
# {
|
2276
|
+
# job_name: "JobName",
|
2277
|
+
# document_classifier_arn: "DocumentClassifierArn", # required
|
2278
|
+
# input_data_config: { # required
|
2279
|
+
# s3_uri: "S3Uri", # required
|
2280
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2281
|
+
# },
|
2282
|
+
# output_data_config: { # required
|
2283
|
+
# s3_uri: "S3Uri", # required
|
2284
|
+
# },
|
2285
|
+
# data_access_role_arn: "IamRoleArn", # required
|
2286
|
+
# client_request_token: "ClientRequestTokenString",
|
2287
|
+
# }
|
2288
|
+
#
|
2289
|
+
# @!attribute [rw] job_name
|
2290
|
+
# The identifier of the job.
|
2291
|
+
# @return [String]
|
2292
|
+
#
|
2293
|
+
# @!attribute [rw] document_classifier_arn
|
2294
|
+
# The Amazon Resource Name (ARN) of the document classifier to use to
|
2295
|
+
# process the job.
|
2296
|
+
# @return [String]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] input_data_config
|
2299
|
+
# Specifies the format and location of the input data for the job.
|
2300
|
+
# @return [Types::InputDataConfig]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] output_data_config
|
2303
|
+
# Specifies where to send the output files.
|
2304
|
+
# @return [Types::OutputDataConfig]
|
2305
|
+
#
|
2306
|
+
# @!attribute [rw] data_access_role_arn
|
2307
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2308
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
2309
|
+
# your input data.
|
2310
|
+
# @return [String]
|
2311
|
+
#
|
2312
|
+
# @!attribute [rw] client_request_token
|
2313
|
+
# A unique identifier for the request. If you do not set the client
|
2314
|
+
# request token, Amazon Comprehend generates one.
|
2315
|
+
#
|
2316
|
+
# **A suitable default value is auto-generated.** You should normally
|
2317
|
+
# not need to pass this option.
|
2318
|
+
# @return [String]
|
2319
|
+
#
|
2320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobRequest AWS API Documentation
|
2321
|
+
#
|
2322
|
+
class StartDocumentClassificationJobRequest < Struct.new(
|
2323
|
+
:job_name,
|
2324
|
+
:document_classifier_arn,
|
2325
|
+
:input_data_config,
|
2326
|
+
:output_data_config,
|
2327
|
+
:data_access_role_arn,
|
2328
|
+
:client_request_token)
|
2329
|
+
include Aws::Structure
|
2330
|
+
end
|
2331
|
+
|
2332
|
+
# @!attribute [rw] job_id
|
2333
|
+
# The identifier generated for the job. To get the status of the job,
|
2334
|
+
# use this identifier with the operation.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] job_status
|
2338
|
+
# The status of the job:
|
2339
|
+
#
|
2340
|
+
# * SUBMITTED - The job has been received and queued for processing.
|
2341
|
+
#
|
2342
|
+
# * IN\_PROGRESS - Amazon Comprehend is processing the job.
|
2343
|
+
#
|
2344
|
+
# * COMPLETED - The job was successfully completed and the output is
|
2345
|
+
# available.
|
2346
|
+
#
|
2347
|
+
# * FAILED - The job did not complete. For details, use the operation.
|
2348
|
+
#
|
2349
|
+
# * STOP\_REQUESTED - Amazon Comprehend has received a stop request
|
2350
|
+
# for the job and is processing the request.
|
2351
|
+
#
|
2352
|
+
# * STOPPED - The job was successfully stopped without completing.
|
2353
|
+
# @return [String]
|
2354
|
+
#
|
2355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobResponse AWS API Documentation
|
2356
|
+
#
|
2357
|
+
class StartDocumentClassificationJobResponse < Struct.new(
|
2358
|
+
:job_id,
|
2359
|
+
:job_status)
|
2360
|
+
include Aws::Structure
|
2361
|
+
end
|
2362
|
+
|
1683
2363
|
# @note When making an API call, you may pass StartDominantLanguageDetectionJobRequest
|
1684
2364
|
# data as a hash:
|
1685
2365
|
#
|
@@ -1807,9 +2487,12 @@ module Aws::Comprehend
|
|
1807
2487
|
# @return [String]
|
1808
2488
|
#
|
1809
2489
|
# @!attribute [rw] language_code
|
1810
|
-
# The language of the input documents.
|
1811
|
-
#
|
1812
|
-
#
|
2490
|
+
# The language of the input documents. All documents must be in the
|
2491
|
+
# same language. You can specify any of the languages supported by
|
2492
|
+
# Amazon Comprehend: English ("en"), Spanish ("es"), French
|
2493
|
+
# ("fr"), German ("de"), Italian ("it"), or Portuguese ("pt").
|
2494
|
+
# If custom entities recognition is used, this parameter is ignored
|
2495
|
+
# and the language used for training the model is used instead.
|
1813
2496
|
# @return [String]
|
1814
2497
|
#
|
1815
2498
|
# @!attribute [rw] client_request_token
|
@@ -1850,6 +2533,11 @@ module Aws::Comprehend
|
|
1850
2533
|
#
|
1851
2534
|
# * FAILED - The job did not complete. To get details, use the
|
1852
2535
|
# operation.
|
2536
|
+
#
|
2537
|
+
# * STOP\_REQUESTED - Amazon Comprehend has received a stop request
|
2538
|
+
# for the job and is processing the request.
|
2539
|
+
#
|
2540
|
+
# * STOPPED - The job was successfully stopped without completing.
|
1853
2541
|
# @return [String]
|
1854
2542
|
#
|
1855
2543
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobResponse AWS API Documentation
|