aws-sdk-comprehend 1.28.0 → 1.33.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d084d8fabae1a4a9046c7cec3b23459e5382c4a
-  data.tar.gz: 9ea0f0dba9567e33c04057fdd75420627debc0ea
+SHA256:
+  metadata.gz: ef829d94c34033ffcaffbabf3ba72e090c35f9e268271291e6365aa9ad643fc3
+  data.tar.gz: 03254c4bde64c0377d1cb24e8ac72873897be588748f4abde608063878396bcb
 SHA512:
-  metadata.gz: 82fbc4000e712e7e5e499932359734ab69f4e52631d2f4f04f1cdfa8a3f1284726b650b41eb8ab0bd9e5f3e2df8bf3367276427c4a7e07f9384e3176ad592e0b
-  data.tar.gz: a3910c3c1d178ace0f6353ff1f3aff51713888c547e4e17f18ebad97e4b81019afb20de8e120ba7c85092922edcc812f7d1a4efcd31af15d93691e9a79e589cb
+  metadata.gz: e471f6b8b904748b6307fd822b1b86862c6eb4fcf00262d1aeb711e11695319aeb0776d37fd3e24536735ab43eb8b15e9ba15437aec121595fa2f5b5111ed1b2
+  data.tar.gz: 6c0ec55a782b518b0760b573e5d0dbe71d4795e558f37ec1d33845edf6d08510f5f56853515ded0308e4a121f0aa1f25ab3658159f52359544de865374cf2385

data/lib/aws-sdk-comprehend.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-comprehend/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     comprehend = Aws::Comprehend::Client.new
+#     resp = comprehend.batch_detect_dominant_language(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Comprehend all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Comprehend are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::Comprehend::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Comprehend API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-comprehend/customizations'
 # @service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.28.0'
+  GEM_VERSION = '1.33.1'
 
 end

data/lib/aws-sdk-comprehend/client.rb

@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:comprehend)
 
 module Aws::Comprehend
+  # An API client for Comprehend.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::Comprehend::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::Comprehend
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -93,7 +107,7 @@ module Aws::Comprehend
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::Comprehend
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +152,10 @@ module Aws::Comprehend
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::Comprehend
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::Comprehend
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +190,29 @@ module Aws::Comprehend
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     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.
+    #     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. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +220,30 @@ module Aws::Comprehend
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -219,16 +276,15 @@ module Aws::Comprehend
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -237,7 +293,7 @@ module Aws::Comprehend
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -521,6 +577,7 @@ module Aws::Comprehend
     # @return [Types::ClassifyDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ClassifyDocumentResponse#classes #classes} => Array&lt;Types::DocumentClass&gt;
+    #   * {Types::ClassifyDocumentResponse#labels #labels} => Array&lt;Types::DocumentLabel&gt;
     #
     # @example Request syntax with placeholder values
     #
@@ -534,6 +591,9 @@ module Aws::Comprehend
     #   resp.classes #=> Array
     #   resp.classes[0].name #=> String
     #   resp.classes[0].score #=> Float
+    #   resp.labels #=> Array
+    #   resp.labels[0].name #=> String
+    #   resp.labels[0].score #=> Float
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument AWS API Documentation
     #
@@ -605,6 +665,14 @@ module Aws::Comprehend
     #
     #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #
+    # @option params [String] :mode
+    #   Indicates the mode in which the classifier will be trained. The
+    #   classifier can be trained in multi-class mode, which identifies one
+    #   and only one class for each document, or multi-label mode, which
+    #   identifies one or more labels for each document. In multi-label mode,
+    #   multiple labels for an individual document are separated by a
+    #   delimiter. The default delimiter between labels is a pipe (\|).
+    #
     # @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
@@ -622,6 +690,7 @@ module Aws::Comprehend
     #     ],
     #     input_data_config: { # required
     #       s3_uri: "S3Uri", # required
+    #       label_delimiter: "LabelDelimiter",
     #     },
     #     output_data_config: {
     #       s3_uri: "S3Uri",
@@ -634,6 +703,7 @@ module Aws::Comprehend
     #       security_group_ids: ["SecurityGroupId"], # required
     #       subnets: ["SubnetId"], # required
     #     },
+    #     mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
     #   })
     #
     # @example Response structure
@@ -981,6 +1051,7 @@ module Aws::Comprehend
     #   resp.document_classifier_properties.training_start_time #=> Time
     #   resp.document_classifier_properties.training_end_time #=> Time
     #   resp.document_classifier_properties.input_data_config.s3_uri #=> String
+    #   resp.document_classifier_properties.input_data_config.label_delimiter #=> String
     #   resp.document_classifier_properties.output_data_config.s3_uri #=> String
     #   resp.document_classifier_properties.output_data_config.kms_key_id #=> String
     #   resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
@@ -990,12 +1061,17 @@ module Aws::Comprehend
     #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.precision #=> Float
     #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.recall #=> Float
     #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.f1_score #=> Float
+    #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_precision #=> Float
+    #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_recall #=> Float
+    #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_f1_score #=> Float
+    #   resp.document_classifier_properties.classifier_metadata.evaluation_metrics.hamming_loss #=> Float
     #   resp.document_classifier_properties.data_access_role_arn #=> String
     #   resp.document_classifier_properties.volume_kms_key_id #=> String
     #   resp.document_classifier_properties.vpc_config.security_group_ids #=> Array
     #   resp.document_classifier_properties.vpc_config.security_group_ids[0] #=> String
     #   resp.document_classifier_properties.vpc_config.subnets #=> Array
     #   resp.document_classifier_properties.vpc_config.subnets[0] #=> String
+    #   resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
     #
@@ -1551,6 +1627,8 @@ module Aws::Comprehend
     #   * {Types::ListDocumentClassificationJobsResponse#document_classification_job_properties_list #document_classification_job_properties_list} => Array&lt;Types::DocumentClassificationJobProperties&gt;
     #   * {Types::ListDocumentClassificationJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_document_classification_jobs({
@@ -1614,6 +1692,8 @@ module Aws::Comprehend
     #   * {Types::ListDocumentClassifiersResponse#document_classifier_properties_list #document_classifier_properties_list} => Array&lt;Types::DocumentClassifierProperties&gt;
     #   * {Types::ListDocumentClassifiersResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_document_classifiers({
@@ -1638,6 +1718,7 @@ module Aws::Comprehend
     #   resp.document_classifier_properties_list[0].training_start_time #=> Time
     #   resp.document_classifier_properties_list[0].training_end_time #=> Time
     #   resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
+    #   resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
     #   resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
     #   resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
     #   resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
@@ -1647,12 +1728,17 @@ module Aws::Comprehend
     #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.precision #=> Float
     #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.recall #=> Float
     #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.f1_score #=> Float
+    #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_precision #=> Float
+    #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_recall #=> Float
+    #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_f1_score #=> Float
+    #   resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.hamming_loss #=> Float
     #   resp.document_classifier_properties_list[0].data_access_role_arn #=> String
     #   resp.document_classifier_properties_list[0].volume_kms_key_id #=> String
     #   resp.document_classifier_properties_list[0].vpc_config.security_group_ids #=> Array
     #   resp.document_classifier_properties_list[0].vpc_config.security_group_ids[0] #=> String
     #   resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
     #   resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
+    #   resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
@@ -1684,6 +1770,8 @@ module Aws::Comprehend
     #   * {Types::ListDominantLanguageDetectionJobsResponse#dominant_language_detection_job_properties_list #dominant_language_detection_job_properties_list} => Array&lt;Types::DominantLanguageDetectionJobProperties&gt;
     #   * {Types::ListDominantLanguageDetectionJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_dominant_language_detection_jobs({
@@ -1800,6 +1888,8 @@ module Aws::Comprehend
     #   * {Types::ListEntitiesDetectionJobsResponse#entities_detection_job_properties_list #entities_detection_job_properties_list} => Array&lt;Types::EntitiesDetectionJobProperties&gt;
     #   * {Types::ListEntitiesDetectionJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_entities_detection_jobs({
@@ -1871,6 +1961,8 @@ module Aws::Comprehend
     #   * {Types::ListEntityRecognizersResponse#entity_recognizer_properties_list #entity_recognizer_properties_list} => Array&lt;Types::EntityRecognizerProperties&gt;
     #   * {Types::ListEntityRecognizersResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_entity_recognizers({
@@ -1946,6 +2038,8 @@ module Aws::Comprehend
     #   * {Types::ListKeyPhrasesDetectionJobsResponse#key_phrases_detection_job_properties_list #key_phrases_detection_job_properties_list} => Array&lt;Types::KeyPhrasesDetectionJobProperties&gt;
     #   * {Types::ListKeyPhrasesDetectionJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_key_phrases_detection_jobs({
@@ -2009,6 +2103,8 @@ module Aws::Comprehend
     #   * {Types::ListSentimentDetectionJobsResponse#sentiment_detection_job_properties_list #sentiment_detection_job_properties_list} => Array&lt;Types::SentimentDetectionJobProperties&gt;
     #   * {Types::ListSentimentDetectionJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_sentiment_detection_jobs({
@@ -2105,6 +2201,8 @@ module Aws::Comprehend
     #   * {Types::ListTopicsDetectionJobsResponse#topics_detection_job_properties_list #topics_detection_job_properties_list} => Array&lt;Types::TopicsDetectionJobProperties&gt;
     #   * {Types::ListTopicsDetectionJobsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_topics_detection_jobs({
@@ -3058,7 +3156,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.33.1'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-comprehend/client_api.rb

@@ -89,9 +89,11 @@ module Aws::Comprehend
     DocumentClassifierEndpointArn = Shapes::StringShape.new(name: 'DocumentClassifierEndpointArn')
     DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
     DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
+    DocumentClassifierMode = Shapes::StringShape.new(name: 'DocumentClassifierMode')
     DocumentClassifierOutputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierOutputDataConfig')
     DocumentClassifierProperties = Shapes::StructureShape.new(name: 'DocumentClassifierProperties')
     DocumentClassifierPropertiesList = Shapes::ListShape.new(name: 'DocumentClassifierPropertiesList')
+    DocumentLabel = Shapes::StructureShape.new(name: 'DocumentLabel')
     DominantLanguage = Shapes::StructureShape.new(name: 'DominantLanguage')
     DominantLanguageDetectionJobFilter = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobFilter')
     DominantLanguageDetectionJobProperties = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobProperties')
@@ -141,6 +143,7 @@ module Aws::Comprehend
     KeyPhrasesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'KeyPhrasesDetectionJobPropertiesList')
     KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
     KmsKeyValidationException = Shapes::StructureShape.new(name: 'KmsKeyValidationException')
+    LabelDelimiter = Shapes::StringShape.new(name: 'LabelDelimiter')
     LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
     ListDocumentClassificationJobsRequest = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsRequest')
     ListDocumentClassificationJobsResponse = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsResponse')
@@ -165,6 +168,7 @@ module Aws::Comprehend
     ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
     ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
     ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
+    ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
     ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
     ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
     ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
@@ -316,6 +320,10 @@ module Aws::Comprehend
     ClassifierEvaluationMetrics.add_member(:precision, Shapes::ShapeRef.new(shape: Double, location_name: "Precision"))
     ClassifierEvaluationMetrics.add_member(:recall, Shapes::ShapeRef.new(shape: Double, location_name: "Recall"))
     ClassifierEvaluationMetrics.add_member(:f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "F1Score"))
+    ClassifierEvaluationMetrics.add_member(:micro_precision, Shapes::ShapeRef.new(shape: Double, location_name: "MicroPrecision"))
+    ClassifierEvaluationMetrics.add_member(:micro_recall, Shapes::ShapeRef.new(shape: Double, location_name: "MicroRecall"))
+    ClassifierEvaluationMetrics.add_member(:micro_f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "MicroF1Score"))
+    ClassifierEvaluationMetrics.add_member(:hamming_loss, Shapes::ShapeRef.new(shape: Double, location_name: "HammingLoss"))
     ClassifierEvaluationMetrics.struct_class = Types::ClassifierEvaluationMetrics
 
     ClassifierMetadata.add_member(:number_of_labels, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfLabels"))
@@ -329,6 +337,7 @@ module Aws::Comprehend
     ClassifyDocumentRequest.struct_class = Types::ClassifyDocumentRequest
 
     ClassifyDocumentResponse.add_member(:classes, Shapes::ShapeRef.new(shape: ListOfClasses, location_name: "Classes"))
+    ClassifyDocumentResponse.add_member(:labels, Shapes::ShapeRef.new(shape: ListOfLabels, location_name: "Labels"))
     ClassifyDocumentResponse.struct_class = Types::ClassifyDocumentResponse
 
     ConcurrentModificationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
@@ -343,6 +352,7 @@ module Aws::Comprehend
     CreateDocumentClassifierRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
     CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
     CreateDocumentClassifierRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
+    CreateDocumentClassifierRequest.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
     CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
 
     CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
@@ -507,6 +517,7 @@ module Aws::Comprehend
     DocumentClassifierFilter.struct_class = Types::DocumentClassifierFilter
 
     DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
+    DocumentClassifierInputDataConfig.add_member(:label_delimiter, Shapes::ShapeRef.new(shape: LabelDelimiter, location_name: "LabelDelimiter"))
     DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
 
     DocumentClassifierOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
@@ -527,10 +538,15 @@ module Aws::Comprehend
     DocumentClassifierProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
     DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
     DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
+    DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
     DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
 
     DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
 
+    DocumentLabel.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
+    DocumentLabel.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    DocumentLabel.struct_class = Types::DocumentLabel
+
     DominantLanguage.add_member(:language_code, Shapes::ShapeRef.new(shape: String, location_name: "LanguageCode"))
     DominantLanguage.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
     DominantLanguage.struct_class = Types::DominantLanguage
@@ -797,6 +813,8 @@ module Aws::Comprehend
 
     ListOfKeyPhrases.member = Shapes::ShapeRef.new(shape: KeyPhrase)
 
+    ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
+
     ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
 
     ListSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: SentimentDetectionJobFilter, location_name: "Filter"))

data/lib/aws-sdk-comprehend/errors.rb

@@ -6,6 +6,44 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Comprehend
+
+  # When Comprehend returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Comprehend::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Comprehend errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Comprehend::Errors::ServiceError
+  #       # rescues all Comprehend API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {BatchSizeLimitExceededException}
+  # * {ConcurrentModificationException}
+  # * {InternalServerException}
+  # * {InvalidFilterException}
+  # * {InvalidRequestException}
+  # * {JobNotFoundException}
+  # * {KmsKeyValidationException}
+  # * {ResourceInUseException}
+  # * {ResourceLimitExceededException}
+  # * {ResourceNotFoundException}
+  # * {ResourceUnavailableException}
+  # * {TextSizeLimitExceededException}
+  # * {TooManyRequestsException}
+  # * {TooManyTagKeysException}
+  # * {TooManyTagsException}
+  # * {UnsupportedLanguageException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +61,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ConcurrentModificationException < ServiceError
@@ -39,7 +76,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServerException < ServiceError
@@ -55,7 +91,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidFilterException < ServiceError
@@ -71,7 +106,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
@@ -87,7 +121,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class JobNotFoundException < ServiceError
@@ -103,7 +136,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class KmsKeyValidationException < ServiceError
@@ -119,7 +151,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceInUseException < ServiceError
@@ -135,7 +166,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceLimitExceededException < ServiceError
@@ -151,7 +181,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -167,7 +196,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceUnavailableException < ServiceError
@@ -183,7 +211,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TextSizeLimitExceededException < ServiceError
@@ -199,7 +226,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyRequestsException < ServiceError
@@ -215,7 +241,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyTagKeysException < ServiceError
@@ -231,7 +256,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyTagsException < ServiceError
@@ -247,7 +271,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedLanguageException < ServiceError
@@ -263,7 +286,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
   end

data/lib/aws-sdk-comprehend/resource.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Comprehend
+
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-comprehend/types.rb

@@ -425,13 +425,50 @@ module Aws::Comprehend
     #   score is 1, and the worst score is 0.
     #   @return [Float]
     #
+    # @!attribute [rw] micro_precision
+    #   A measure of the usefulness of the recognizer results in the test
+    #   data. High precision means that the recognizer returned
+    #   substantially more relevant results than irrelevant ones. Unlike the
+    #   Precision metric which comes from averaging the precision of all
+    #   available labels, this is based on the overall score of all
+    #   precision scores added together.
+    #   @return [Float]
+    #
+    # @!attribute [rw] micro_recall
+    #   A measure of how complete the classifier results are for the test
+    #   data. High recall means that the classifier returned most of the
+    #   relevant results. Specifically, this indicates how many of the
+    #   correct categories in the text that the model can predict. It is a
+    #   percentage of correct categories in the text that can found. Instead
+    #   of averaging the recall scores of all labels (as with Recall), micro
+    #   Recall is based on the overall score of all recall scores added
+    #   together.
+    #   @return [Float]
+    #
+    # @!attribute [rw] micro_f1_score
+    #   A measure of how accurate the classifier results are for the test
+    #   data. It is a combination of the `Micro Precision` and `Micro
+    #   Recall` values. The `Micro F1Score` is the harmonic mean of the two
+    #   scores. The highest score is 1, and the worst score is 0.
+    #   @return [Float]
+    #
+    # @!attribute [rw] hamming_loss
+    #   Indicates the fraction of labels that are incorrectly predicted.
+    #   Also seen as the fraction of wrong labels compared to the total
+    #   number of labels. Scores closer to zero are better.
+    #   @return [Float]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierEvaluationMetrics AWS API Documentation
     #
     class ClassifierEvaluationMetrics < Struct.new(
       :accuracy,
       :precision,
       :recall,
-      :f1_score)
+      :f1_score,
+      :micro_precision,
+      :micro_recall,
+      :micro_f1_score,
+      :hamming_loss)
       include Aws::Structure
     end
 
@@ -500,10 +537,20 @@ module Aws::Comprehend
     #   not both at the same time.
     #   @return [Array<Types::DocumentClass>]
     #
+    # @!attribute [rw] labels
+    #   The labels used the document being analyzed. These are used for
+    #   multi-label trained models. Individual labels represent different
+    #   categories that are related in some manner and are not multually
+    #   exclusive. For example, a movie can be just an action movie, or it
+    #   can be an action movie, a science fiction movie, and a comedy, all
+    #   at the same time.
+    #   @return [Array<Types::DocumentLabel>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentResponse AWS API Documentation
     #
     class ClassifyDocumentResponse < Struct.new(
-      :classes)
+      :classes,
+      :labels)
       include Aws::Structure
     end
 
@@ -534,6 +581,7 @@ module Aws::Comprehend
     #         ],
     #         input_data_config: { # required
     #           s3_uri: "S3Uri", # required
+    #           label_delimiter: "LabelDelimiter",
     #         },
     #         output_data_config: {
     #           s3_uri: "S3Uri",
@@ -546,6 +594,7 @@ module Aws::Comprehend
     #           security_group_ids: ["SecurityGroupId"], # required
     #           subnets: ["SubnetId"], # required
     #         },
+    #         mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
     #       }
     #
     # @!attribute [rw] document_classifier_name
@@ -613,6 +662,15 @@ module Aws::Comprehend
     #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
+    # @!attribute [rw] mode
+    #   Indicates the mode in which the classifier will be trained. The
+    #   classifier can be trained in multi-class mode, which identifies one
+    #   and only one class for each document, or multi-label mode, which
+    #   identifies one or more labels for each document. In multi-label
+    #   mode, multiple labels for an individual document are separated by a
+    #   delimiter. The default delimiter between labels is a pipe (\|).
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
     #
     class CreateDocumentClassifierRequest < Struct.new(
@@ -624,7 +682,8 @@ module Aws::Comprehend
       :client_request_token,
       :language_code,
       :volume_kms_key_id,
-      :vpc_config)
+      :vpc_config,
+      :mode)
       include Aws::Structure
     end
 
@@ -1593,6 +1652,7 @@ module Aws::Comprehend
     #
     #       {
     #         s3_uri: "S3Uri", # required
+    #         label_delimiter: "LabelDelimiter",
     #       }
     #
     # @!attribute [rw] s3_uri
@@ -1607,10 +1667,21 @@ module Aws::Comprehend
     #   all of them as input.
     #   @return [String]
     #
+    # @!attribute [rw] label_delimiter
+    #   Indicates the delimiter used to separate each label for training a
+    #   multi-label classifier. The default delimiter between labels is a
+    #   pipe (\|). You can use a different character as a delimiter (if
+    #   it's an allowed character) by specifying it under Delimiter for
+    #   labels. If the training documents use a delimiter other than the
+    #   default or the delimiter you specify, the labels on that line will
+    #   be combined to make a single unique label, such as LABELLABELLABEL.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
     #
     class DocumentClassifierInputDataConfig < Struct.new(
-      :s3_uri)
+      :s3_uri,
+      :label_delimiter)
       include Aws::Structure
     end
 
@@ -1750,6 +1821,13 @@ module Aws::Comprehend
     #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
+    # @!attribute [rw] mode
+    #   Indicates the mode in which the specific classifier was trained.
+    #   This also indicates the format of input documents and the format of
+    #   the confusion matrix. Each classifier can only be trained in one
+    #   mode and this cannot be changed once the classifier is trained.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
     #
     class DocumentClassifierProperties < Struct.new(
@@ -1766,7 +1844,28 @@ module Aws::Comprehend
       :classifier_metadata,
       :data_access_role_arn,
       :volume_kms_key_id,
-      :vpc_config)
+      :vpc_config,
+      :mode)
+      include Aws::Structure
+    end
+
+    # Specifies one of the label or labels that categorize the document
+    # being analyzed.
+    #
+    # @!attribute [rw] name
+    #   The name of the label.
+    #   @return [String]
+    #
+    # @!attribute [rw] score
+    #   The confidence score that Amazon Comprehend has this label correctly
+    #   attributed.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentLabel AWS API Documentation
+    #
+    class DocumentLabel < Struct.new(
+      :name,
+      :score)
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.33.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Comprehend