aws-sdk-comprehend 1.73.0 → 1.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b60b90ed970dcabaa94a4956ebf1ed087c7a58f18b978dbc3bf31b921ba1c5b
-  data.tar.gz: f91aa0e3333dd9303053e067fa87c7ebfefea69c40d7cde938b5e1f3fdf58c9e
+  metadata.gz: 166866632114586fb10673e1984745dbbb4146641832e709c32cb4abc2febf5e
+  data.tar.gz: 68afae0447587e72524f04b7b86767ddad253240024a93cbec84cc2493199ed9
 SHA512:
-  metadata.gz: cc64da6f3bce6b4ee6c00f69beaa1c8c3891f32b3529b634abaaa78ece8047894948c77728ac1246ff68629a9e8a9e70cfb2ec87bc854df577baf15fe008031e
-  data.tar.gz: 0bca1cdef49b5c129be068f5ad528917dc2ccd5a869e6ba50776005cff692b683e4df5fee54ae6ddceec832984139072341f7fe3c87cc6fb953149b67dcbabcc
+  metadata.gz: 42a36e0c66dfed5458aab181854a9b8b95ec8c239d5bdfca3a494a81aa3503ef6c9e096b92ed45b7b0fe02ab9ad95a7a3acd675355ba12d7652cb348106008d1
+  data.tar.gz: b66e24a30071002bc9c9eec4a573402e37fb83d64af935fdf89836a68f9a559b2b297a458746829cbf0e64b415d1db55cf1beabb69b80a4e6b4e1ee050e98510

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.75.0 (2023-11-09)
+------------------
+
+* Feature - This release adds support for toxicity detection and prompt safety classification.
+
+1.74.0 (2023-09-27)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.73.0 (2023-07-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.73.0
+1.75.0

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

@@ -663,7 +663,7 @@ module Aws::Comprehend
     # each entity identified in the documents.
     #
     # For more information about targeted sentiment, see [Targeted
-    # sentiment][1].
+    # sentiment][1] in the *Amazon Comprehend Developer Guide*.
     #
     #
     #
@@ -723,12 +723,20 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
-    # Creates a new document classification request to analyze a single
-    # document in real-time, using a previously created and trained custom
-    # model and an endpoint.
+    # Creates a classification request to analyze a single document in
+    # real-time. `ClassifyDocument` supports the following model types:
     #
-    # You can input plain text or you can upload a single-page input
-    # document (text, PDF, Word, or image).
+    # * Custom classifier - a custom model that you have created and
+    #   trained. For input, you can provide plain text, a single-page
+    #   document (PDF, Word, or image), or Textract API output. For more
+    #   information, see [Custom classification][1] in the *Amazon
+    #   Comprehend Developer Guide*.
+    #
+    # * Prompt classifier - Amazon Comprehend provides a model for
+    #   classifying prompts. For input, you provide English plain text
+    #   input. For prompt classification, the response includes only the
+    #   `Classes` field. For more information about prompt classifiers, see
+    #   [Prompt classifiers][2] in the *Amazon Comprehend Developer Guide*.
     #
     # If the system detects errors while processing a page in the input
     # document, the API response includes an entry in `Errors` that
@@ -737,28 +745,41 @@ module Aws::Comprehend
     # If the system detects a document-level error in your input document,
     # the API returns an `InvalidRequestException` error response. For
     # details about this exception, see [ Errors in semi-structured
-    # documents][1] in the Comprehend Developer Guide.
+    # documents][3] in the Comprehend Developer Guide.
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html
+    # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html
+    # [2]: https://docs.aws.amazon.com/comprehend/latest/dg/prompt-classification.html
+    # [3]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html
     #
     # @option params [String] :text
     #   The document text to be analyzed. If you enter text using this
     #   parameter, do not use the `Bytes` parameter.
     #
     # @option params [required, String] :endpoint_arn
-    #   The Amazon Resource Number (ARN) of the endpoint. For information
-    #   about endpoints, see [Managing endpoints][1].
+    #   The Amazon Resource Number (ARN) of the endpoint.
     #
+    #   For prompt classification, Amazon Comprehend provides the endpoint
+    #   ARN: `zzz`.
+    #
+    #   For custom classification, you create an endpoint for your custom
+    #   model. For more information, see [Using Amazon Comprehend
+    #   endpoints][1].
     #
     #
-    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
+    #
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
     #
     # @option params [String, StringIO, File] :bytes
     #   Use the `Bytes` parameter to input a text, PDF, Word or image file.
-    #   You can also use the `Bytes` parameter to input an Amazon Textract
-    #   `DetectDocumentText` or `AnalyzeDocument` output file.
+    #
+    #   When you classify a document using a custom model, you can also use
+    #   the `Bytes` parameter to input an Amazon Textract `DetectDocumentText`
+    #   or `AnalyzeDocument` output file.
+    #
+    #   To classify a document using the prompt classifier, use the `Text`
+    #   parameter for input.
     #
     #   Provide the input document as a sequence of base64-encoded bytes. If
     #   your code uses an Amazon Web Services SDK to classify documents, the
@@ -1006,7 +1027,7 @@ module Aws::Comprehend
     # @option params [Types::DocumentClassifierOutputDataConfig] :output_data_config
     #   Specifies the location for the output files from a custom classifier
     #   job. This parameter is required for a request that creates a native
-    #   classifier model.
+    #   document model.
     #
     # @option params [String] :client_request_token
     #   A unique identifier for the request. If you don't set the client
@@ -1420,7 +1441,8 @@ module Aws::Comprehend
     #
     # @option params [String] :active_model_arn
     #   To associate an existing model with the flywheel, specify the Amazon
-    #   Resource Number (ARN) of the model version.
+    #   Resource Number (ARN) of the model version. Do not set `TaskConfig` or
+    #   `ModelType` if you specify an `ActiveModelArn`.
     #
     # @option params [required, String] :data_access_role_arn
     #   The Amazon Resource Name (ARN) of the IAM role that grants Amazon
@@ -1428,11 +1450,12 @@ module Aws::Comprehend
     #   data lake.
     #
     # @option params [Types::TaskConfig] :task_config
-    #   Configuration about the custom classifier associated with the
-    #   flywheel.
+    #   Configuration about the model associated with the flywheel. You need
+    #   to set `TaskConfig` if you are creating a flywheel for a new model.
     #
     # @option params [String] :model_type
-    #   The model type.
+    #   The model type. You need to set `ModelType` if you are creating a
+    #   flywheel for a new model.
     #
     # @option params [required, String] :data_lake_s3_uri
     #   Enter the S3 location for the data lake. You can specify a new S3
@@ -2875,7 +2898,7 @@ module Aws::Comprehend
     # entity identified in the text.
     #
     # For more information about targeted sentiment, see [Targeted
-    # sentiment][1].
+    # sentiment][1] in the *Amazon Comprehend Developer Guide*.
     #
     #
     #
@@ -2926,6 +2949,57 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Performs toxicity analysis on the list of text strings that you
+    # provide as input. The analysis uses the order of strings in the list
+    # to determine context when predicting toxicity. The API response
+    # contains a results list that matches the size of the input list. For
+    # more information about toxicity detection, see [Toxicity detection][1]
+    # in the *Amazon Comprehend Developer Guide*
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html
+    #
+    # @option params [required, Array<Types::TextSegment>] :text_segments
+    #   A list of up to 10 text strings. The maximum size for the list is 10
+    #   KB.
+    #
+    # @option params [required, String] :language_code
+    #   The language of the input text. Currently, English is the only
+    #   supported language.
+    #
+    # @return [Types::DetectToxicContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DetectToxicContentResponse#result_list #result_list} => Array&lt;Types::ToxicLabels&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.detect_toxic_content({
+    #     text_segments: [ # required
+    #       {
+    #         text: "CustomerInputString", # required
+    #       },
+    #     ],
+    #     language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.result_list #=> Array
+    #   resp.result_list[0].labels #=> Array
+    #   resp.result_list[0].labels[0].name #=> String, one of "GRAPHIC", "HARASSMENT_OR_ABUSE", "HATE_SPEECH", "INSULT", "PROFANITY", "SEXUAL", "VIOLENCE_OR_THREAT"
+    #   resp.result_list[0].labels[0].score #=> Float
+    #   resp.result_list[0].toxicity #=> Float
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectToxicContent AWS API Documentation
+    #
+    # @overload detect_toxic_content(params = {})
+    # @param [Hash] params ({})
+    def detect_toxic_content(params = {}, options = {})
+      req = build_request(:detect_toxic_content, params)
+      req.send_request(options)
+    end
+
     # Creates a new custom model that replicates a source custom model that
     # you import. The source model can be in your Amazon Web Services
     # account or another one.
@@ -5092,7 +5166,7 @@ module Aws::Comprehend
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
     #
     # @option params [String] :job_name
     #   The identifier of the job.
@@ -5835,7 +5909,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.73.0'
+      context[:gem_version] = '1.75.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -143,6 +143,8 @@ module Aws::Comprehend
     DetectSyntaxResponse = Shapes::StructureShape.new(name: 'DetectSyntaxResponse')
     DetectTargetedSentimentRequest = Shapes::StructureShape.new(name: 'DetectTargetedSentimentRequest')
     DetectTargetedSentimentResponse = Shapes::StructureShape.new(name: 'DetectTargetedSentimentResponse')
+    DetectToxicContentRequest = Shapes::StructureShape.new(name: 'DetectToxicContentRequest')
+    DetectToxicContentResponse = Shapes::StructureShape.new(name: 'DetectToxicContentResponse')
     DocumentClass = Shapes::StructureShape.new(name: 'DocumentClass')
     DocumentClassificationConfig = Shapes::StructureShape.new(name: 'DocumentClassificationConfig')
     DocumentClassificationJobFilter = Shapes::StructureShape.new(name: 'DocumentClassificationJobFilter')
@@ -307,6 +309,9 @@ module Aws::Comprehend
     ListOfRelationships = Shapes::ListShape.new(name: 'ListOfRelationships')
     ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
     ListOfTargetedSentimentEntities = Shapes::ListShape.new(name: 'ListOfTargetedSentimentEntities')
+    ListOfTextSegments = Shapes::ListShape.new(name: 'ListOfTextSegments')
+    ListOfToxicContent = Shapes::ListShape.new(name: 'ListOfToxicContent')
+    ListOfToxicLabels = Shapes::ListShape.new(name: 'ListOfToxicLabels')
     ListOfWarnings = Shapes::ListShape.new(name: 'ListOfWarnings')
     ListPiiEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsRequest')
     ListPiiEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsResponse')
@@ -420,6 +425,7 @@ module Aws::Comprehend
     TargetedSentimentEntityType = Shapes::StringShape.new(name: 'TargetedSentimentEntityType')
     TargetedSentimentMention = Shapes::StructureShape.new(name: 'TargetedSentimentMention')
     TaskConfig = Shapes::StructureShape.new(name: 'TaskConfig')
+    TextSegment = Shapes::StructureShape.new(name: 'TextSegment')
     TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
@@ -428,6 +434,9 @@ module Aws::Comprehend
     TopicsDetectionJobFilter = Shapes::StructureShape.new(name: 'TopicsDetectionJobFilter')
     TopicsDetectionJobProperties = Shapes::StructureShape.new(name: 'TopicsDetectionJobProperties')
     TopicsDetectionJobPropertiesList = Shapes::ListShape.new(name: 'TopicsDetectionJobPropertiesList')
+    ToxicContent = Shapes::StructureShape.new(name: 'ToxicContent')
+    ToxicContentType = Shapes::StringShape.new(name: 'ToxicContentType')
+    ToxicLabels = Shapes::StructureShape.new(name: 'ToxicLabels')
     UnsupportedLanguageException = Shapes::StructureShape.new(name: 'UnsupportedLanguageException')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
     UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
@@ -915,6 +924,13 @@ module Aws::Comprehend
     DetectTargetedSentimentResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfTargetedSentimentEntities, location_name: "Entities"))
     DetectTargetedSentimentResponse.struct_class = Types::DetectTargetedSentimentResponse
 
+    DetectToxicContentRequest.add_member(:text_segments, Shapes::ShapeRef.new(shape: ListOfTextSegments, required: true, location_name: "TextSegments"))
+    DetectToxicContentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
+    DetectToxicContentRequest.struct_class = Types::DetectToxicContentRequest
+
+    DetectToxicContentResponse.add_member(:result_list, Shapes::ShapeRef.new(shape: ListOfToxicLabels, location_name: "ResultList"))
+    DetectToxicContentResponse.struct_class = Types::DetectToxicContentResponse
+
     DocumentClass.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
     DocumentClass.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
     DocumentClass.add_member(:page, Shapes::ShapeRef.new(shape: Integer, location_name: "Page"))
@@ -1531,6 +1547,12 @@ module Aws::Comprehend
 
     ListOfTargetedSentimentEntities.member = Shapes::ShapeRef.new(shape: TargetedSentimentEntity)
 
+    ListOfTextSegments.member = Shapes::ShapeRef.new(shape: TextSegment)
+
+    ListOfToxicContent.member = Shapes::ShapeRef.new(shape: ToxicContent)
+
+    ListOfToxicLabels.member = Shapes::ShapeRef.new(shape: ToxicLabels)
+
     ListOfWarnings.member = Shapes::ShapeRef.new(shape: WarningsListItem)
 
     ListPiiEntitiesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobFilter, location_name: "Filter"))
@@ -1969,6 +1991,9 @@ module Aws::Comprehend
     TaskConfig.add_member(:entity_recognition_config, Shapes::ShapeRef.new(shape: EntityRecognitionConfig, location_name: "EntityRecognitionConfig"))
     TaskConfig.struct_class = Types::TaskConfig
 
+    TextSegment.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
+    TextSegment.struct_class = Types::TextSegment
+
     TextSizeLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     TextSizeLimitExceededException.struct_class = Types::TextSizeLimitExceededException
 
@@ -2004,6 +2029,14 @@ module Aws::Comprehend
 
     TopicsDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: TopicsDetectionJobProperties)
 
+    ToxicContent.add_member(:name, Shapes::ShapeRef.new(shape: ToxicContentType, location_name: "Name"))
+    ToxicContent.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    ToxicContent.struct_class = Types::ToxicContent
+
+    ToxicLabels.add_member(:labels, Shapes::ShapeRef.new(shape: ListOfToxicContent, location_name: "Labels"))
+    ToxicLabels.add_member(:toxicity, Shapes::ShapeRef.new(shape: Float, location_name: "Toxicity"))
+    ToxicLabels.struct_class = Types::ToxicLabels
+
     UnsupportedLanguageException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     UnsupportedLanguageException.struct_class = Types::UnsupportedLanguageException
 
@@ -2588,6 +2621,18 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:detect_toxic_content, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DetectToxicContent"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DetectToxicContentRequest)
+        o.output = Shapes::ShapeRef.new(shape: DetectToxicContentResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:import_model, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ImportModel"
         o.http_method = "POST"

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

@@ -32,7 +32,7 @@ module Aws::Comprehend
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://comprehend-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

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

@@ -586,6 +586,20 @@ module Aws::Comprehend
       end
     end
 
+    class DetectToxicContent
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Comprehend::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class ImportModel
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-comprehend/plugins/endpoints.rb

@@ -138,6 +138,8 @@ module Aws::Comprehend
             Aws::Comprehend::Endpoints::DetectSyntax.build(context)
           when :detect_targeted_sentiment
             Aws::Comprehend::Endpoints::DetectTargetedSentiment.build(context)
+          when :detect_toxic_content
+            Aws::Comprehend::Endpoints::DetectToxicContent.build(context)
           when :import_model
             Aws::Comprehend::Endpoints::ImportModel.build(context)
           when :list_datasets

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

@@ -778,19 +778,30 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] endpoint_arn
-    #   The Amazon Resource Number (ARN) of the endpoint. For information
-    #   about endpoints, see [Managing endpoints][1].
+    #   The Amazon Resource Number (ARN) of the endpoint.
     #
+    #   For prompt classification, Amazon Comprehend provides the endpoint
+    #   ARN: `zzz`.
     #
+    #   For custom classification, you create an endpoint for your custom
+    #   model. For more information, see [Using Amazon Comprehend
+    #   endpoints][1].
     #
-    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
     #   @return [String]
     #
     # @!attribute [rw] bytes
     #   Use the `Bytes` parameter to input a text, PDF, Word or image file.
-    #   You can also use the `Bytes` parameter to input an Amazon Textract
+    #
+    #   When you classify a document using a custom model, you can also use
+    #   the `Bytes` parameter to input an Amazon Textract
     #   `DetectDocumentText` or `AnalyzeDocument` output file.
     #
+    #   To classify a document using the prompt classifier, use the `Text`
+    #   parameter for input.
+    #
     #   Provide the input document as a sequence of base64-encoded bytes. If
     #   your code uses an Amazon Web Services SDK to classify documents, the
     #   SDK may encode the document file bytes for you.
@@ -828,6 +839,11 @@ module Aws::Comprehend
     #   exclusive and each document is expected to have only a single class
     #   assigned to it. For example, an animal can be a dog or a cat, but
     #   not both at the same time.
+    #
+    #   For prompt classification, the response includes a single class
+    #   (`UNDESIRED_PROMPT`), along with a confidence score. A higher
+    #   confidence score indicates that the input prompt is undesired in
+    #   nature.
     #   @return [Array<Types::DocumentClass>]
     #
     # @!attribute [rw] labels
@@ -1017,7 +1033,7 @@ module Aws::Comprehend
     # @!attribute [rw] output_data_config
     #   Specifies the location for the output files from a custom classifier
     #   job. This parameter is required for a request that creates a native
-    #   classifier model.
+    #   document model.
     #   @return [Types::DocumentClassifierOutputDataConfig]
     #
     # @!attribute [rw] client_request_token
@@ -1342,7 +1358,8 @@ module Aws::Comprehend
     #
     # @!attribute [rw] active_model_arn
     #   To associate an existing model with the flywheel, specify the Amazon
-    #   Resource Number (ARN) of the model version.
+    #   Resource Number (ARN) of the model version. Do not set `TaskConfig`
+    #   or `ModelType` if you specify an `ActiveModelArn`.
     #   @return [String]
     #
     # @!attribute [rw] data_access_role_arn
@@ -1352,12 +1369,13 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] task_config
-    #   Configuration about the custom classifier associated with the
-    #   flywheel.
+    #   Configuration about the model associated with the flywheel. You need
+    #   to set `TaskConfig` if you are creating a flywheel for a new model.
     #   @return [Types::TaskConfig]
     #
     # @!attribute [rw] model_type
-    #   The model type.
+    #   The model type. You need to set `ModelType` if you are creating a
+    #   flywheel for a new model.
     #   @return [String]
     #
     # @!attribute [rw] data_lake_s3_uri
@@ -2650,6 +2668,41 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @!attribute [rw] text_segments
+    #   A list of up to 10 text strings. The maximum size for the list is 10
+    #   KB.
+    #   @return [Array<Types::TextSegment>]
+    #
+    # @!attribute [rw] language_code
+    #   The language of the input text. Currently, English is the only
+    #   supported language.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectToxicContentRequest AWS API Documentation
+    #
+    class DetectToxicContentRequest < Struct.new(
+      :text_segments,
+      :language_code)
+      SENSITIVE = [:text_segments]
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] result_list
+    #   Results of the content moderation analysis. Each entry in the
+    #   results list contains a list of toxic content types identified in
+    #   the text, along with a confidence score for each content type. The
+    #   results list also includes a toxicity score for each entry in the
+    #   results list.
+    #   @return [Array<Types::ToxicLabels>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectToxicContentResponse AWS API Documentation
+    #
+    class DetectToxicContentResponse < Struct.new(
+      :result_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the class that categorizes the document being analyzed
     #
     # @!attribute [rw] name
@@ -2676,7 +2729,7 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
-    # Configuration required for a custom classification model.
+    # Configuration required for a document classification model.
     #
     # @!attribute [rw] mode
     #   Classification mode indicates whether the documents are
@@ -2814,7 +2867,7 @@ module Aws::Comprehend
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
+    #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
     # @!attribute [rw] flywheel_arn
@@ -2843,7 +2896,7 @@ module Aws::Comprehend
     end
 
     # The location of the training documents. This parameter is required in
-    # a request to create a native classifier model.
+    # a request to create a semi-structured document classification model.
     #
     # @!attribute [rw] s3_uri
     #   The S3 URI location of the training documents specified in the S3Uri
@@ -2947,9 +3000,9 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] test_s3_uri
-    #   This specifies the Amazon S3 location where the test annotations for
-    #   an entity recognizer are located. The URI must be in the same Amazon
-    #   Web Services Region as the API endpoint that you are calling.
+    #   This specifies the Amazon S3 location that contains the test
+    #   annotations for the document classifier. The URI must be in the same
+    #   Amazon Web Services Region as the API endpoint that you are calling.
     #   @return [String]
     #
     # @!attribute [rw] label_delimiter
@@ -2974,12 +3027,12 @@ module Aws::Comprehend
     # @!attribute [rw] document_type
     #   The type of input documents for training the model. Provide
     #   plain-text documents to create a plain-text model, and provide
-    #   semi-structured documents to create a native model.
+    #   semi-structured documents to create a native document model.
     #   @return [String]
     #
     # @!attribute [rw] documents
     #   The S3 location of the training documents. This parameter is
-    #   required in a request to create a native classifier model.
+    #   required in a request to create a native document model.
     #   @return [Types::DocumentClassifierDocuments]
     #
     # @!attribute [rw] document_reader_config
@@ -3026,7 +3079,7 @@ module Aws::Comprehend
     end
 
     # Provide the location for output data from a custom classifier job.
-    # This field is mandatory if you are training a native classifier model.
+    # This field is mandatory if you are training a native document model.
     #
     # @!attribute [rw] s3_uri
     #   When you use the `OutputDataConfig` object while creating a custom
@@ -3161,7 +3214,7 @@ module Aws::Comprehend
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
+    #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
     # @!attribute [rw] mode
@@ -4769,8 +4822,7 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] task_config
-    #   Configuration about the custom classifier associated with the
-    #   flywheel.
+    #   Configuration about the model associated with a flywheel.
     #   @return [Types::TaskConfig]
     #
     # @!attribute [rw] data_lake_s3_uri
@@ -6046,7 +6098,7 @@ module Aws::Comprehend
     # entity.
     #
     # For more information about targeted sentiment, see [Targeted
-    # sentiment][1].
+    # sentiment][1] in the *Amazon Comprehend Developer Guide*.
     #
     #
     #
@@ -6092,7 +6144,10 @@ module Aws::Comprehend
     # @!attribute [rw] kms_key_id
     #   ID for the Amazon Web Services Key Management Service (KMS) key that
     #   Amazon Comprehend uses to encrypt the output results from an
-    #   analysis job. The KmsKeyId can be one of the following formats:
+    #   analysis job. Specify the Key Id of a symmetric key, because you
+    #   cannot use an asymmetric key for uploading data to S3.
+    #
+    #   The KmsKeyId can be one of the following formats:
     #
     #   * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
     #
@@ -7565,7 +7620,7 @@ module Aws::Comprehend
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
     #   @return [String]
     #
     # @!attribute [rw] job_name
@@ -8289,7 +8344,7 @@ module Aws::Comprehend
     # analysis.
     #
     # For more information about targeted sentiment, see [Targeted
-    # sentiment][1].
+    # sentiment][1] in the *Amazon Comprehend Developer Guide*.
     #
     #
     #
@@ -8324,7 +8379,7 @@ module Aws::Comprehend
     # the mention.
     #
     # For more information about targeted sentiment, see [Targeted
-    # sentiment][1].
+    # sentiment][1] in the *Amazon Comprehend Developer Guide*.
     #
     #
     #
@@ -8379,15 +8434,14 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
-    # Configuration about the custom classifier associated with the
-    # flywheel.
+    # Configuration about the model associated with a flywheel.
     #
     # @!attribute [rw] language_code
     #   Language code for the language that the model supports.
     #   @return [String]
     #
     # @!attribute [rw] document_classification_config
-    #   Configuration required for a classification model.
+    #   Configuration required for a document classification model.
     #   @return [Types::DocumentClassificationConfig]
     #
     # @!attribute [rw] entity_recognition_config
@@ -8404,6 +8458,20 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # One of the of text strings. Each string has a size limit of 1KB.
+    #
+    # @!attribute [rw] text
+    #   The text content.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TextSegment AWS API Documentation
+    #
+    class TextSegment < Struct.new(
+      :text)
+      SENSITIVE = [:text]
+      include Aws::Structure
+    end
+
     # The size of the input text exceeds the limit. Use a smaller document.
     #
     # @!attribute [rw] message
@@ -8598,6 +8666,57 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # Toxic content analysis result for one string. For more information
+    # about toxicity detection, see [Toxicity detection][1] in the *Amazon
+    # Comprehend Developer Guide*
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html
+    #
+    # @!attribute [rw] name
+    #   The name of the toxic content type.
+    #   @return [String]
+    #
+    # @!attribute [rw] score
+    #   Model confidence in the detected content type. Value range is zero
+    #   to one, where one is highest confidence.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ToxicContent AWS API Documentation
+    #
+    class ToxicContent < Struct.new(
+      :name,
+      :score)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Toxicity analysis result for one string. For more information about
+    # toxicity detection, see [Toxicity detection][1] in the *Amazon
+    # Comprehend Developer Guide*
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html
+    #
+    # @!attribute [rw] labels
+    #   Array of toxic content types identified in the string.
+    #   @return [Array<Types::ToxicContent>]
+    #
+    # @!attribute [rw] toxicity
+    #   Overall toxicity score for the string.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ToxicLabels AWS API Documentation
+    #
+    class ToxicLabels < Struct.new(
+      :labels,
+      :toxicity)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Amazon Comprehend can't process the language of the input text. For
     # custom entity recognition APIs, only English, Spanish, French,
     # Italian, German, or Portuguese are accepted. For a list of supported
@@ -8817,7 +8936,7 @@ module Aws::Comprehend
     # the input document:
     #
     # * The document to classify is plain text, but the classifier is a
-    #   native model.
+    #   native document model.
     #
     # * The document to classify is semi-structured, but the classifier is a
     #   plain-text model.

data/lib/aws-sdk-comprehend.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-comprehend/customizations'
 # @!group service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.73.0'
+  GEM_VERSION = '1.75.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.73.0
+  version: 1.75.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-11-09 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.177.0
+        version: 3.184.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.177.0
+        version: 3.184.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement