aws-sdk-comprehend 1.9.1 → 1.10.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 +246 -7
- data/lib/aws-sdk-comprehend/client_api.rb +165 -0
- data/lib/aws-sdk-comprehend/types.rb +522 -3
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1ff698f23e428babdf46677df1ed14091184087b
|
4
|
+
data.tar.gz: be59a27ec5bde173cf8007d908c01fe527ce36f1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d6a3c0d8170fc4d06b638b4422459efe54a11dfffa7b3c79b4c16a4d67793504575b2520d10522e864131decd65521eb2bbc163068e7282f730313a358d4f10
|
7
|
+
data.tar.gz: 356a3d50467d1902624216353f8bc1a8eba2c4640479659b525baf9d6142783bdfd8ab8358c9f990e4f361c68cae9e25b7af4bcabd3c79915bac6809fa2792ee
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -450,9 +450,9 @@ module Aws::Comprehend
|
|
450
450
|
|
451
451
|
# Creates a new document classifier that you can use to categorize
|
452
452
|
# documents. To create a classifier you provide a set of training
|
453
|
-
# documents that
|
454
|
-
#
|
455
|
-
#
|
453
|
+
# documents that labeled with the categories that you want to use. After
|
454
|
+
# the classifier is trained you can use it to categorize a set of
|
455
|
+
# labeled documents into the categories.
|
456
456
|
#
|
457
457
|
# @option params [required, String] :document_classifier_name
|
458
458
|
# The name of the document classifier.
|
@@ -473,9 +473,8 @@ module Aws::Comprehend
|
|
473
473
|
# not need to pass this option.**
|
474
474
|
#
|
475
475
|
# @option params [required, String] :language_code
|
476
|
-
# The language of the input documents. You can
|
477
|
-
#
|
478
|
-
# However, all documents must be in the same language.
|
476
|
+
# The language of the input documents. You can specify English ("en")
|
477
|
+
# or Spanish ("es"). All documents must be in the same language.
|
479
478
|
#
|
480
479
|
# @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
481
480
|
#
|
@@ -506,6 +505,79 @@ module Aws::Comprehend
|
|
506
505
|
req.send_request(options)
|
507
506
|
end
|
508
507
|
|
508
|
+
# Creates an entity recognizer using submitted files. After your
|
509
|
+
# `CreateEntityRecognizer` request is submitted, you can check job
|
510
|
+
# status using the API.
|
511
|
+
#
|
512
|
+
# @option params [required, String] :recognizer_name
|
513
|
+
# The name given to the newly created recognizer. Recognizer names can
|
514
|
+
# be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
|
515
|
+
# and underscores (\_) are allowed. The name must be unique in the
|
516
|
+
# account/region.
|
517
|
+
#
|
518
|
+
# @option params [required, String] :data_access_role_arn
|
519
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
520
|
+
# (IAM) role that grants Amazon Comprehend read access to your input
|
521
|
+
# data.
|
522
|
+
#
|
523
|
+
# @option params [required, Types::EntityRecognizerInputDataConfig] :input_data_config
|
524
|
+
# Specifies the format and location of the input data. The S3 bucket
|
525
|
+
# containing the input data must be located in the same region as the
|
526
|
+
# entity recognizer being created.
|
527
|
+
#
|
528
|
+
# @option params [String] :client_request_token
|
529
|
+
# A unique identifier for the request. If you don't set the client
|
530
|
+
# request token, Amazon Comprehend generates one.
|
531
|
+
#
|
532
|
+
# **A suitable default value is auto-generated.** You should normally
|
533
|
+
# not need to pass this option.**
|
534
|
+
#
|
535
|
+
# @option params [required, String] :language_code
|
536
|
+
# The language of the input documents. All documents must be in the same
|
537
|
+
# language. Only English ("en") is currently supported.
|
538
|
+
#
|
539
|
+
# @return [Types::CreateEntityRecognizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
540
|
+
#
|
541
|
+
# * {Types::CreateEntityRecognizerResponse#entity_recognizer_arn #entity_recognizer_arn} => String
|
542
|
+
#
|
543
|
+
# @example Request syntax with placeholder values
|
544
|
+
#
|
545
|
+
# resp = client.create_entity_recognizer({
|
546
|
+
# recognizer_name: "ComprehendArnName", # required
|
547
|
+
# data_access_role_arn: "IamRoleArn", # required
|
548
|
+
# input_data_config: { # required
|
549
|
+
# entity_types: [ # required
|
550
|
+
# {
|
551
|
+
# type: "EntityTypeName", # required
|
552
|
+
# },
|
553
|
+
# ],
|
554
|
+
# documents: { # required
|
555
|
+
# s3_uri: "S3Uri", # required
|
556
|
+
# },
|
557
|
+
# annotations: {
|
558
|
+
# s3_uri: "S3Uri", # required
|
559
|
+
# },
|
560
|
+
# entity_list: {
|
561
|
+
# s3_uri: "S3Uri", # required
|
562
|
+
# },
|
563
|
+
# },
|
564
|
+
# client_request_token: "ClientRequestTokenString",
|
565
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
566
|
+
# })
|
567
|
+
#
|
568
|
+
# @example Response structure
|
569
|
+
#
|
570
|
+
# resp.entity_recognizer_arn #=> String
|
571
|
+
#
|
572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizer AWS API Documentation
|
573
|
+
#
|
574
|
+
# @overload create_entity_recognizer(params = {})
|
575
|
+
# @param [Hash] params ({})
|
576
|
+
def create_entity_recognizer(params = {}, options = {})
|
577
|
+
req = build_request(:create_entity_recognizer, params)
|
578
|
+
req.send_request(options)
|
579
|
+
end
|
580
|
+
|
509
581
|
# Deletes a previously created document classifier
|
510
582
|
#
|
511
583
|
# Only those classifiers that are in terminated states (IN\_ERROR,
|
@@ -538,6 +610,37 @@ module Aws::Comprehend
|
|
538
610
|
req.send_request(options)
|
539
611
|
end
|
540
612
|
|
613
|
+
# Deletes an entity recognizer.
|
614
|
+
#
|
615
|
+
# Only those recognizers that are in terminated states (IN\_ERROR,
|
616
|
+
# TRAINED) will be deleted. If an active inference job is using the
|
617
|
+
# model, a `ResourceInUseException` will be returned.
|
618
|
+
#
|
619
|
+
# This is an asynchronous action that puts the recognizer into a
|
620
|
+
# DELETING state, and it is then removed by a background job. Once
|
621
|
+
# removed, the recognizer disappears from your account and is no longer
|
622
|
+
# available for use.
|
623
|
+
#
|
624
|
+
# @option params [required, String] :entity_recognizer_arn
|
625
|
+
# The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
626
|
+
#
|
627
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
628
|
+
#
|
629
|
+
# @example Request syntax with placeholder values
|
630
|
+
#
|
631
|
+
# resp = client.delete_entity_recognizer({
|
632
|
+
# entity_recognizer_arn: "EntityRecognizerArn", # required
|
633
|
+
# })
|
634
|
+
#
|
635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizer AWS API Documentation
|
636
|
+
#
|
637
|
+
# @overload delete_entity_recognizer(params = {})
|
638
|
+
# @param [Hash] params ({})
|
639
|
+
def delete_entity_recognizer(params = {}, options = {})
|
640
|
+
req = build_request(:delete_entity_recognizer, params)
|
641
|
+
req.send_request(options)
|
642
|
+
end
|
643
|
+
|
541
644
|
# Gets the properties associated with a document classification job. Use
|
542
645
|
# this operation to get the status of a classification job.
|
543
646
|
#
|
@@ -687,6 +790,7 @@ module Aws::Comprehend
|
|
687
790
|
# resp.entities_detection_job_properties.message #=> String
|
688
791
|
# resp.entities_detection_job_properties.submit_time #=> Time
|
689
792
|
# resp.entities_detection_job_properties.end_time #=> Time
|
793
|
+
# resp.entities_detection_job_properties.entity_recognizer_arn #=> String
|
690
794
|
# resp.entities_detection_job_properties.input_data_config.s3_uri #=> String
|
691
795
|
# resp.entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
692
796
|
# resp.entities_detection_job_properties.output_data_config.s3_uri #=> String
|
@@ -702,6 +806,56 @@ module Aws::Comprehend
|
|
702
806
|
req.send_request(options)
|
703
807
|
end
|
704
808
|
|
809
|
+
# Provides details about an entity recognizer including status, S3
|
810
|
+
# buckets containing training data, recognizer metadata, metrics, and so
|
811
|
+
# on.
|
812
|
+
#
|
813
|
+
# @option params [required, String] :entity_recognizer_arn
|
814
|
+
# The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
815
|
+
#
|
816
|
+
# @return [Types::DescribeEntityRecognizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
817
|
+
#
|
818
|
+
# * {Types::DescribeEntityRecognizerResponse#entity_recognizer_properties #entity_recognizer_properties} => Types::EntityRecognizerProperties
|
819
|
+
#
|
820
|
+
# @example Request syntax with placeholder values
|
821
|
+
#
|
822
|
+
# resp = client.describe_entity_recognizer({
|
823
|
+
# entity_recognizer_arn: "EntityRecognizerArn", # required
|
824
|
+
# })
|
825
|
+
#
|
826
|
+
# @example Response structure
|
827
|
+
#
|
828
|
+
# resp.entity_recognizer_properties.entity_recognizer_arn #=> String
|
829
|
+
# resp.entity_recognizer_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
|
830
|
+
# resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
|
831
|
+
# resp.entity_recognizer_properties.message #=> String
|
832
|
+
# resp.entity_recognizer_properties.submit_time #=> Time
|
833
|
+
# resp.entity_recognizer_properties.end_time #=> Time
|
834
|
+
# resp.entity_recognizer_properties.training_start_time #=> Time
|
835
|
+
# resp.entity_recognizer_properties.training_end_time #=> Time
|
836
|
+
# resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
|
837
|
+
# resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
|
838
|
+
# resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
|
839
|
+
# resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
|
840
|
+
# resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
|
841
|
+
# resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
|
842
|
+
# resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
|
843
|
+
# resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
|
844
|
+
# resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.recall #=> Float
|
845
|
+
# resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.f1_score #=> Float
|
846
|
+
# resp.entity_recognizer_properties.recognizer_metadata.entity_types #=> Array
|
847
|
+
# resp.entity_recognizer_properties.recognizer_metadata.entity_types[0].type #=> String
|
848
|
+
# resp.entity_recognizer_properties.data_access_role_arn #=> String
|
849
|
+
#
|
850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
|
851
|
+
#
|
852
|
+
# @overload describe_entity_recognizer(params = {})
|
853
|
+
# @param [Hash] params ({})
|
854
|
+
def describe_entity_recognizer(params = {}, options = {})
|
855
|
+
req = build_request(:describe_entity_recognizer, params)
|
856
|
+
req.send_request(options)
|
857
|
+
end
|
858
|
+
|
705
859
|
# Gets the properties associated with a key phrases detection job. Use
|
706
860
|
# this operation to get the status of a detection job.
|
707
861
|
#
|
@@ -1234,6 +1388,7 @@ module Aws::Comprehend
|
|
1234
1388
|
# resp.entities_detection_job_properties_list[0].message #=> String
|
1235
1389
|
# resp.entities_detection_job_properties_list[0].submit_time #=> Time
|
1236
1390
|
# resp.entities_detection_job_properties_list[0].end_time #=> Time
|
1391
|
+
# resp.entities_detection_job_properties_list[0].entity_recognizer_arn #=> String
|
1237
1392
|
# resp.entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
1238
1393
|
# resp.entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1239
1394
|
# resp.entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
@@ -1250,6 +1405,79 @@ module Aws::Comprehend
|
|
1250
1405
|
req.send_request(options)
|
1251
1406
|
end
|
1252
1407
|
|
1408
|
+
# Gets a list of the properties of all entity recognizers that you
|
1409
|
+
# created, including recognizers currently in training. Allows you to
|
1410
|
+
# filter the list of recognizers based on criteria such as status and
|
1411
|
+
# submission time. This call returns up to 500 entity recognizers in the
|
1412
|
+
# list, with a default number of 100 recognizers in the list.
|
1413
|
+
#
|
1414
|
+
# The results of this list are not in any particular order. Please get
|
1415
|
+
# the list and sort locally if needed.
|
1416
|
+
#
|
1417
|
+
# @option params [Types::EntityRecognizerFilter] :filter
|
1418
|
+
# Filters the list of entities returned. You can filter on `Status`,
|
1419
|
+
# `SubmitTimeBefore`, or `SubmitTimeAfter`. You can only set one filter
|
1420
|
+
# at a time.
|
1421
|
+
#
|
1422
|
+
# @option params [String] :next_token
|
1423
|
+
# Identifies the next page of results to return.
|
1424
|
+
#
|
1425
|
+
# @option params [Integer] :max_results
|
1426
|
+
# The maximum number of results to return on each page. The default is
|
1427
|
+
# 100.
|
1428
|
+
#
|
1429
|
+
# @return [Types::ListEntityRecognizersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1430
|
+
#
|
1431
|
+
# * {Types::ListEntityRecognizersResponse#entity_recognizer_properties_list #entity_recognizer_properties_list} => Array<Types::EntityRecognizerProperties>
|
1432
|
+
# * {Types::ListEntityRecognizersResponse#next_token #next_token} => String
|
1433
|
+
#
|
1434
|
+
# @example Request syntax with placeholder values
|
1435
|
+
#
|
1436
|
+
# resp = client.list_entity_recognizers({
|
1437
|
+
# filter: {
|
1438
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
|
1439
|
+
# submit_time_before: Time.now,
|
1440
|
+
# submit_time_after: Time.now,
|
1441
|
+
# },
|
1442
|
+
# next_token: "String",
|
1443
|
+
# max_results: 1,
|
1444
|
+
# })
|
1445
|
+
#
|
1446
|
+
# @example Response structure
|
1447
|
+
#
|
1448
|
+
# resp.entity_recognizer_properties_list #=> Array
|
1449
|
+
# resp.entity_recognizer_properties_list[0].entity_recognizer_arn #=> String
|
1450
|
+
# resp.entity_recognizer_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
|
1451
|
+
# resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
|
1452
|
+
# resp.entity_recognizer_properties_list[0].message #=> String
|
1453
|
+
# resp.entity_recognizer_properties_list[0].submit_time #=> Time
|
1454
|
+
# resp.entity_recognizer_properties_list[0].end_time #=> Time
|
1455
|
+
# resp.entity_recognizer_properties_list[0].training_start_time #=> Time
|
1456
|
+
# resp.entity_recognizer_properties_list[0].training_end_time #=> Time
|
1457
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
|
1458
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
|
1459
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
|
1460
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
|
1461
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
|
1462
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
|
1463
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
|
1464
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
|
1465
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.recall #=> Float
|
1466
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.f1_score #=> Float
|
1467
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types #=> Array
|
1468
|
+
# resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types[0].type #=> String
|
1469
|
+
# resp.entity_recognizer_properties_list[0].data_access_role_arn #=> String
|
1470
|
+
# resp.next_token #=> String
|
1471
|
+
#
|
1472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
|
1473
|
+
#
|
1474
|
+
# @overload list_entity_recognizers(params = {})
|
1475
|
+
# @param [Hash] params ({})
|
1476
|
+
def list_entity_recognizers(params = {}, options = {})
|
1477
|
+
req = build_request(:list_entity_recognizers, params)
|
1478
|
+
req.send_request(options)
|
1479
|
+
end
|
1480
|
+
|
1253
1481
|
# Get a list of key phrase detection jobs that you have submitted.
|
1254
1482
|
#
|
1255
1483
|
# @option params [Types::KeyPhrasesDetectionJobFilter] :filter
|
@@ -1550,6 +1778,11 @@ module Aws::Comprehend
|
|
1550
1778
|
# Starts an asynchronous entity detection job for a collection of
|
1551
1779
|
# documents. Use the operation to track the status of a job.
|
1552
1780
|
#
|
1781
|
+
# This API can be used for either standard entity detection or custom
|
1782
|
+
# entity recognition. In order to be used for custom entity recognition,
|
1783
|
+
# the optional `EntityRecognizerArn` must be used in order to provide
|
1784
|
+
# access to the recognizer being used to detect the custom entity.
|
1785
|
+
#
|
1553
1786
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1554
1787
|
# Specifies the format and location of the input data for the job.
|
1555
1788
|
#
|
@@ -1569,6 +1802,11 @@ module Aws::Comprehend
|
|
1569
1802
|
# @option params [String] :job_name
|
1570
1803
|
# The identifier of the job.
|
1571
1804
|
#
|
1805
|
+
# @option params [String] :entity_recognizer_arn
|
1806
|
+
# The Amazon Resource Name (ARN) that identifies the specific entity
|
1807
|
+
# recognizer to be used by the `StartEntitiesDetectionJob`. This ARN is
|
1808
|
+
# optional and is only used for a custom entity recognition job.
|
1809
|
+
#
|
1572
1810
|
# @option params [required, String] :language_code
|
1573
1811
|
# The language of the input documents. All documents must be in the same
|
1574
1812
|
# language. You can specify any of the languages supported by Amazon
|
@@ -1601,6 +1839,7 @@ module Aws::Comprehend
|
|
1601
1839
|
# },
|
1602
1840
|
# data_access_role_arn: "IamRoleArn", # required
|
1603
1841
|
# job_name: "JobName",
|
1842
|
+
# entity_recognizer_arn: "EntityRecognizerArn",
|
1604
1843
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
1605
1844
|
# client_request_token: "ClientRequestTokenString",
|
1606
1845
|
# })
|
@@ -2006,7 +2245,7 @@ module Aws::Comprehend
|
|
2006
2245
|
params: params,
|
2007
2246
|
config: config)
|
2008
2247
|
context[:gem_name] = 'aws-sdk-comprehend'
|
2009
|
-
context[:gem_version] = '1.
|
2248
|
+
context[:gem_version] = '1.10.0'
|
2010
2249
|
Seahorse::Client::Request.new(handlers, context)
|
2011
2250
|
end
|
2012
2251
|
|
@@ -36,8 +36,12 @@ module Aws::Comprehend
|
|
36
36
|
ComprehendArnName = Shapes::StringShape.new(name: 'ComprehendArnName')
|
37
37
|
CreateDocumentClassifierRequest = Shapes::StructureShape.new(name: 'CreateDocumentClassifierRequest')
|
38
38
|
CreateDocumentClassifierResponse = Shapes::StructureShape.new(name: 'CreateDocumentClassifierResponse')
|
39
|
+
CreateEntityRecognizerRequest = Shapes::StructureShape.new(name: 'CreateEntityRecognizerRequest')
|
40
|
+
CreateEntityRecognizerResponse = Shapes::StructureShape.new(name: 'CreateEntityRecognizerResponse')
|
39
41
|
DeleteDocumentClassifierRequest = Shapes::StructureShape.new(name: 'DeleteDocumentClassifierRequest')
|
40
42
|
DeleteDocumentClassifierResponse = Shapes::StructureShape.new(name: 'DeleteDocumentClassifierResponse')
|
43
|
+
DeleteEntityRecognizerRequest = Shapes::StructureShape.new(name: 'DeleteEntityRecognizerRequest')
|
44
|
+
DeleteEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DeleteEntityRecognizerResponse')
|
41
45
|
DescribeDocumentClassificationJobRequest = Shapes::StructureShape.new(name: 'DescribeDocumentClassificationJobRequest')
|
42
46
|
DescribeDocumentClassificationJobResponse = Shapes::StructureShape.new(name: 'DescribeDocumentClassificationJobResponse')
|
43
47
|
DescribeDocumentClassifierRequest = Shapes::StructureShape.new(name: 'DescribeDocumentClassifierRequest')
|
@@ -46,6 +50,8 @@ module Aws::Comprehend
|
|
46
50
|
DescribeDominantLanguageDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeDominantLanguageDetectionJobResponse')
|
47
51
|
DescribeEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionJobRequest')
|
48
52
|
DescribeEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeEntitiesDetectionJobResponse')
|
53
|
+
DescribeEntityRecognizerRequest = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerRequest')
|
54
|
+
DescribeEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerResponse')
|
49
55
|
DescribeKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobRequest')
|
50
56
|
DescribeKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobResponse')
|
51
57
|
DescribeSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobRequest')
|
@@ -79,7 +85,22 @@ module Aws::Comprehend
|
|
79
85
|
EntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'EntitiesDetectionJobProperties')
|
80
86
|
EntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EntitiesDetectionJobPropertiesList')
|
81
87
|
Entity = Shapes::StructureShape.new(name: 'Entity')
|
88
|
+
EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
|
89
|
+
EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
|
90
|
+
EntityRecognizerDocuments = Shapes::StructureShape.new(name: 'EntityRecognizerDocuments')
|
91
|
+
EntityRecognizerEntityList = Shapes::StructureShape.new(name: 'EntityRecognizerEntityList')
|
92
|
+
EntityRecognizerEvaluationMetrics = Shapes::StructureShape.new(name: 'EntityRecognizerEvaluationMetrics')
|
93
|
+
EntityRecognizerFilter = Shapes::StructureShape.new(name: 'EntityRecognizerFilter')
|
94
|
+
EntityRecognizerInputDataConfig = Shapes::StructureShape.new(name: 'EntityRecognizerInputDataConfig')
|
95
|
+
EntityRecognizerMetadata = Shapes::StructureShape.new(name: 'EntityRecognizerMetadata')
|
96
|
+
EntityRecognizerMetadataEntityTypesList = Shapes::ListShape.new(name: 'EntityRecognizerMetadataEntityTypesList')
|
97
|
+
EntityRecognizerMetadataEntityTypesListItem = Shapes::StructureShape.new(name: 'EntityRecognizerMetadataEntityTypesListItem')
|
98
|
+
EntityRecognizerProperties = Shapes::StructureShape.new(name: 'EntityRecognizerProperties')
|
99
|
+
EntityRecognizerPropertiesList = Shapes::ListShape.new(name: 'EntityRecognizerPropertiesList')
|
82
100
|
EntityType = Shapes::StringShape.new(name: 'EntityType')
|
101
|
+
EntityTypeName = Shapes::StringShape.new(name: 'EntityTypeName')
|
102
|
+
EntityTypesList = Shapes::ListShape.new(name: 'EntityTypesList')
|
103
|
+
EntityTypesListItem = Shapes::StructureShape.new(name: 'EntityTypesListItem')
|
83
104
|
Float = Shapes::FloatShape.new(name: 'Float')
|
84
105
|
IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
|
85
106
|
InputDataConfig = Shapes::StructureShape.new(name: 'InputDataConfig')
|
@@ -105,6 +126,8 @@ module Aws::Comprehend
|
|
105
126
|
ListDominantLanguageDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListDominantLanguageDetectionJobsResponse')
|
106
127
|
ListEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsRequest')
|
107
128
|
ListEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsResponse')
|
129
|
+
ListEntityRecognizersRequest = Shapes::StructureShape.new(name: 'ListEntityRecognizersRequest')
|
130
|
+
ListEntityRecognizersResponse = Shapes::StructureShape.new(name: 'ListEntityRecognizersResponse')
|
108
131
|
ListKeyPhrasesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsRequest')
|
109
132
|
ListKeyPhrasesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsResponse')
|
110
133
|
ListOfDetectDominantLanguageResult = Shapes::ListShape.new(name: 'ListOfDetectDominantLanguageResult')
|
@@ -257,11 +280,26 @@ module Aws::Comprehend
|
|
257
280
|
CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
258
281
|
CreateDocumentClassifierResponse.struct_class = Types::CreateDocumentClassifierResponse
|
259
282
|
|
283
|
+
CreateEntityRecognizerRequest.add_member(:recognizer_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "RecognizerName"))
|
284
|
+
CreateEntityRecognizerRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
285
|
+
CreateEntityRecognizerRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: EntityRecognizerInputDataConfig, required: true, location_name: "InputDataConfig"))
|
286
|
+
CreateEntityRecognizerRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
287
|
+
CreateEntityRecognizerRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
288
|
+
CreateEntityRecognizerRequest.struct_class = Types::CreateEntityRecognizerRequest
|
289
|
+
|
290
|
+
CreateEntityRecognizerResponse.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
291
|
+
CreateEntityRecognizerResponse.struct_class = Types::CreateEntityRecognizerResponse
|
292
|
+
|
260
293
|
DeleteDocumentClassifierRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
|
261
294
|
DeleteDocumentClassifierRequest.struct_class = Types::DeleteDocumentClassifierRequest
|
262
295
|
|
263
296
|
DeleteDocumentClassifierResponse.struct_class = Types::DeleteDocumentClassifierResponse
|
264
297
|
|
298
|
+
DeleteEntityRecognizerRequest.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, required: true, location_name: "EntityRecognizerArn"))
|
299
|
+
DeleteEntityRecognizerRequest.struct_class = Types::DeleteEntityRecognizerRequest
|
300
|
+
|
301
|
+
DeleteEntityRecognizerResponse.struct_class = Types::DeleteEntityRecognizerResponse
|
302
|
+
|
265
303
|
DescribeDocumentClassificationJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
266
304
|
DescribeDocumentClassificationJobRequest.struct_class = Types::DescribeDocumentClassificationJobRequest
|
267
305
|
|
@@ -286,6 +324,12 @@ module Aws::Comprehend
|
|
286
324
|
DescribeEntitiesDetectionJobResponse.add_member(:entities_detection_job_properties, Shapes::ShapeRef.new(shape: EntitiesDetectionJobProperties, location_name: "EntitiesDetectionJobProperties"))
|
287
325
|
DescribeEntitiesDetectionJobResponse.struct_class = Types::DescribeEntitiesDetectionJobResponse
|
288
326
|
|
327
|
+
DescribeEntityRecognizerRequest.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, required: true, location_name: "EntityRecognizerArn"))
|
328
|
+
DescribeEntityRecognizerRequest.struct_class = Types::DescribeEntityRecognizerRequest
|
329
|
+
|
330
|
+
DescribeEntityRecognizerResponse.add_member(:entity_recognizer_properties, Shapes::ShapeRef.new(shape: EntityRecognizerProperties, location_name: "EntityRecognizerProperties"))
|
331
|
+
DescribeEntityRecognizerResponse.struct_class = Types::DescribeEntityRecognizerResponse
|
332
|
+
|
289
333
|
DescribeKeyPhrasesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
|
290
334
|
DescribeKeyPhrasesDetectionJobRequest.struct_class = Types::DescribeKeyPhrasesDetectionJobRequest
|
291
335
|
|
@@ -417,6 +461,7 @@ module Aws::Comprehend
|
|
417
461
|
EntitiesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
418
462
|
EntitiesDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
419
463
|
EntitiesDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
464
|
+
EntitiesDetectionJobProperties.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
420
465
|
EntitiesDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
421
466
|
EntitiesDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
422
467
|
EntitiesDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
@@ -432,6 +477,62 @@ module Aws::Comprehend
|
|
432
477
|
Entity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
|
433
478
|
Entity.struct_class = Types::Entity
|
434
479
|
|
480
|
+
EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
481
|
+
EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
|
482
|
+
|
483
|
+
EntityRecognizerDocuments.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
484
|
+
EntityRecognizerDocuments.struct_class = Types::EntityRecognizerDocuments
|
485
|
+
|
486
|
+
EntityRecognizerEntityList.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
487
|
+
EntityRecognizerEntityList.struct_class = Types::EntityRecognizerEntityList
|
488
|
+
|
489
|
+
EntityRecognizerEvaluationMetrics.add_member(:precision, Shapes::ShapeRef.new(shape: Double, location_name: "Precision"))
|
490
|
+
EntityRecognizerEvaluationMetrics.add_member(:recall, Shapes::ShapeRef.new(shape: Double, location_name: "Recall"))
|
491
|
+
EntityRecognizerEvaluationMetrics.add_member(:f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "F1Score"))
|
492
|
+
EntityRecognizerEvaluationMetrics.struct_class = Types::EntityRecognizerEvaluationMetrics
|
493
|
+
|
494
|
+
EntityRecognizerFilter.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
495
|
+
EntityRecognizerFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
496
|
+
EntityRecognizerFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
497
|
+
EntityRecognizerFilter.struct_class = Types::EntityRecognizerFilter
|
498
|
+
|
499
|
+
EntityRecognizerInputDataConfig.add_member(:entity_types, Shapes::ShapeRef.new(shape: EntityTypesList, required: true, location_name: "EntityTypes"))
|
500
|
+
EntityRecognizerInputDataConfig.add_member(:documents, Shapes::ShapeRef.new(shape: EntityRecognizerDocuments, required: true, location_name: "Documents"))
|
501
|
+
EntityRecognizerInputDataConfig.add_member(:annotations, Shapes::ShapeRef.new(shape: EntityRecognizerAnnotations, location_name: "Annotations"))
|
502
|
+
EntityRecognizerInputDataConfig.add_member(:entity_list, Shapes::ShapeRef.new(shape: EntityRecognizerEntityList, location_name: "EntityList"))
|
503
|
+
EntityRecognizerInputDataConfig.struct_class = Types::EntityRecognizerInputDataConfig
|
504
|
+
|
505
|
+
EntityRecognizerMetadata.add_member(:number_of_trained_documents, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfTrainedDocuments"))
|
506
|
+
EntityRecognizerMetadata.add_member(:number_of_test_documents, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfTestDocuments"))
|
507
|
+
EntityRecognizerMetadata.add_member(:evaluation_metrics, Shapes::ShapeRef.new(shape: EntityRecognizerEvaluationMetrics, location_name: "EvaluationMetrics"))
|
508
|
+
EntityRecognizerMetadata.add_member(:entity_types, Shapes::ShapeRef.new(shape: EntityRecognizerMetadataEntityTypesList, location_name: "EntityTypes"))
|
509
|
+
EntityRecognizerMetadata.struct_class = Types::EntityRecognizerMetadata
|
510
|
+
|
511
|
+
EntityRecognizerMetadataEntityTypesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerMetadataEntityTypesListItem)
|
512
|
+
|
513
|
+
EntityRecognizerMetadataEntityTypesListItem.add_member(:type, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Type"))
|
514
|
+
EntityRecognizerMetadataEntityTypesListItem.struct_class = Types::EntityRecognizerMetadataEntityTypesListItem
|
515
|
+
|
516
|
+
EntityRecognizerProperties.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
517
|
+
EntityRecognizerProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
518
|
+
EntityRecognizerProperties.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
519
|
+
EntityRecognizerProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
520
|
+
EntityRecognizerProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
|
521
|
+
EntityRecognizerProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
522
|
+
EntityRecognizerProperties.add_member(:training_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingStartTime"))
|
523
|
+
EntityRecognizerProperties.add_member(:training_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingEndTime"))
|
524
|
+
EntityRecognizerProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: EntityRecognizerInputDataConfig, location_name: "InputDataConfig"))
|
525
|
+
EntityRecognizerProperties.add_member(:recognizer_metadata, Shapes::ShapeRef.new(shape: EntityRecognizerMetadata, location_name: "RecognizerMetadata"))
|
526
|
+
EntityRecognizerProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
527
|
+
EntityRecognizerProperties.struct_class = Types::EntityRecognizerProperties
|
528
|
+
|
529
|
+
EntityRecognizerPropertiesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerProperties)
|
530
|
+
|
531
|
+
EntityTypesList.member = Shapes::ShapeRef.new(shape: EntityTypesListItem)
|
532
|
+
|
533
|
+
EntityTypesListItem.add_member(:type, Shapes::ShapeRef.new(shape: EntityTypeName, required: true, location_name: "Type"))
|
534
|
+
EntityTypesListItem.struct_class = Types::EntityTypesListItem
|
535
|
+
|
435
536
|
InputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
436
537
|
InputDataConfig.add_member(:input_format, Shapes::ShapeRef.new(shape: InputFormat, location_name: "InputFormat"))
|
437
538
|
InputDataConfig.struct_class = Types::InputDataConfig
|
@@ -498,6 +599,15 @@ module Aws::Comprehend
|
|
498
599
|
ListEntitiesDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
499
600
|
ListEntitiesDetectionJobsResponse.struct_class = Types::ListEntitiesDetectionJobsResponse
|
500
601
|
|
602
|
+
ListEntityRecognizersRequest.add_member(:filter, Shapes::ShapeRef.new(shape: EntityRecognizerFilter, location_name: "Filter"))
|
603
|
+
ListEntityRecognizersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
604
|
+
ListEntityRecognizersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
605
|
+
ListEntityRecognizersRequest.struct_class = Types::ListEntityRecognizersRequest
|
606
|
+
|
607
|
+
ListEntityRecognizersResponse.add_member(:entity_recognizer_properties_list, Shapes::ShapeRef.new(shape: EntityRecognizerPropertiesList, location_name: "EntityRecognizerPropertiesList"))
|
608
|
+
ListEntityRecognizersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
609
|
+
ListEntityRecognizersResponse.struct_class = Types::ListEntityRecognizersResponse
|
610
|
+
|
501
611
|
ListKeyPhrasesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobFilter, location_name: "Filter"))
|
502
612
|
ListKeyPhrasesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
503
613
|
ListKeyPhrasesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -603,6 +713,7 @@ module Aws::Comprehend
|
|
603
713
|
StartEntitiesDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
|
604
714
|
StartEntitiesDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
605
715
|
StartEntitiesDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
716
|
+
StartEntitiesDetectionJobRequest.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
|
606
717
|
StartEntitiesDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
607
718
|
StartEntitiesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
608
719
|
StartEntitiesDetectionJobRequest.struct_class = Types::StartEntitiesDetectionJobRequest
|
@@ -800,6 +911,20 @@ module Aws::Comprehend
|
|
800
911
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
801
912
|
end)
|
802
913
|
|
914
|
+
api.add_operation(:create_entity_recognizer, Seahorse::Model::Operation.new.tap do |o|
|
915
|
+
o.name = "CreateEntityRecognizer"
|
916
|
+
o.http_method = "POST"
|
917
|
+
o.http_request_uri = "/"
|
918
|
+
o.input = Shapes::ShapeRef.new(shape: CreateEntityRecognizerRequest)
|
919
|
+
o.output = Shapes::ShapeRef.new(shape: CreateEntityRecognizerResponse)
|
920
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
921
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
922
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
923
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceLimitExceededException)
|
924
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
925
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
926
|
+
end)
|
927
|
+
|
803
928
|
api.add_operation(:delete_document_classifier, Seahorse::Model::Operation.new.tap do |o|
|
804
929
|
o.name = "DeleteDocumentClassifier"
|
805
930
|
o.http_method = "POST"
|
@@ -814,6 +939,20 @@ module Aws::Comprehend
|
|
814
939
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
815
940
|
end)
|
816
941
|
|
942
|
+
api.add_operation(:delete_entity_recognizer, Seahorse::Model::Operation.new.tap do |o|
|
943
|
+
o.name = "DeleteEntityRecognizer"
|
944
|
+
o.http_method = "POST"
|
945
|
+
o.http_request_uri = "/"
|
946
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteEntityRecognizerRequest)
|
947
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteEntityRecognizerResponse)
|
948
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
949
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
950
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
951
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
952
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
953
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
954
|
+
end)
|
955
|
+
|
817
956
|
api.add_operation(:describe_document_classification_job, Seahorse::Model::Operation.new.tap do |o|
|
818
957
|
o.name = "DescribeDocumentClassificationJob"
|
819
958
|
o.http_method = "POST"
|
@@ -862,6 +1001,18 @@ module Aws::Comprehend
|
|
862
1001
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
863
1002
|
end)
|
864
1003
|
|
1004
|
+
api.add_operation(:describe_entity_recognizer, Seahorse::Model::Operation.new.tap do |o|
|
1005
|
+
o.name = "DescribeEntityRecognizer"
|
1006
|
+
o.http_method = "POST"
|
1007
|
+
o.http_request_uri = "/"
|
1008
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeEntityRecognizerRequest)
|
1009
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeEntityRecognizerResponse)
|
1010
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1011
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1012
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1013
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1014
|
+
end)
|
1015
|
+
|
865
1016
|
api.add_operation(:describe_key_phrases_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
866
1017
|
o.name = "DescribeKeyPhrasesDetectionJob"
|
867
1018
|
o.http_method = "POST"
|
@@ -1017,6 +1168,18 @@ module Aws::Comprehend
|
|
1017
1168
|
)
|
1018
1169
|
end)
|
1019
1170
|
|
1171
|
+
api.add_operation(:list_entity_recognizers, Seahorse::Model::Operation.new.tap do |o|
|
1172
|
+
o.name = "ListEntityRecognizers"
|
1173
|
+
o.http_method = "POST"
|
1174
|
+
o.http_request_uri = "/"
|
1175
|
+
o.input = Shapes::ShapeRef.new(shape: ListEntityRecognizersRequest)
|
1176
|
+
o.output = Shapes::ShapeRef.new(shape: ListEntityRecognizersResponse)
|
1177
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1178
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1179
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
|
1180
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1181
|
+
end)
|
1182
|
+
|
1020
1183
|
api.add_operation(:list_key_phrases_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1021
1184
|
o.name = "ListKeyPhrasesDetectionJobs"
|
1022
1185
|
o.http_method = "POST"
|
@@ -1103,6 +1266,8 @@ module Aws::Comprehend
|
|
1103
1266
|
o.output = Shapes::ShapeRef.new(shape: StartEntitiesDetectionJobResponse)
|
1104
1267
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1105
1268
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1269
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1270
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
1106
1271
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1107
1272
|
end)
|
1108
1273
|
|
@@ -489,9 +489,9 @@ module Aws::Comprehend
|
|
489
489
|
# @return [String]
|
490
490
|
#
|
491
491
|
# @!attribute [rw] language_code
|
492
|
-
# The language of the input documents. You can
|
493
|
-
#
|
494
|
-
#
|
492
|
+
# The language of the input documents. You can specify English
|
493
|
+
# ("en") or Spanish ("es"). All documents must be in the same
|
494
|
+
# language.
|
495
495
|
# @return [String]
|
496
496
|
#
|
497
497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
|
@@ -517,6 +517,87 @@ module Aws::Comprehend
|
|
517
517
|
include Aws::Structure
|
518
518
|
end
|
519
519
|
|
520
|
+
# @note When making an API call, you may pass CreateEntityRecognizerRequest
|
521
|
+
# data as a hash:
|
522
|
+
#
|
523
|
+
# {
|
524
|
+
# recognizer_name: "ComprehendArnName", # required
|
525
|
+
# data_access_role_arn: "IamRoleArn", # required
|
526
|
+
# input_data_config: { # required
|
527
|
+
# entity_types: [ # required
|
528
|
+
# {
|
529
|
+
# type: "EntityTypeName", # required
|
530
|
+
# },
|
531
|
+
# ],
|
532
|
+
# documents: { # required
|
533
|
+
# s3_uri: "S3Uri", # required
|
534
|
+
# },
|
535
|
+
# annotations: {
|
536
|
+
# s3_uri: "S3Uri", # required
|
537
|
+
# },
|
538
|
+
# entity_list: {
|
539
|
+
# s3_uri: "S3Uri", # required
|
540
|
+
# },
|
541
|
+
# },
|
542
|
+
# client_request_token: "ClientRequestTokenString",
|
543
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
544
|
+
# }
|
545
|
+
#
|
546
|
+
# @!attribute [rw] recognizer_name
|
547
|
+
# The name given to the newly created recognizer. Recognizer names can
|
548
|
+
# be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
|
549
|
+
# and underscores (\_) are allowed. The name must be unique in the
|
550
|
+
# account/region.
|
551
|
+
# @return [String]
|
552
|
+
#
|
553
|
+
# @!attribute [rw] data_access_role_arn
|
554
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
555
|
+
# (IAM) role that grants Amazon Comprehend read access to your input
|
556
|
+
# data.
|
557
|
+
# @return [String]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] input_data_config
|
560
|
+
# Specifies the format and location of the input data. The S3 bucket
|
561
|
+
# containing the input data must be located in the same region as the
|
562
|
+
# entity recognizer being created.
|
563
|
+
# @return [Types::EntityRecognizerInputDataConfig]
|
564
|
+
#
|
565
|
+
# @!attribute [rw] client_request_token
|
566
|
+
# A unique identifier for the request. If you don't set the client
|
567
|
+
# request token, Amazon Comprehend generates one.
|
568
|
+
#
|
569
|
+
# **A suitable default value is auto-generated.** You should normally
|
570
|
+
# not need to pass this option.
|
571
|
+
# @return [String]
|
572
|
+
#
|
573
|
+
# @!attribute [rw] language_code
|
574
|
+
# The language of the input documents. All documents must be in the
|
575
|
+
# same language. Only English ("en") is currently supported.
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerRequest AWS API Documentation
|
579
|
+
#
|
580
|
+
class CreateEntityRecognizerRequest < Struct.new(
|
581
|
+
:recognizer_name,
|
582
|
+
:data_access_role_arn,
|
583
|
+
:input_data_config,
|
584
|
+
:client_request_token,
|
585
|
+
:language_code)
|
586
|
+
include Aws::Structure
|
587
|
+
end
|
588
|
+
|
589
|
+
# @!attribute [rw] entity_recognizer_arn
|
590
|
+
# The Amazon Resource Name (ARN) that identifies the entity
|
591
|
+
# recognizer.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerResponse AWS API Documentation
|
595
|
+
#
|
596
|
+
class CreateEntityRecognizerResponse < Struct.new(
|
597
|
+
:entity_recognizer_arn)
|
598
|
+
include Aws::Structure
|
599
|
+
end
|
600
|
+
|
520
601
|
# @note When making an API call, you may pass DeleteDocumentClassifierRequest
|
521
602
|
# data as a hash:
|
522
603
|
#
|
@@ -540,6 +621,29 @@ module Aws::Comprehend
|
|
540
621
|
#
|
541
622
|
class DeleteDocumentClassifierResponse < Aws::EmptyStructure; end
|
542
623
|
|
624
|
+
# @note When making an API call, you may pass DeleteEntityRecognizerRequest
|
625
|
+
# data as a hash:
|
626
|
+
#
|
627
|
+
# {
|
628
|
+
# entity_recognizer_arn: "EntityRecognizerArn", # required
|
629
|
+
# }
|
630
|
+
#
|
631
|
+
# @!attribute [rw] entity_recognizer_arn
|
632
|
+
# The Amazon Resource Name (ARN) that identifies the entity
|
633
|
+
# recognizer.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizerRequest AWS API Documentation
|
637
|
+
#
|
638
|
+
class DeleteEntityRecognizerRequest < Struct.new(
|
639
|
+
:entity_recognizer_arn)
|
640
|
+
include Aws::Structure
|
641
|
+
end
|
642
|
+
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizerResponse AWS API Documentation
|
644
|
+
#
|
645
|
+
class DeleteEntityRecognizerResponse < Aws::EmptyStructure; end
|
646
|
+
|
543
647
|
# @note When making an API call, you may pass DescribeDocumentClassificationJobRequest
|
544
648
|
# data as a hash:
|
545
649
|
#
|
@@ -664,6 +768,36 @@ module Aws::Comprehend
|
|
664
768
|
include Aws::Structure
|
665
769
|
end
|
666
770
|
|
771
|
+
# @note When making an API call, you may pass DescribeEntityRecognizerRequest
|
772
|
+
# data as a hash:
|
773
|
+
#
|
774
|
+
# {
|
775
|
+
# entity_recognizer_arn: "EntityRecognizerArn", # required
|
776
|
+
# }
|
777
|
+
#
|
778
|
+
# @!attribute [rw] entity_recognizer_arn
|
779
|
+
# The Amazon Resource Name (ARN) that identifies the entity
|
780
|
+
# recognizer.
|
781
|
+
# @return [String]
|
782
|
+
#
|
783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizerRequest AWS API Documentation
|
784
|
+
#
|
785
|
+
class DescribeEntityRecognizerRequest < Struct.new(
|
786
|
+
:entity_recognizer_arn)
|
787
|
+
include Aws::Structure
|
788
|
+
end
|
789
|
+
|
790
|
+
# @!attribute [rw] entity_recognizer_properties
|
791
|
+
# Describes information associated with an entity recognizer.
|
792
|
+
# @return [Types::EntityRecognizerProperties]
|
793
|
+
#
|
794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizerResponse AWS API Documentation
|
795
|
+
#
|
796
|
+
class DescribeEntityRecognizerResponse < Struct.new(
|
797
|
+
:entity_recognizer_properties)
|
798
|
+
include Aws::Structure
|
799
|
+
end
|
800
|
+
|
667
801
|
# @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
|
668
802
|
# data as a hash:
|
669
803
|
#
|
@@ -1431,6 +1565,11 @@ module Aws::Comprehend
|
|
1431
1565
|
# The time that the entities detection job completed
|
1432
1566
|
# @return [Time]
|
1433
1567
|
#
|
1568
|
+
# @!attribute [rw] entity_recognizer_arn
|
1569
|
+
# The Amazon Resource Name (ARN) that identifies the entity
|
1570
|
+
# recognizer.
|
1571
|
+
# @return [String]
|
1572
|
+
#
|
1434
1573
|
# @!attribute [rw] input_data_config
|
1435
1574
|
# The input data configuration that you supplied when you created the
|
1436
1575
|
# entities detection job.
|
@@ -1459,6 +1598,7 @@ module Aws::Comprehend
|
|
1459
1598
|
:message,
|
1460
1599
|
:submit_time,
|
1461
1600
|
:end_time,
|
1601
|
+
:entity_recognizer_arn,
|
1462
1602
|
:input_data_config,
|
1463
1603
|
:output_data_config,
|
1464
1604
|
:language_code,
|
@@ -1509,6 +1649,324 @@ module Aws::Comprehend
|
|
1509
1649
|
include Aws::Structure
|
1510
1650
|
end
|
1511
1651
|
|
1652
|
+
# Describes the annotations associated with a entity recognizer.
|
1653
|
+
#
|
1654
|
+
# @note When making an API call, you may pass EntityRecognizerAnnotations
|
1655
|
+
# data as a hash:
|
1656
|
+
#
|
1657
|
+
# {
|
1658
|
+
# s3_uri: "S3Uri", # required
|
1659
|
+
# }
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] s3_uri
|
1662
|
+
# Specifies the Amazon S3 location where the annotations for an entity
|
1663
|
+
# recognizer are located. The URI must be in the same region as the
|
1664
|
+
# API endpoint that you are calling.
|
1665
|
+
# @return [String]
|
1666
|
+
#
|
1667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerAnnotations AWS API Documentation
|
1668
|
+
#
|
1669
|
+
class EntityRecognizerAnnotations < Struct.new(
|
1670
|
+
:s3_uri)
|
1671
|
+
include Aws::Structure
|
1672
|
+
end
|
1673
|
+
|
1674
|
+
# Describes the training documents submitted with an entity recognizer.
|
1675
|
+
#
|
1676
|
+
# @note When making an API call, you may pass EntityRecognizerDocuments
|
1677
|
+
# data as a hash:
|
1678
|
+
#
|
1679
|
+
# {
|
1680
|
+
# s3_uri: "S3Uri", # required
|
1681
|
+
# }
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] s3_uri
|
1684
|
+
# Specifies the Amazon S3 location where the training documents for an
|
1685
|
+
# entity recognizer are located. The URI must be in the same region as
|
1686
|
+
# the API endpoint that you are calling.
|
1687
|
+
# @return [String]
|
1688
|
+
#
|
1689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerDocuments AWS API Documentation
|
1690
|
+
#
|
1691
|
+
class EntityRecognizerDocuments < Struct.new(
|
1692
|
+
:s3_uri)
|
1693
|
+
include Aws::Structure
|
1694
|
+
end
|
1695
|
+
|
1696
|
+
# Describes the entity recognizer submitted with an entity recognizer.
|
1697
|
+
#
|
1698
|
+
# @note When making an API call, you may pass EntityRecognizerEntityList
|
1699
|
+
# data as a hash:
|
1700
|
+
#
|
1701
|
+
# {
|
1702
|
+
# s3_uri: "S3Uri", # required
|
1703
|
+
# }
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] s3_uri
|
1706
|
+
# Specifies the Amazon S3 location where the entity list is located.
|
1707
|
+
# The URI must be in the same region as the API endpoint that you are
|
1708
|
+
# calling.
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEntityList AWS API Documentation
|
1712
|
+
#
|
1713
|
+
class EntityRecognizerEntityList < Struct.new(
|
1714
|
+
:s3_uri)
|
1715
|
+
include Aws::Structure
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# Detailed information about the accuracy of an entity recognizer.
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] precision
|
1721
|
+
# A measure of the usefulness of the recognizer results in the test
|
1722
|
+
# data. High precision means that the recognizer returned
|
1723
|
+
# substantially more relevant results than irrelevant ones.
|
1724
|
+
# @return [Float]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] recall
|
1727
|
+
# A measure of how complete the recognizer results are for the test
|
1728
|
+
# data. High recall means that the recognizer returned most of the
|
1729
|
+
# relevant results.
|
1730
|
+
# @return [Float]
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] f1_score
|
1733
|
+
# A measure of how accurate the recognizer results are for the test
|
1734
|
+
# data. It is derived from the `Precision` and `Recall` values. The
|
1735
|
+
# `F1Score` is the harmonic average of the two scores. The highest
|
1736
|
+
# score is 1, and the worst score is 0.
|
1737
|
+
# @return [Float]
|
1738
|
+
#
|
1739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEvaluationMetrics AWS API Documentation
|
1740
|
+
#
|
1741
|
+
class EntityRecognizerEvaluationMetrics < Struct.new(
|
1742
|
+
:precision,
|
1743
|
+
:recall,
|
1744
|
+
:f1_score)
|
1745
|
+
include Aws::Structure
|
1746
|
+
end
|
1747
|
+
|
1748
|
+
# Provides information for filtering a list of entity recognizers. You
|
1749
|
+
# can only specify one filtering parameter in a request. For more
|
1750
|
+
# information, see the operation./>
|
1751
|
+
#
|
1752
|
+
# @note When making an API call, you may pass EntityRecognizerFilter
|
1753
|
+
# data as a hash:
|
1754
|
+
#
|
1755
|
+
# {
|
1756
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
|
1757
|
+
# submit_time_before: Time.now,
|
1758
|
+
# submit_time_after: Time.now,
|
1759
|
+
# }
|
1760
|
+
#
|
1761
|
+
# @!attribute [rw] status
|
1762
|
+
# The status of an entity recognizer.
|
1763
|
+
# @return [String]
|
1764
|
+
#
|
1765
|
+
# @!attribute [rw] submit_time_before
|
1766
|
+
# Filters the list of entities based on the time that the list was
|
1767
|
+
# submitted for processing. Returns only jobs submitted before the
|
1768
|
+
# specified time. Jobs are returned in descending order, newest to
|
1769
|
+
# oldest.
|
1770
|
+
# @return [Time]
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] submit_time_after
|
1773
|
+
# Filters the list of entities based on the time that the list was
|
1774
|
+
# submitted for processing. Returns only jobs submitted after the
|
1775
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
1776
|
+
# newest.
|
1777
|
+
# @return [Time]
|
1778
|
+
#
|
1779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerFilter AWS API Documentation
|
1780
|
+
#
|
1781
|
+
class EntityRecognizerFilter < Struct.new(
|
1782
|
+
:status,
|
1783
|
+
:submit_time_before,
|
1784
|
+
:submit_time_after)
|
1785
|
+
include Aws::Structure
|
1786
|
+
end
|
1787
|
+
|
1788
|
+
# Specifies the format and location of the input data.
|
1789
|
+
#
|
1790
|
+
# @note When making an API call, you may pass EntityRecognizerInputDataConfig
|
1791
|
+
# data as a hash:
|
1792
|
+
#
|
1793
|
+
# {
|
1794
|
+
# entity_types: [ # required
|
1795
|
+
# {
|
1796
|
+
# type: "EntityTypeName", # required
|
1797
|
+
# },
|
1798
|
+
# ],
|
1799
|
+
# documents: { # required
|
1800
|
+
# s3_uri: "S3Uri", # required
|
1801
|
+
# },
|
1802
|
+
# annotations: {
|
1803
|
+
# s3_uri: "S3Uri", # required
|
1804
|
+
# },
|
1805
|
+
# entity_list: {
|
1806
|
+
# s3_uri: "S3Uri", # required
|
1807
|
+
# },
|
1808
|
+
# }
|
1809
|
+
#
|
1810
|
+
# @!attribute [rw] entity_types
|
1811
|
+
# The entity types in the input data for an entity recognizer.
|
1812
|
+
# @return [Array<Types::EntityTypesListItem>]
|
1813
|
+
#
|
1814
|
+
# @!attribute [rw] documents
|
1815
|
+
# S3 location of the documents folder for an entity recognizer
|
1816
|
+
# @return [Types::EntityRecognizerDocuments]
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] annotations
|
1819
|
+
# S3 location of the annotations file for an entity recognizer.
|
1820
|
+
# @return [Types::EntityRecognizerAnnotations]
|
1821
|
+
#
|
1822
|
+
# @!attribute [rw] entity_list
|
1823
|
+
# S3 location of the entity list for an entity recognizer.
|
1824
|
+
# @return [Types::EntityRecognizerEntityList]
|
1825
|
+
#
|
1826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerInputDataConfig AWS API Documentation
|
1827
|
+
#
|
1828
|
+
class EntityRecognizerInputDataConfig < Struct.new(
|
1829
|
+
:entity_types,
|
1830
|
+
:documents,
|
1831
|
+
:annotations,
|
1832
|
+
:entity_list)
|
1833
|
+
include Aws::Structure
|
1834
|
+
end
|
1835
|
+
|
1836
|
+
# Detailed information about an entity recognizer.
|
1837
|
+
#
|
1838
|
+
# @!attribute [rw] number_of_trained_documents
|
1839
|
+
# The number of documents in the input data that were used to train
|
1840
|
+
# the entity recognizer. Typically this is 80 to 90 percent of the
|
1841
|
+
# input documents.
|
1842
|
+
# @return [Integer]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] number_of_test_documents
|
1845
|
+
# The number of documents in the input data that were used to test the
|
1846
|
+
# entity recognizer. Typically this is 10 to 20 percent of the input
|
1847
|
+
# documents.
|
1848
|
+
# @return [Integer]
|
1849
|
+
#
|
1850
|
+
# @!attribute [rw] evaluation_metrics
|
1851
|
+
# Detailed information about the accuracy of an entity recognizer.
|
1852
|
+
# @return [Types::EntityRecognizerEvaluationMetrics]
|
1853
|
+
#
|
1854
|
+
# @!attribute [rw] entity_types
|
1855
|
+
# Entity types from the metadata of an entity recognizer.
|
1856
|
+
# @return [Array<Types::EntityRecognizerMetadataEntityTypesListItem>]
|
1857
|
+
#
|
1858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerMetadata AWS API Documentation
|
1859
|
+
#
|
1860
|
+
class EntityRecognizerMetadata < Struct.new(
|
1861
|
+
:number_of_trained_documents,
|
1862
|
+
:number_of_test_documents,
|
1863
|
+
:evaluation_metrics,
|
1864
|
+
:entity_types)
|
1865
|
+
include Aws::Structure
|
1866
|
+
end
|
1867
|
+
|
1868
|
+
# Individual item from the list of entity types in the metadata of an
|
1869
|
+
# entity recognizer.
|
1870
|
+
#
|
1871
|
+
# @!attribute [rw] type
|
1872
|
+
# Type of entity from the list of entity types in the metadata of an
|
1873
|
+
# entity recognizer.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerMetadataEntityTypesListItem AWS API Documentation
|
1877
|
+
#
|
1878
|
+
class EntityRecognizerMetadataEntityTypesListItem < Struct.new(
|
1879
|
+
:type)
|
1880
|
+
include Aws::Structure
|
1881
|
+
end
|
1882
|
+
|
1883
|
+
# Describes information about an entity recognizer.
|
1884
|
+
#
|
1885
|
+
# @!attribute [rw] entity_recognizer_arn
|
1886
|
+
# The Amazon Resource Name (ARN) that identifies the entity
|
1887
|
+
# recognizer.
|
1888
|
+
# @return [String]
|
1889
|
+
#
|
1890
|
+
# @!attribute [rw] language_code
|
1891
|
+
# The language of the input documents. All documents must be in the
|
1892
|
+
# same language. Only English ("en") is currently supported.
|
1893
|
+
# @return [String]
|
1894
|
+
#
|
1895
|
+
# @!attribute [rw] status
|
1896
|
+
# Provides the status of the entity recognizer.
|
1897
|
+
# @return [String]
|
1898
|
+
#
|
1899
|
+
# @!attribute [rw] message
|
1900
|
+
# A description of the status of the recognizer.
|
1901
|
+
# @return [String]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] submit_time
|
1904
|
+
# The time that the recognizer was submitted for processing.
|
1905
|
+
# @return [Time]
|
1906
|
+
#
|
1907
|
+
# @!attribute [rw] end_time
|
1908
|
+
# The time that the recognizer creation completed.
|
1909
|
+
# @return [Time]
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] training_start_time
|
1912
|
+
# The time that training of the entity recognizer started.
|
1913
|
+
# @return [Time]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] training_end_time
|
1916
|
+
# The time that training of the entity recognizer was completed.
|
1917
|
+
# @return [Time]
|
1918
|
+
#
|
1919
|
+
# @!attribute [rw] input_data_config
|
1920
|
+
# The input data properties of an entity recognizer.
|
1921
|
+
# @return [Types::EntityRecognizerInputDataConfig]
|
1922
|
+
#
|
1923
|
+
# @!attribute [rw] recognizer_metadata
|
1924
|
+
# Provides information about an entity recognizer.
|
1925
|
+
# @return [Types::EntityRecognizerMetadata]
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] data_access_role_arn
|
1928
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
1929
|
+
# (IAM) role that grants Amazon Comprehend read access to your input
|
1930
|
+
# data.
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
|
1934
|
+
#
|
1935
|
+
class EntityRecognizerProperties < Struct.new(
|
1936
|
+
:entity_recognizer_arn,
|
1937
|
+
:language_code,
|
1938
|
+
:status,
|
1939
|
+
:message,
|
1940
|
+
:submit_time,
|
1941
|
+
:end_time,
|
1942
|
+
:training_start_time,
|
1943
|
+
:training_end_time,
|
1944
|
+
:input_data_config,
|
1945
|
+
:recognizer_metadata,
|
1946
|
+
:data_access_role_arn)
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# Information about an individual item on a list of entity types.
|
1951
|
+
#
|
1952
|
+
# @note When making an API call, you may pass EntityTypesListItem
|
1953
|
+
# data as a hash:
|
1954
|
+
#
|
1955
|
+
# {
|
1956
|
+
# type: "EntityTypeName", # required
|
1957
|
+
# }
|
1958
|
+
#
|
1959
|
+
# @!attribute [rw] type
|
1960
|
+
# Entity type of an item on an entity type list.
|
1961
|
+
# @return [String]
|
1962
|
+
#
|
1963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem AWS API Documentation
|
1964
|
+
#
|
1965
|
+
class EntityTypesListItem < Struct.new(
|
1966
|
+
:type)
|
1967
|
+
include Aws::Structure
|
1968
|
+
end
|
1969
|
+
|
1512
1970
|
# The input properties for a topic detection job.
|
1513
1971
|
#
|
1514
1972
|
# @note When making an API call, you may pass InputDataConfig
|
@@ -1913,6 +2371,59 @@ module Aws::Comprehend
|
|
1913
2371
|
include Aws::Structure
|
1914
2372
|
end
|
1915
2373
|
|
2374
|
+
# @note When making an API call, you may pass ListEntityRecognizersRequest
|
2375
|
+
# data as a hash:
|
2376
|
+
#
|
2377
|
+
# {
|
2378
|
+
# filter: {
|
2379
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
|
2380
|
+
# submit_time_before: Time.now,
|
2381
|
+
# submit_time_after: Time.now,
|
2382
|
+
# },
|
2383
|
+
# next_token: "String",
|
2384
|
+
# max_results: 1,
|
2385
|
+
# }
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] filter
|
2388
|
+
# Filters the list of entities returned. You can filter on `Status`,
|
2389
|
+
# `SubmitTimeBefore`, or `SubmitTimeAfter`. You can only set one
|
2390
|
+
# filter at a time.
|
2391
|
+
# @return [Types::EntityRecognizerFilter]
|
2392
|
+
#
|
2393
|
+
# @!attribute [rw] next_token
|
2394
|
+
# Identifies the next page of results to return.
|
2395
|
+
# @return [String]
|
2396
|
+
#
|
2397
|
+
# @!attribute [rw] max_results
|
2398
|
+
# The maximum number of results to return on each page. The default is
|
2399
|
+
# 100.
|
2400
|
+
# @return [Integer]
|
2401
|
+
#
|
2402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizersRequest AWS API Documentation
|
2403
|
+
#
|
2404
|
+
class ListEntityRecognizersRequest < Struct.new(
|
2405
|
+
:filter,
|
2406
|
+
:next_token,
|
2407
|
+
:max_results)
|
2408
|
+
include Aws::Structure
|
2409
|
+
end
|
2410
|
+
|
2411
|
+
# @!attribute [rw] entity_recognizer_properties_list
|
2412
|
+
# The list of properties of an entity recognizer.
|
2413
|
+
# @return [Array<Types::EntityRecognizerProperties>]
|
2414
|
+
#
|
2415
|
+
# @!attribute [rw] next_token
|
2416
|
+
# Identifies the next page of results to return.
|
2417
|
+
# @return [String]
|
2418
|
+
#
|
2419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizersResponse AWS API Documentation
|
2420
|
+
#
|
2421
|
+
class ListEntityRecognizersResponse < Struct.new(
|
2422
|
+
:entity_recognizer_properties_list,
|
2423
|
+
:next_token)
|
2424
|
+
include Aws::Structure
|
2425
|
+
end
|
2426
|
+
|
1916
2427
|
# @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
|
1917
2428
|
# data as a hash:
|
1918
2429
|
#
|
@@ -2459,6 +2970,7 @@ module Aws::Comprehend
|
|
2459
2970
|
# },
|
2460
2971
|
# data_access_role_arn: "IamRoleArn", # required
|
2461
2972
|
# job_name: "JobName",
|
2973
|
+
# entity_recognizer_arn: "EntityRecognizerArn",
|
2462
2974
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt
|
2463
2975
|
# client_request_token: "ClientRequestTokenString",
|
2464
2976
|
# }
|
@@ -2486,6 +2998,12 @@ module Aws::Comprehend
|
|
2486
2998
|
# The identifier of the job.
|
2487
2999
|
# @return [String]
|
2488
3000
|
#
|
3001
|
+
# @!attribute [rw] entity_recognizer_arn
|
3002
|
+
# The Amazon Resource Name (ARN) that identifies the specific entity
|
3003
|
+
# recognizer to be used by the `StartEntitiesDetectionJob`. This ARN
|
3004
|
+
# is optional and is only used for a custom entity recognition job.
|
3005
|
+
# @return [String]
|
3006
|
+
#
|
2489
3007
|
# @!attribute [rw] language_code
|
2490
3008
|
# The language of the input documents. All documents must be in the
|
2491
3009
|
# same language. You can specify any of the languages supported by
|
@@ -2510,6 +3028,7 @@ module Aws::Comprehend
|
|
2510
3028
|
:output_data_config,
|
2511
3029
|
:data_access_role_arn,
|
2512
3030
|
:job_name,
|
3031
|
+
:entity_recognizer_arn,
|
2513
3032
|
:language_code,
|
2514
3033
|
:client_request_token)
|
2515
3034
|
include Aws::Structure
|