aws-sdk-comprehend 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cd9ad15894dced2706c3ce2ae8b23ea903ac1cb7
|
4
|
+
data.tar.gz: 823a4f1a945eda3ef939990157b7a537fcc26f73
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: beab4f97a67447b08fc079554f6ccdeb738f2b621c8478635e7c0905c55b8668924a96018c20ce1a13670d65d525973a1e46383ce8d83b68a23431f797c7ac1f
|
7
|
+
data.tar.gz: a2af7825f335db67a1821f82ad959d9b1a4f266d243908557b0015cff703440fbed5163f23969f3b1aacdd01df1e2c86dd625674178e0aba80455fc794535853
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -15,6 +15,7 @@ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
|
15
15
|
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
16
|
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
17
|
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
18
19
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
20
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
21
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
@@ -45,6 +46,7 @@ module Aws::Comprehend
|
|
45
46
|
add_plugin(Aws::Plugins::RetryErrors)
|
46
47
|
add_plugin(Aws::Plugins::GlobalConfiguration)
|
47
48
|
add_plugin(Aws::Plugins::RegionalEndpoint)
|
49
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
48
50
|
add_plugin(Aws::Plugins::ResponsePaging)
|
49
51
|
add_plugin(Aws::Plugins::StubResponses)
|
50
52
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
@@ -98,6 +100,10 @@ module Aws::Comprehend
|
|
98
100
|
#
|
99
101
|
# @option options [String] :access_key_id
|
100
102
|
#
|
103
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
104
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
105
|
+
# the background every 60 secs (default). Defaults to `false`.
|
106
|
+
#
|
101
107
|
# @option options [Boolean] :client_side_monitoring (false)
|
102
108
|
# When `true`, client-side metrics will be collected for all API requests from
|
103
109
|
# this client.
|
@@ -123,6 +129,21 @@ module Aws::Comprehend
|
|
123
129
|
# option. You should only configure an `:endpoint` when connecting
|
124
130
|
# to test endpoints. This should be avalid HTTP(S) URI.
|
125
131
|
#
|
132
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
133
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
134
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
135
|
+
#
|
136
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
137
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
138
|
+
#
|
139
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
140
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
141
|
+
# Use this option to config the time interval in seconds for making
|
142
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
143
|
+
#
|
144
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
145
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
146
|
+
#
|
126
147
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
127
148
|
# The log formatter.
|
128
149
|
#
|
@@ -411,7 +432,7 @@ module Aws::Comprehend
|
|
411
432
|
# resp.result_list[0].syntax_tokens[0].text #=> String
|
412
433
|
# resp.result_list[0].syntax_tokens[0].begin_offset #=> Integer
|
413
434
|
# resp.result_list[0].syntax_tokens[0].end_offset #=> Integer
|
414
|
-
# resp.result_list[0].syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
|
435
|
+
# resp.result_list[0].syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "CCONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
|
415
436
|
# resp.result_list[0].syntax_tokens[0].part_of_speech.score #=> Float
|
416
437
|
# resp.error_list #=> Array
|
417
438
|
# resp.error_list[0].index #=> Integer
|
@@ -427,6 +448,181 @@ module Aws::Comprehend
|
|
427
448
|
req.send_request(options)
|
428
449
|
end
|
429
450
|
|
451
|
+
# Creates a new document classifier that you can use to categorize
|
452
|
+
# documents. To create a classifier you provide a set of training
|
453
|
+
# documents that are labeled with the categories that you want to use.
|
454
|
+
# After the classifier is trained you can use it to categorize a set of
|
455
|
+
# unlabeled documents into those categories.
|
456
|
+
#
|
457
|
+
# @option params [required, String] :document_classifier_name
|
458
|
+
# The name of the document classifier.
|
459
|
+
#
|
460
|
+
# @option params [required, String] :data_access_role_arn
|
461
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
462
|
+
# (IAM) role that grants Amazon Comprehend read access to your input
|
463
|
+
# data.
|
464
|
+
#
|
465
|
+
# @option params [required, Types::DocumentClassifierInputDataConfig] :input_data_config
|
466
|
+
# Specifies the format and location of the input data for the job.
|
467
|
+
#
|
468
|
+
# @option params [String] :client_request_token
|
469
|
+
# A unique identifier for the request. If you don't set the client
|
470
|
+
# request token, Amazon Comprehend generates one.
|
471
|
+
#
|
472
|
+
# **A suitable default value is auto-generated.** You should normally
|
473
|
+
# not need to pass this option.**
|
474
|
+
#
|
475
|
+
# @option params [required, String] :language_code
|
476
|
+
# The language of the input documents. You can create a document
|
477
|
+
# classifier in any of the languages supported by Amazon Comprehend.
|
478
|
+
# However, all documents must be in the same language.
|
479
|
+
#
|
480
|
+
# @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
481
|
+
#
|
482
|
+
# * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
|
483
|
+
#
|
484
|
+
# @example Request syntax with placeholder values
|
485
|
+
#
|
486
|
+
# resp = client.create_document_classifier({
|
487
|
+
# document_classifier_name: "ComprehendArnName", # required
|
488
|
+
# data_access_role_arn: "IamRoleArn", # required
|
489
|
+
# input_data_config: { # required
|
490
|
+
# s3_uri: "S3Uri", # required
|
491
|
+
# },
|
492
|
+
# client_request_token: "ClientRequestTokenString",
|
493
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
494
|
+
# })
|
495
|
+
#
|
496
|
+
# @example Response structure
|
497
|
+
#
|
498
|
+
# resp.document_classifier_arn #=> String
|
499
|
+
#
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifier AWS API Documentation
|
501
|
+
#
|
502
|
+
# @overload create_document_classifier(params = {})
|
503
|
+
# @param [Hash] params ({})
|
504
|
+
def create_document_classifier(params = {}, options = {})
|
505
|
+
req = build_request(:create_document_classifier, params)
|
506
|
+
req.send_request(options)
|
507
|
+
end
|
508
|
+
|
509
|
+
# Deletes a previously created document classifier
|
510
|
+
#
|
511
|
+
# Only those classifiers that are in terminated states (IN\_ERROR,
|
512
|
+
# TRAINED) will be deleted. If an active inference job is using the
|
513
|
+
# model, a `ResourceInUseException` will be returned.
|
514
|
+
#
|
515
|
+
# This is an asynchronous action that puts the classifier into a
|
516
|
+
# DELETING state, and it is then removed by a background job. Once
|
517
|
+
# removed, the classifier disappears from your account and is no longer
|
518
|
+
# available for use.
|
519
|
+
#
|
520
|
+
# @option params [required, String] :document_classifier_arn
|
521
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
522
|
+
# classifier.
|
523
|
+
#
|
524
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
525
|
+
#
|
526
|
+
# @example Request syntax with placeholder values
|
527
|
+
#
|
528
|
+
# resp = client.delete_document_classifier({
|
529
|
+
# document_classifier_arn: "DocumentClassifierArn", # required
|
530
|
+
# })
|
531
|
+
#
|
532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteDocumentClassifier AWS API Documentation
|
533
|
+
#
|
534
|
+
# @overload delete_document_classifier(params = {})
|
535
|
+
# @param [Hash] params ({})
|
536
|
+
def delete_document_classifier(params = {}, options = {})
|
537
|
+
req = build_request(:delete_document_classifier, params)
|
538
|
+
req.send_request(options)
|
539
|
+
end
|
540
|
+
|
541
|
+
# Gets the properties associated with a document classification job. Use
|
542
|
+
# this operation to get the status of a classification job.
|
543
|
+
#
|
544
|
+
# @option params [required, String] :job_id
|
545
|
+
# The identifier that Amazon Comprehend generated for the job. The
|
546
|
+
# operation returns this identifier in its response.
|
547
|
+
#
|
548
|
+
# @return [Types::DescribeDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
549
|
+
#
|
550
|
+
# * {Types::DescribeDocumentClassificationJobResponse#document_classification_job_properties #document_classification_job_properties} => Types::DocumentClassificationJobProperties
|
551
|
+
#
|
552
|
+
# @example Request syntax with placeholder values
|
553
|
+
#
|
554
|
+
# resp = client.describe_document_classification_job({
|
555
|
+
# job_id: "JobId", # required
|
556
|
+
# })
|
557
|
+
#
|
558
|
+
# @example Response structure
|
559
|
+
#
|
560
|
+
# resp.document_classification_job_properties.job_id #=> String
|
561
|
+
# resp.document_classification_job_properties.job_name #=> String
|
562
|
+
# resp.document_classification_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
563
|
+
# resp.document_classification_job_properties.message #=> String
|
564
|
+
# resp.document_classification_job_properties.submit_time #=> Time
|
565
|
+
# resp.document_classification_job_properties.end_time #=> Time
|
566
|
+
# resp.document_classification_job_properties.document_classifier_arn #=> String
|
567
|
+
# resp.document_classification_job_properties.input_data_config.s3_uri #=> String
|
568
|
+
# resp.document_classification_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
569
|
+
# resp.document_classification_job_properties.output_data_config.s3_uri #=> String
|
570
|
+
# resp.document_classification_job_properties.data_access_role_arn #=> String
|
571
|
+
#
|
572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob AWS API Documentation
|
573
|
+
#
|
574
|
+
# @overload describe_document_classification_job(params = {})
|
575
|
+
# @param [Hash] params ({})
|
576
|
+
def describe_document_classification_job(params = {}, options = {})
|
577
|
+
req = build_request(:describe_document_classification_job, params)
|
578
|
+
req.send_request(options)
|
579
|
+
end
|
580
|
+
|
581
|
+
# Gets the properties associated with a document classifier.
|
582
|
+
#
|
583
|
+
# @option params [required, String] :document_classifier_arn
|
584
|
+
# The Amazon Resource Name (ARN) that identifies the document
|
585
|
+
# classifier. The operation returns this identifier in its response.
|
586
|
+
#
|
587
|
+
# @return [Types::DescribeDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
588
|
+
#
|
589
|
+
# * {Types::DescribeDocumentClassifierResponse#document_classifier_properties #document_classifier_properties} => Types::DocumentClassifierProperties
|
590
|
+
#
|
591
|
+
# @example Request syntax with placeholder values
|
592
|
+
#
|
593
|
+
# resp = client.describe_document_classifier({
|
594
|
+
# document_classifier_arn: "DocumentClassifierArn", # required
|
595
|
+
# })
|
596
|
+
#
|
597
|
+
# @example Response structure
|
598
|
+
#
|
599
|
+
# resp.document_classifier_properties.document_classifier_arn #=> String
|
600
|
+
# resp.document_classifier_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
|
601
|
+
# resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
|
602
|
+
# resp.document_classifier_properties.message #=> String
|
603
|
+
# resp.document_classifier_properties.submit_time #=> Time
|
604
|
+
# resp.document_classifier_properties.end_time #=> Time
|
605
|
+
# resp.document_classifier_properties.training_start_time #=> Time
|
606
|
+
# resp.document_classifier_properties.training_end_time #=> Time
|
607
|
+
# resp.document_classifier_properties.input_data_config.s3_uri #=> String
|
608
|
+
# resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
|
609
|
+
# resp.document_classifier_properties.classifier_metadata.number_of_trained_documents #=> Integer
|
610
|
+
# resp.document_classifier_properties.classifier_metadata.number_of_test_documents #=> Integer
|
611
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.accuracy #=> Float
|
612
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.precision #=> Float
|
613
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.recall #=> Float
|
614
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.f1_score #=> Float
|
615
|
+
# resp.document_classifier_properties.data_access_role_arn #=> String
|
616
|
+
#
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
618
|
+
#
|
619
|
+
# @overload describe_document_classifier(params = {})
|
620
|
+
# @param [Hash] params ({})
|
621
|
+
def describe_document_classifier(params = {}, options = {})
|
622
|
+
req = build_request(:describe_document_classifier, params)
|
623
|
+
req.send_request(options)
|
624
|
+
end
|
625
|
+
|
430
626
|
# Gets the properties associated with a dominant language detection job.
|
431
627
|
# Use this operation to get the status of a detection job.
|
432
628
|
#
|
@@ -808,7 +1004,7 @@ module Aws::Comprehend
|
|
808
1004
|
# resp.syntax_tokens[0].text #=> String
|
809
1005
|
# resp.syntax_tokens[0].begin_offset #=> Integer
|
810
1006
|
# resp.syntax_tokens[0].end_offset #=> Integer
|
811
|
-
# resp.syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
|
1007
|
+
# resp.syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "CCONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
|
812
1008
|
# resp.syntax_tokens[0].part_of_speech.score #=> Float
|
813
1009
|
#
|
814
1010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntax AWS API Documentation
|
@@ -820,6 +1016,126 @@ module Aws::Comprehend
|
|
820
1016
|
req.send_request(options)
|
821
1017
|
end
|
822
1018
|
|
1019
|
+
# Gets a list of the documentation classification jobs that you have
|
1020
|
+
# submitted.
|
1021
|
+
#
|
1022
|
+
# @option params [Types::DocumentClassificationJobFilter] :filter
|
1023
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
1024
|
+
# names, status, or the date and time that they were submitted. You can
|
1025
|
+
# only set one filter at a time.
|
1026
|
+
#
|
1027
|
+
# @option params [String] :next_token
|
1028
|
+
# Identifies the next page of results to return.
|
1029
|
+
#
|
1030
|
+
# @option params [Integer] :max_results
|
1031
|
+
# The maximum number of results to return in each page. The default is
|
1032
|
+
# 100.
|
1033
|
+
#
|
1034
|
+
# @return [Types::ListDocumentClassificationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1035
|
+
#
|
1036
|
+
# * {Types::ListDocumentClassificationJobsResponse#document_classification_job_properties_list #document_classification_job_properties_list} => Array<Types::DocumentClassificationJobProperties>
|
1037
|
+
# * {Types::ListDocumentClassificationJobsResponse#next_token #next_token} => String
|
1038
|
+
#
|
1039
|
+
# @example Request syntax with placeholder values
|
1040
|
+
#
|
1041
|
+
# resp = client.list_document_classification_jobs({
|
1042
|
+
# filter: {
|
1043
|
+
# job_name: "JobName",
|
1044
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
1045
|
+
# submit_time_before: Time.now,
|
1046
|
+
# submit_time_after: Time.now,
|
1047
|
+
# },
|
1048
|
+
# next_token: "String",
|
1049
|
+
# max_results: 1,
|
1050
|
+
# })
|
1051
|
+
#
|
1052
|
+
# @example Response structure
|
1053
|
+
#
|
1054
|
+
# resp.document_classification_job_properties_list #=> Array
|
1055
|
+
# resp.document_classification_job_properties_list[0].job_id #=> String
|
1056
|
+
# resp.document_classification_job_properties_list[0].job_name #=> String
|
1057
|
+
# resp.document_classification_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1058
|
+
# resp.document_classification_job_properties_list[0].message #=> String
|
1059
|
+
# resp.document_classification_job_properties_list[0].submit_time #=> Time
|
1060
|
+
# resp.document_classification_job_properties_list[0].end_time #=> Time
|
1061
|
+
# resp.document_classification_job_properties_list[0].document_classifier_arn #=> String
|
1062
|
+
# resp.document_classification_job_properties_list[0].input_data_config.s3_uri #=> String
|
1063
|
+
# resp.document_classification_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1064
|
+
# resp.document_classification_job_properties_list[0].output_data_config.s3_uri #=> String
|
1065
|
+
# resp.document_classification_job_properties_list[0].data_access_role_arn #=> String
|
1066
|
+
# resp.next_token #=> String
|
1067
|
+
#
|
1068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs AWS API Documentation
|
1069
|
+
#
|
1070
|
+
# @overload list_document_classification_jobs(params = {})
|
1071
|
+
# @param [Hash] params ({})
|
1072
|
+
def list_document_classification_jobs(params = {}, options = {})
|
1073
|
+
req = build_request(:list_document_classification_jobs, params)
|
1074
|
+
req.send_request(options)
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
# Gets a list of the document classifiers that you have created.
|
1078
|
+
#
|
1079
|
+
# @option params [Types::DocumentClassifierFilter] :filter
|
1080
|
+
# Filters the jobs that are returned. You can filter jobs on their name,
|
1081
|
+
# status, or the date and time that they were submitted. You can only
|
1082
|
+
# set one filter at a time.
|
1083
|
+
#
|
1084
|
+
# @option params [String] :next_token
|
1085
|
+
# Identifies the next page of results to return.
|
1086
|
+
#
|
1087
|
+
# @option params [Integer] :max_results
|
1088
|
+
# The maximum number of results to return in each page. The default is
|
1089
|
+
# 100.
|
1090
|
+
#
|
1091
|
+
# @return [Types::ListDocumentClassifiersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1092
|
+
#
|
1093
|
+
# * {Types::ListDocumentClassifiersResponse#document_classifier_properties_list #document_classifier_properties_list} => Array<Types::DocumentClassifierProperties>
|
1094
|
+
# * {Types::ListDocumentClassifiersResponse#next_token #next_token} => String
|
1095
|
+
#
|
1096
|
+
# @example Request syntax with placeholder values
|
1097
|
+
#
|
1098
|
+
# resp = client.list_document_classifiers({
|
1099
|
+
# filter: {
|
1100
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
|
1101
|
+
# submit_time_before: Time.now,
|
1102
|
+
# submit_time_after: Time.now,
|
1103
|
+
# },
|
1104
|
+
# next_token: "String",
|
1105
|
+
# max_results: 1,
|
1106
|
+
# })
|
1107
|
+
#
|
1108
|
+
# @example Response structure
|
1109
|
+
#
|
1110
|
+
# resp.document_classifier_properties_list #=> Array
|
1111
|
+
# resp.document_classifier_properties_list[0].document_classifier_arn #=> String
|
1112
|
+
# resp.document_classifier_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
|
1113
|
+
# resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
|
1114
|
+
# resp.document_classifier_properties_list[0].message #=> String
|
1115
|
+
# resp.document_classifier_properties_list[0].submit_time #=> Time
|
1116
|
+
# resp.document_classifier_properties_list[0].end_time #=> Time
|
1117
|
+
# resp.document_classifier_properties_list[0].training_start_time #=> Time
|
1118
|
+
# resp.document_classifier_properties_list[0].training_end_time #=> Time
|
1119
|
+
# resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
|
1120
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
|
1121
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_trained_documents #=> Integer
|
1122
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_test_documents #=> Integer
|
1123
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.accuracy #=> Float
|
1124
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.precision #=> Float
|
1125
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.recall #=> Float
|
1126
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.f1_score #=> Float
|
1127
|
+
# resp.document_classifier_properties_list[0].data_access_role_arn #=> String
|
1128
|
+
# resp.next_token #=> String
|
1129
|
+
#
|
1130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
1131
|
+
#
|
1132
|
+
# @overload list_document_classifiers(params = {})
|
1133
|
+
# @param [Hash] params ({})
|
1134
|
+
def list_document_classifiers(params = {}, options = {})
|
1135
|
+
req = build_request(:list_document_classifiers, params)
|
1136
|
+
req.send_request(options)
|
1137
|
+
end
|
1138
|
+
|
823
1139
|
# Gets a list of the dominant language detection jobs that you have
|
824
1140
|
# submitted.
|
825
1141
|
#
|
@@ -1104,6 +1420,69 @@ module Aws::Comprehend
|
|
1104
1420
|
req.send_request(options)
|
1105
1421
|
end
|
1106
1422
|
|
1423
|
+
# Starts an asynchronous document classification job. Use the operation
|
1424
|
+
# to track the progress of the job.
|
1425
|
+
#
|
1426
|
+
# @option params [String] :job_name
|
1427
|
+
# The identifier of the job.
|
1428
|
+
#
|
1429
|
+
# @option params [required, String] :document_classifier_arn
|
1430
|
+
# The Amazon Resource Name (ARN) of the document classifier to use to
|
1431
|
+
# process the job.
|
1432
|
+
#
|
1433
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
1434
|
+
# Specifies the format and location of the input data for the job.
|
1435
|
+
#
|
1436
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1437
|
+
# Specifies where to send the output files.
|
1438
|
+
#
|
1439
|
+
# @option params [required, String] :data_access_role_arn
|
1440
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1441
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1442
|
+
# your input data.
|
1443
|
+
#
|
1444
|
+
# @option params [String] :client_request_token
|
1445
|
+
# A unique identifier for the request. If you do not set the client
|
1446
|
+
# request token, Amazon Comprehend generates one.
|
1447
|
+
#
|
1448
|
+
# **A suitable default value is auto-generated.** You should normally
|
1449
|
+
# not need to pass this option.**
|
1450
|
+
#
|
1451
|
+
# @return [Types::StartDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1452
|
+
#
|
1453
|
+
# * {Types::StartDocumentClassificationJobResponse#job_id #job_id} => String
|
1454
|
+
# * {Types::StartDocumentClassificationJobResponse#job_status #job_status} => String
|
1455
|
+
#
|
1456
|
+
# @example Request syntax with placeholder values
|
1457
|
+
#
|
1458
|
+
# resp = client.start_document_classification_job({
|
1459
|
+
# job_name: "JobName",
|
1460
|
+
# document_classifier_arn: "DocumentClassifierArn", # required
|
1461
|
+
# input_data_config: { # required
|
1462
|
+
# s3_uri: "S3Uri", # required
|
1463
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
1464
|
+
# },
|
1465
|
+
# output_data_config: { # required
|
1466
|
+
# s3_uri: "S3Uri", # required
|
1467
|
+
# },
|
1468
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1469
|
+
# client_request_token: "ClientRequestTokenString",
|
1470
|
+
# })
|
1471
|
+
#
|
1472
|
+
# @example Response structure
|
1473
|
+
#
|
1474
|
+
# resp.job_id #=> String
|
1475
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1476
|
+
#
|
1477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob AWS API Documentation
|
1478
|
+
#
|
1479
|
+
# @overload start_document_classification_job(params = {})
|
1480
|
+
# @param [Hash] params ({})
|
1481
|
+
def start_document_classification_job(params = {}, options = {})
|
1482
|
+
req = build_request(:start_document_classification_job, params)
|
1483
|
+
req.send_request(options)
|
1484
|
+
end
|
1485
|
+
|
1107
1486
|
# Starts an asynchronous dominant language detection job for a
|
1108
1487
|
# collection of documents. Use the operation to track the status of a
|
1109
1488
|
# job.
|
@@ -1191,8 +1570,12 @@ module Aws::Comprehend
|
|
1191
1570
|
# The identifier of the job.
|
1192
1571
|
#
|
1193
1572
|
# @option params [required, String] :language_code
|
1194
|
-
# The language of the input documents.
|
1195
|
-
#
|
1573
|
+
# The language of the input documents. All documents must be in the same
|
1574
|
+
# language. You can specify any of the languages supported by Amazon
|
1575
|
+
# Comprehend: English ("en"), Spanish ("es"), French ("fr"),
|
1576
|
+
# German ("de"), Italian ("it"), or Portuguese ("pt"). If custom
|
1577
|
+
# entities recognition is used, this parameter is ignored and the
|
1578
|
+
# language used for training the model is used instead.
|
1196
1579
|
#
|
1197
1580
|
# @option params [String] :client_request_token
|
1198
1581
|
# A unique identifier for the request. If you don't set the client
|
@@ -1623,7 +2006,7 @@ module Aws::Comprehend
|
|
1623
2006
|
params: params,
|
1624
2007
|
config: config)
|
1625
2008
|
context[:gem_name] = 'aws-sdk-comprehend'
|
1626
|
-
context[:gem_version] = '1.
|
2009
|
+
context[:gem_version] = '1.9.0'
|
1627
2010
|
Seahorse::Client::Request.new(handlers, context)
|
1628
2011
|
end
|
1629
2012
|
|