aws-sdk-comprehend 1.27.0 → 1.32.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 8af6730466ffa724762d57c8da0bfffa77d80ead
4
- data.tar.gz: c799744b9ea369f2c288d9907181f608179f22b1
2
+ SHA256:
3
+ metadata.gz: 88507252bd7d574910b1fb93e096de5243d0418ef747eaf004c3a5b5b09f51a0
4
+ data.tar.gz: 575459559b1e04b95ed9dab7006453d76d53b54096a531b6f04f3186da9209b9
5
5
  SHA512:
6
- metadata.gz: 9b4b04cdcc1f2d8733688afd98b159eb1d3d263aca3c8adefe93f5dae1a5c0b87c8479e498928b1cdd1ebd2a13a47716c2954b62b85115250ba1ac0d39b6fd3c
7
- data.tar.gz: 3e565534e4d90f0a33f599f758404f3264a84c74216a98d536eccb1c9db2db5c4040d993521ea439988d448da52c6788cd4c30161c1395e696204f0d920d808d
6
+ metadata.gz: 0bf8ae20c3106a01c223a5c0947092671101376377ee1b5e0d485ea1114fb20ca7e15ac87009eadd6336629b38e2610dad13ba30cb0b69ae8c672b4da7dabf70
7
+ data.tar.gz: 780ecb883b5463082f98b2a0544478ed541d5409888b281e576f5b16ef03cc19f251be06412f21527b8be9d754c9d47eb6160661f3dfab420d97cfd6541f7546
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-comprehend/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # comprehend = Aws::Comprehend::Client.new
28
+ # resp = comprehend.batch_detect_dominant_language(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Comprehend all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Comprehend are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Comprehend::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Comprehend API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-comprehend/customizations'
42
45
  # @service
43
46
  module Aws::Comprehend
44
47
 
45
- GEM_VERSION = '1.27.0'
48
+ GEM_VERSION = '1.32.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:comprehend)
31
31
 
32
32
  module Aws::Comprehend
33
+ # An API client for Comprehend. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Comprehend::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::Comprehend
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::Comprehend
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::Comprehend
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::Comprehend
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::Comprehend
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::Comprehend
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::Comprehend
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::Comprehend
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::Comprehend
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -321,9 +375,8 @@ module Aws::Comprehend
321
375
  #
322
376
  # @option params [required, String] :language_code
323
377
  # The language of the input documents. You can specify any of the
324
- # primary languages supported by Amazon Comprehend: German ("de"),
325
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
326
- # or Portuguese ("pt"). All documents must be in the same language.
378
+ # primary languages supported by Amazon Comprehend. All documents must
379
+ # be in the same language.
327
380
  #
328
381
  # @return [Types::BatchDetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
329
382
  #
@@ -370,9 +423,8 @@ module Aws::Comprehend
370
423
  #
371
424
  # @option params [required, String] :language_code
372
425
  # The language of the input documents. You can specify any of the
373
- # primary languages supported by Amazon Comprehend: German ("de"),
374
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
375
- # or Portuguese ("pt"). All documents must be in the same language.
426
+ # primary languages supported by Amazon Comprehend. All documents must
427
+ # be in the same language.
376
428
  #
377
429
  # @return [Types::BatchDetectKeyPhrasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
430
  #
@@ -420,9 +472,8 @@ module Aws::Comprehend
420
472
  #
421
473
  # @option params [required, String] :language_code
422
474
  # The language of the input documents. You can specify any of the
423
- # primary languages supported by Amazon Comprehend: German ("de"),
424
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
425
- # or Portuguese ("pt"). All documents must be in the same language.
475
+ # primary languages supported by Amazon Comprehend. All documents must
476
+ # be in the same language.
426
477
  #
427
478
  # @return [Types::BatchDetectSentimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
428
479
  #
@@ -470,7 +521,7 @@ module Aws::Comprehend
470
521
  #
471
522
  # @option params [required, String] :language_code
472
523
  # The language of the input documents. You can specify any of the
473
- # primary languages supported by Amazon Comprehend: German ("de"),
524
+ # following languages supported by Amazon Comprehend: German ("de"),
474
525
  # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
475
526
  # or Portuguese ("pt"). All documents must be in the same language.
476
527
  #
@@ -511,6 +562,46 @@ module Aws::Comprehend
511
562
  req.send_request(options)
512
563
  end
513
564
 
565
+ # Creates a new document classification request to analyze a single
566
+ # document in real-time, using a previously created and trained custom
567
+ # model and an endpoint.
568
+ #
569
+ # @option params [required, String] :text
570
+ # The document text to be analyzed.
571
+ #
572
+ # @option params [required, String] :endpoint_arn
573
+ # The Amazon Resource Number (ARN) of the endpoint.
574
+ #
575
+ # @return [Types::ClassifyDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
576
+ #
577
+ # * {Types::ClassifyDocumentResponse#classes #classes} => Array&lt;Types::DocumentClass&gt;
578
+ # * {Types::ClassifyDocumentResponse#labels #labels} => Array&lt;Types::DocumentLabel&gt;
579
+ #
580
+ # @example Request syntax with placeholder values
581
+ #
582
+ # resp = client.classify_document({
583
+ # text: "String", # required
584
+ # endpoint_arn: "DocumentClassifierEndpointArn", # required
585
+ # })
586
+ #
587
+ # @example Response structure
588
+ #
589
+ # resp.classes #=> Array
590
+ # resp.classes[0].name #=> String
591
+ # resp.classes[0].score #=> Float
592
+ # resp.labels #=> Array
593
+ # resp.labels[0].name #=> String
594
+ # resp.labels[0].score #=> Float
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument AWS API Documentation
597
+ #
598
+ # @overload classify_document(params = {})
599
+ # @param [Hash] params ({})
600
+ def classify_document(params = {}, options = {})
601
+ req = build_request(:classify_document, params)
602
+ req.send_request(options)
603
+ end
604
+
514
605
  # Creates a new document classifier that you can use to categorize
515
606
  # documents. To create a classifier you provide a set of training
516
607
  # documents that labeled with the categories that you want to use. After
@@ -548,7 +639,7 @@ module Aws::Comprehend
548
639
  #
549
640
  # @option params [required, String] :language_code
550
641
  # The language of the input documents. You can specify any of the
551
- # primary languages supported by Amazon Comprehend: German ("de"),
642
+ # following languages supported by Amazon Comprehend: German ("de"),
552
643
  # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
553
644
  # or Portuguese ("pt"). All documents must be in the same language.
554
645
  #
@@ -572,6 +663,14 @@ module Aws::Comprehend
572
663
  #
573
664
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
574
665
  #
666
+ # @option params [String] :mode
667
+ # Indicates the mode in which the classifier will be trained. The
668
+ # classifier can be trained in multi-class mode, which identifies one
669
+ # and only one class for each document, or multi-label mode, which
670
+ # identifies one or more labels for each document. In multi-label mode,
671
+ # multiple labels for an individual document are separated by a
672
+ # delimiter. The default delimiter between labels is a pipe (\|).
673
+ #
575
674
  # @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
576
675
  #
577
676
  # * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
@@ -589,6 +688,7 @@ module Aws::Comprehend
589
688
  # ],
590
689
  # input_data_config: { # required
591
690
  # s3_uri: "S3Uri", # required
691
+ # label_delimiter: "LabelDelimiter",
592
692
  # },
593
693
  # output_data_config: {
594
694
  # s3_uri: "S3Uri",
@@ -601,6 +701,7 @@ module Aws::Comprehend
601
701
  # security_group_ids: ["SecurityGroupId"], # required
602
702
  # subnets: ["SubnetId"], # required
603
703
  # },
704
+ # mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
604
705
  # })
605
706
  #
606
707
  # @example Response structure
@@ -616,6 +717,68 @@ module Aws::Comprehend
616
717
  req.send_request(options)
617
718
  end
618
719
 
720
+ # Creates a model-specific endpoint for synchronous inference for a
721
+ # previously trained custom model
722
+ #
723
+ # @option params [required, String] :endpoint_name
724
+ # This is the descriptive suffix that becomes part of the `EndpointArn`
725
+ # used for all subsequent requests to this resource.
726
+ #
727
+ # @option params [required, String] :model_arn
728
+ # The Amazon Resource Number (ARN) of the model to which the endpoint
729
+ # will be attached.
730
+ #
731
+ # @option params [required, Integer] :desired_inference_units
732
+ # The desired number of inference units to be used by the model using
733
+ # this endpoint. Each inference unit represents of a throughput of 100
734
+ # characters per second.
735
+ #
736
+ # @option params [String] :client_request_token
737
+ # An idempotency token provided by the customer. If this token matches a
738
+ # previous endpoint creation request, Amazon Comprehend will not return
739
+ # a `ResourceInUseException`.
740
+ #
741
+ # **A suitable default value is auto-generated.** You should normally
742
+ # not need to pass this option.**
743
+ #
744
+ # @option params [Array<Types::Tag>] :tags
745
+ # Tags associated with the endpoint being created. A tag is a key-value
746
+ # pair that adds metadata to the endpoint. For example, a tag with
747
+ # "Sales" as the key might be added to an endpoint to indicate its use
748
+ # by the sales department.
749
+ #
750
+ # @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
751
+ #
752
+ # * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
753
+ #
754
+ # @example Request syntax with placeholder values
755
+ #
756
+ # resp = client.create_endpoint({
757
+ # endpoint_name: "ComprehendEndpointName", # required
758
+ # model_arn: "ComprehendModelArn", # required
759
+ # desired_inference_units: 1, # required
760
+ # client_request_token: "ClientRequestTokenString",
761
+ # tags: [
762
+ # {
763
+ # key: "TagKey", # required
764
+ # value: "TagValue",
765
+ # },
766
+ # ],
767
+ # })
768
+ #
769
+ # @example Response structure
770
+ #
771
+ # resp.endpoint_arn #=> String
772
+ #
773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpoint AWS API Documentation
774
+ #
775
+ # @overload create_endpoint(params = {})
776
+ # @param [Hash] params ({})
777
+ def create_endpoint(params = {}, options = {})
778
+ req = build_request(:create_endpoint, params)
779
+ req.send_request(options)
780
+ end
781
+
619
782
  # Creates an entity recognizer using submitted files. After your
620
783
  # `CreateEntityRecognizer` request is submitted, you can check job
621
784
  # status using the API.
@@ -758,6 +921,30 @@ module Aws::Comprehend
758
921
  req.send_request(options)
759
922
  end
760
923
 
924
+ # Deletes a model-specific endpoint for a previously-trained custom
925
+ # model. All endpoints must be deleted in order for the model to be
926
+ # deleted.
927
+ #
928
+ # @option params [required, String] :endpoint_arn
929
+ # The Amazon Resource Number (ARN) of the endpoint being deleted.
930
+ #
931
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
932
+ #
933
+ # @example Request syntax with placeholder values
934
+ #
935
+ # resp = client.delete_endpoint({
936
+ # endpoint_arn: "ComprehendEndpointArn", # required
937
+ # })
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEndpoint AWS API Documentation
940
+ #
941
+ # @overload delete_endpoint(params = {})
942
+ # @param [Hash] params ({})
943
+ def delete_endpoint(params = {}, options = {})
944
+ req = build_request(:delete_endpoint, params)
945
+ req.send_request(options)
946
+ end
947
+
761
948
  # Deletes an entity recognizer.
762
949
  #
763
950
  # Only those recognizers that are in terminated states (IN\_ERROR,
@@ -862,6 +1049,7 @@ module Aws::Comprehend
862
1049
  # resp.document_classifier_properties.training_start_time #=> Time
863
1050
  # resp.document_classifier_properties.training_end_time #=> Time
864
1051
  # resp.document_classifier_properties.input_data_config.s3_uri #=> String
1052
+ # resp.document_classifier_properties.input_data_config.label_delimiter #=> String
865
1053
  # resp.document_classifier_properties.output_data_config.s3_uri #=> String
866
1054
  # resp.document_classifier_properties.output_data_config.kms_key_id #=> String
867
1055
  # resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
@@ -871,12 +1059,17 @@ module Aws::Comprehend
871
1059
  # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.precision #=> Float
872
1060
  # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.recall #=> Float
873
1061
  # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.f1_score #=> Float
1062
+ # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_precision #=> Float
1063
+ # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_recall #=> Float
1064
+ # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_f1_score #=> Float
1065
+ # resp.document_classifier_properties.classifier_metadata.evaluation_metrics.hamming_loss #=> Float
874
1066
  # resp.document_classifier_properties.data_access_role_arn #=> String
875
1067
  # resp.document_classifier_properties.volume_kms_key_id #=> String
876
1068
  # resp.document_classifier_properties.vpc_config.security_group_ids #=> Array
877
1069
  # resp.document_classifier_properties.vpc_config.security_group_ids[0] #=> String
878
1070
  # resp.document_classifier_properties.vpc_config.subnets #=> Array
879
1071
  # resp.document_classifier_properties.vpc_config.subnets[0] #=> String
1072
+ # resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
880
1073
  #
881
1074
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
882
1075
  #
@@ -932,6 +1125,42 @@ module Aws::Comprehend
932
1125
  req.send_request(options)
933
1126
  end
934
1127
 
1128
+ # Gets the properties associated with a specific endpoint. Use this
1129
+ # operation to get the status of an endpoint.
1130
+ #
1131
+ # @option params [required, String] :endpoint_arn
1132
+ # The Amazon Resource Number (ARN) of the endpoint being described.
1133
+ #
1134
+ # @return [Types::DescribeEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1135
+ #
1136
+ # * {Types::DescribeEndpointResponse#endpoint_properties #endpoint_properties} => Types::EndpointProperties
1137
+ #
1138
+ # @example Request syntax with placeholder values
1139
+ #
1140
+ # resp = client.describe_endpoint({
1141
+ # endpoint_arn: "ComprehendEndpointArn", # required
1142
+ # })
1143
+ #
1144
+ # @example Response structure
1145
+ #
1146
+ # resp.endpoint_properties.endpoint_arn #=> String
1147
+ # resp.endpoint_properties.status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
1148
+ # resp.endpoint_properties.message #=> String
1149
+ # resp.endpoint_properties.model_arn #=> String
1150
+ # resp.endpoint_properties.desired_inference_units #=> Integer
1151
+ # resp.endpoint_properties.current_inference_units #=> Integer
1152
+ # resp.endpoint_properties.creation_time #=> Time
1153
+ # resp.endpoint_properties.last_modified_time #=> Time
1154
+ #
1155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
1156
+ #
1157
+ # @overload describe_endpoint(params = {})
1158
+ # @param [Hash] params ({})
1159
+ def describe_endpoint(params = {}, options = {})
1160
+ req = build_request(:describe_endpoint, params)
1161
+ req.send_request(options)
1162
+ end
1163
+
935
1164
  # Gets the properties associated with an entities detection job. Use
936
1165
  # this operation to get the status of a detection job.
937
1166
  #
@@ -1221,9 +1450,8 @@ module Aws::Comprehend
1221
1450
  #
1222
1451
  # @option params [required, String] :language_code
1223
1452
  # The language of the input documents. You can specify any of the
1224
- # primary languages supported by Amazon Comprehend: German ("de"),
1225
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
1226
- # or Portuguese ("pt"). All documents must be in the same language.
1453
+ # primary languages supported by Amazon Comprehend. All documents must
1454
+ # be in the same language.
1227
1455
  #
1228
1456
  # @return [Types::DetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1229
1457
  #
@@ -1262,9 +1490,8 @@ module Aws::Comprehend
1262
1490
  #
1263
1491
  # @option params [required, String] :language_code
1264
1492
  # The language of the input documents. You can specify any of the
1265
- # primary languages supported by Amazon Comprehend: German ("de"),
1266
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
1267
- # or Portuguese ("pt"). All documents must be in the same language.
1493
+ # primary languages supported by Amazon Comprehend. All documents must
1494
+ # be in the same language.
1268
1495
  #
1269
1496
  # @return [Types::DetectKeyPhrasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1270
1497
  #
@@ -1303,9 +1530,8 @@ module Aws::Comprehend
1303
1530
  #
1304
1531
  # @option params [required, String] :language_code
1305
1532
  # The language of the input documents. You can specify any of the
1306
- # primary languages supported by Amazon Comprehend: German ("de"),
1307
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
1308
- # or Portuguese ("pt"). All documents must be in the same language.
1533
+ # primary languages supported by Amazon Comprehend. All documents must
1534
+ # be in the same language.
1309
1535
  #
1310
1536
  # @return [Types::DetectSentimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1311
1537
  #
@@ -1345,7 +1571,7 @@ module Aws::Comprehend
1345
1571
  #
1346
1572
  # @option params [required, String] :language_code
1347
1573
  # The language code of the input documents. You can specify any of the
1348
- # primary languages supported by Amazon Comprehend: German ("de"),
1574
+ # following languages supported by Amazon Comprehend: German ("de"),
1349
1575
  # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
1350
1576
  # or Portuguese ("pt").
1351
1577
  #
@@ -1399,6 +1625,8 @@ module Aws::Comprehend
1399
1625
  # * {Types::ListDocumentClassificationJobsResponse#document_classification_job_properties_list #document_classification_job_properties_list} => Array&lt;Types::DocumentClassificationJobProperties&gt;
1400
1626
  # * {Types::ListDocumentClassificationJobsResponse#next_token #next_token} => String
1401
1627
  #
1628
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1629
+ #
1402
1630
  # @example Request syntax with placeholder values
1403
1631
  #
1404
1632
  # resp = client.list_document_classification_jobs({
@@ -1462,6 +1690,8 @@ module Aws::Comprehend
1462
1690
  # * {Types::ListDocumentClassifiersResponse#document_classifier_properties_list #document_classifier_properties_list} => Array&lt;Types::DocumentClassifierProperties&gt;
1463
1691
  # * {Types::ListDocumentClassifiersResponse#next_token #next_token} => String
1464
1692
  #
1693
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1694
+ #
1465
1695
  # @example Request syntax with placeholder values
1466
1696
  #
1467
1697
  # resp = client.list_document_classifiers({
@@ -1486,6 +1716,7 @@ module Aws::Comprehend
1486
1716
  # resp.document_classifier_properties_list[0].training_start_time #=> Time
1487
1717
  # resp.document_classifier_properties_list[0].training_end_time #=> Time
1488
1718
  # resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
1719
+ # resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
1489
1720
  # resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
1490
1721
  # resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
1491
1722
  # resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
@@ -1495,12 +1726,17 @@ module Aws::Comprehend
1495
1726
  # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.precision #=> Float
1496
1727
  # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.recall #=> Float
1497
1728
  # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.f1_score #=> Float
1729
+ # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_precision #=> Float
1730
+ # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_recall #=> Float
1731
+ # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_f1_score #=> Float
1732
+ # resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.hamming_loss #=> Float
1498
1733
  # resp.document_classifier_properties_list[0].data_access_role_arn #=> String
1499
1734
  # resp.document_classifier_properties_list[0].volume_kms_key_id #=> String
1500
1735
  # resp.document_classifier_properties_list[0].vpc_config.security_group_ids #=> Array
1501
1736
  # resp.document_classifier_properties_list[0].vpc_config.security_group_ids[0] #=> String
1502
1737
  # resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
1503
1738
  # resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
1739
+ # resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
1504
1740
  # resp.next_token #=> String
1505
1741
  #
1506
1742
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
@@ -1532,6 +1768,8 @@ module Aws::Comprehend
1532
1768
  # * {Types::ListDominantLanguageDetectionJobsResponse#dominant_language_detection_job_properties_list #dominant_language_detection_job_properties_list} => Array&lt;Types::DominantLanguageDetectionJobProperties&gt;
1533
1769
  # * {Types::ListDominantLanguageDetectionJobsResponse#next_token #next_token} => String
1534
1770
  #
1771
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1772
+ #
1535
1773
  # @example Request syntax with placeholder values
1536
1774
  #
1537
1775
  # resp = client.list_dominant_language_detection_jobs({
@@ -1575,6 +1813,60 @@ module Aws::Comprehend
1575
1813
  req.send_request(options)
1576
1814
  end
1577
1815
 
1816
+ # Gets a list of all existing endpoints that you've created.
1817
+ #
1818
+ # @option params [Types::EndpointFilter] :filter
1819
+ # Filters the endpoints that are returned. You can filter endpoints on
1820
+ # their name, model, status, or the date and time that they were
1821
+ # created. You can only set one filter at a time.
1822
+ #
1823
+ # @option params [String] :next_token
1824
+ # Identifies the next page of results to return.
1825
+ #
1826
+ # @option params [Integer] :max_results
1827
+ # The maximum number of results to return in each page. The default is
1828
+ # 100.
1829
+ #
1830
+ # @return [Types::ListEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1831
+ #
1832
+ # * {Types::ListEndpointsResponse#endpoint_properties_list #endpoint_properties_list} => Array&lt;Types::EndpointProperties&gt;
1833
+ # * {Types::ListEndpointsResponse#next_token #next_token} => String
1834
+ #
1835
+ # @example Request syntax with placeholder values
1836
+ #
1837
+ # resp = client.list_endpoints({
1838
+ # filter: {
1839
+ # model_arn: "ComprehendModelArn",
1840
+ # status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
1841
+ # creation_time_before: Time.now,
1842
+ # creation_time_after: Time.now,
1843
+ # },
1844
+ # next_token: "String",
1845
+ # max_results: 1,
1846
+ # })
1847
+ #
1848
+ # @example Response structure
1849
+ #
1850
+ # resp.endpoint_properties_list #=> Array
1851
+ # resp.endpoint_properties_list[0].endpoint_arn #=> String
1852
+ # resp.endpoint_properties_list[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
1853
+ # resp.endpoint_properties_list[0].message #=> String
1854
+ # resp.endpoint_properties_list[0].model_arn #=> String
1855
+ # resp.endpoint_properties_list[0].desired_inference_units #=> Integer
1856
+ # resp.endpoint_properties_list[0].current_inference_units #=> Integer
1857
+ # resp.endpoint_properties_list[0].creation_time #=> Time
1858
+ # resp.endpoint_properties_list[0].last_modified_time #=> Time
1859
+ # resp.next_token #=> String
1860
+ #
1861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
1862
+ #
1863
+ # @overload list_endpoints(params = {})
1864
+ # @param [Hash] params ({})
1865
+ def list_endpoints(params = {}, options = {})
1866
+ req = build_request(:list_endpoints, params)
1867
+ req.send_request(options)
1868
+ end
1869
+
1578
1870
  # Gets a list of the entity detection jobs that you have submitted.
1579
1871
  #
1580
1872
  # @option params [Types::EntitiesDetectionJobFilter] :filter
@@ -1594,6 +1886,8 @@ module Aws::Comprehend
1594
1886
  # * {Types::ListEntitiesDetectionJobsResponse#entities_detection_job_properties_list #entities_detection_job_properties_list} => Array&lt;Types::EntitiesDetectionJobProperties&gt;
1595
1887
  # * {Types::ListEntitiesDetectionJobsResponse#next_token #next_token} => String
1596
1888
  #
1889
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1890
+ #
1597
1891
  # @example Request syntax with placeholder values
1598
1892
  #
1599
1893
  # resp = client.list_entities_detection_jobs({
@@ -1665,6 +1959,8 @@ module Aws::Comprehend
1665
1959
  # * {Types::ListEntityRecognizersResponse#entity_recognizer_properties_list #entity_recognizer_properties_list} => Array&lt;Types::EntityRecognizerProperties&gt;
1666
1960
  # * {Types::ListEntityRecognizersResponse#next_token #next_token} => String
1667
1961
  #
1962
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1963
+ #
1668
1964
  # @example Request syntax with placeholder values
1669
1965
  #
1670
1966
  # resp = client.list_entity_recognizers({
@@ -1740,6 +2036,8 @@ module Aws::Comprehend
1740
2036
  # * {Types::ListKeyPhrasesDetectionJobsResponse#key_phrases_detection_job_properties_list #key_phrases_detection_job_properties_list} => Array&lt;Types::KeyPhrasesDetectionJobProperties&gt;
1741
2037
  # * {Types::ListKeyPhrasesDetectionJobsResponse#next_token #next_token} => String
1742
2038
  #
2039
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2040
+ #
1743
2041
  # @example Request syntax with placeholder values
1744
2042
  #
1745
2043
  # resp = client.list_key_phrases_detection_jobs({
@@ -1803,6 +2101,8 @@ module Aws::Comprehend
1803
2101
  # * {Types::ListSentimentDetectionJobsResponse#sentiment_detection_job_properties_list #sentiment_detection_job_properties_list} => Array&lt;Types::SentimentDetectionJobProperties&gt;
1804
2102
  # * {Types::ListSentimentDetectionJobsResponse#next_token #next_token} => String
1805
2103
  #
2104
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2105
+ #
1806
2106
  # @example Request syntax with placeholder values
1807
2107
  #
1808
2108
  # resp = client.list_sentiment_detection_jobs({
@@ -1899,6 +2199,8 @@ module Aws::Comprehend
1899
2199
  # * {Types::ListTopicsDetectionJobsResponse#topics_detection_job_properties_list #topics_detection_job_properties_list} => Array&lt;Types::TopicsDetectionJobProperties&gt;
1900
2200
  # * {Types::ListTopicsDetectionJobsResponse#next_token #next_token} => String
1901
2201
  #
2202
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2203
+ #
1902
2204
  # @example Request syntax with placeholder values
1903
2205
  #
1904
2206
  # resp = client.list_topics_detection_jobs({
@@ -2157,10 +2459,8 @@ module Aws::Comprehend
2157
2459
  # @option params [required, String] :language_code
2158
2460
  # The language of the input documents. All documents must be in the same
2159
2461
  # language. You can specify any of the languages supported by Amazon
2160
- # Comprehend: English ("en"), Spanish ("es"), French ("fr"),
2161
- # German ("de"), Italian ("it"), or Portuguese ("pt"). If custom
2162
- # entities recognition is used, this parameter is ignored and the
2163
- # language used for training the model is used instead.
2462
+ # Comprehend. If custom entities recognition is used, this parameter is
2463
+ # ignored and the language used for training the model is used instead.
2164
2464
  #
2165
2465
  # @option params [String] :client_request_token
2166
2466
  # A unique identifier for the request. If you don't set the client
@@ -2255,9 +2555,8 @@ module Aws::Comprehend
2255
2555
  #
2256
2556
  # @option params [required, String] :language_code
2257
2557
  # The language of the input documents. You can specify any of the
2258
- # primary languages supported by Amazon Comprehend: German ("de"),
2259
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
2260
- # or Portuguese ("pt"). All documents must be in the same language.
2558
+ # primary languages supported by Amazon Comprehend. All documents must
2559
+ # be in the same language.
2261
2560
  #
2262
2561
  # @option params [String] :client_request_token
2263
2562
  # A unique identifier for the request. If you don't set the client
@@ -2351,9 +2650,8 @@ module Aws::Comprehend
2351
2650
  #
2352
2651
  # @option params [required, String] :language_code
2353
2652
  # The language of the input documents. You can specify any of the
2354
- # primary languages supported by Amazon Comprehend: German ("de"),
2355
- # English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
2356
- # or Portuguese ("pt"). All documents must be in the same language.
2653
+ # primary languages supported by Amazon Comprehend. All documents must
2654
+ # be in the same language.
2357
2655
  #
2358
2656
  # @option params [String] :client_request_token
2359
2657
  # A unique identifier for the request. If you don't set the client
@@ -2815,6 +3113,34 @@ module Aws::Comprehend
2815
3113
  req.send_request(options)
2816
3114
  end
2817
3115
 
3116
+ # Updates information about the specified endpoint.
3117
+ #
3118
+ # @option params [required, String] :endpoint_arn
3119
+ # The Amazon Resource Number (ARN) of the endpoint being updated.
3120
+ #
3121
+ # @option params [required, Integer] :desired_inference_units
3122
+ # The desired number of inference units to be used by the model using
3123
+ # this endpoint. Each inference unit represents of a throughput of 100
3124
+ # characters per second.
3125
+ #
3126
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3127
+ #
3128
+ # @example Request syntax with placeholder values
3129
+ #
3130
+ # resp = client.update_endpoint({
3131
+ # endpoint_arn: "ComprehendEndpointArn", # required
3132
+ # desired_inference_units: 1, # required
3133
+ # })
3134
+ #
3135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint AWS API Documentation
3136
+ #
3137
+ # @overload update_endpoint(params = {})
3138
+ # @param [Hash] params ({})
3139
+ def update_endpoint(params = {}, options = {})
3140
+ req = build_request(:update_endpoint, params)
3141
+ req.send_request(options)
3142
+ end
3143
+
2818
3144
  # @!endgroup
2819
3145
 
2820
3146
  # @param params ({})
@@ -2828,7 +3154,7 @@ module Aws::Comprehend
2828
3154
  params: params,
2829
3155
  config: config)
2830
3156
  context[:gem_name] = 'aws-sdk-comprehend'
2831
- context[:gem_version] = '1.27.0'
3157
+ context[:gem_version] = '1.32.0'
2832
3158
  Seahorse::Client::Request.new(handlers, context)
2833
3159
  end
2834
3160