aws-sdk-comprehend 1.77.0 → 1.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12a87bb2bba877a78e2d272cb147c3a96fc3fc29544c04284f3a246232d3750a
-  data.tar.gz: e13c7edf11b8e0a151d7b75b002f32206b0e7c3df2c15622a16e8ca1df2bb76a
+  metadata.gz: fa1350cfff0496cdba43da5b91bab9e8a5e0d5c5810811a70a7f34cafa679580
+  data.tar.gz: 7eebc85711802fa50f041ea2ed59c63e1fcf97feecbfafbdfd466c5f45506446
 SHA512:
-  metadata.gz: 9e7861229b8f9a48606cb99292b0c0636edef35eddebcf3a51c785cb6a9bf5e988e0e8b5dcbce27138d560273d04070349a2d58f09f5c515686379401252d440
-  data.tar.gz: 3df7c12decd706cdc36e3d060dbdf8b5c9b05e02543a0cf1dd87e55754fca3ad199bb30dd2cfd1f5ddae12f6f5ef8d2cb27680b18a1f7ba5f3d2b22d470affb4
+  metadata.gz: 26abd84ab8638cbcdea055b17c4306d6386c59229f991e41878294030ff62b4b7c9bcc040694529249f1caa991efb05d6147b737c24f593bf3b21d1ef3897984
+  data.tar.gz: 0cbbcd278db0493ec6b8ade065e68585ebee4ac990c6c52038d4c040cc23eaf7cd6019b32560c07acd245ce8f378c3fcd6031f57136f0ce43abd3cbcd53aafc6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.78.0 (2023-12-06)
+------------------
+
+* Feature - Documentation updates for Trust and Safety features.
+
 1.77.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.77.0
+1.78.0

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

@@ -728,19 +728,20 @@ module Aws::Comprehend
     #
     # * 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
+    #   document (PDF, Word, or image), or Amazon 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*.
+    # * Prompt safety classifier - Amazon Comprehend provides a pre-trained
+    #   model for classifying input prompts for generative AI applications.
+    #   For input, you provide English plain text input. For prompt safety
+    #   classification, the response includes only the `Classes` field. For
+    #   more information about prompt safety classifiers, see [Prompt safety
+    #   classification][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
-    # describes the errors.
+    # document, the API response includes an `Errors` field that describes
+    # the errors.
     #
     # If the system detects a document-level error in your input document,
     # the API returns an `InvalidRequestException` error response. For
@@ -750,7 +751,7 @@ module Aws::Comprehend
     #
     #
     # [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
+    # [2]: https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification
     # [3]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html
     #
     # @option params [String] :text
@@ -760,16 +761,19 @@ module Aws::Comprehend
     # @option params [required, String] :endpoint_arn
     #   The Amazon Resource Number (ARN) of the endpoint.
     #
-    #   For prompt classification, Amazon Comprehend provides the endpoint
-    #   ARN: `zzz`.
+    #   For prompt safety classification, Amazon Comprehend provides the
+    #   endpoint ARN. For more information about prompt safety classifiers,
+    #   see [Prompt safety classification][1] in the *Amazon Comprehend
+    #   Developer Guide*
     #
     #   For custom classification, you create an endpoint for your custom
     #   model. For more information, see [Using Amazon Comprehend
-    #   endpoints][1].
+    #   endpoints][2].
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification
+    #   [2]: 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.
@@ -778,8 +782,8 @@ module Aws::Comprehend
     #   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.
+    #   To classify a document using the prompt safety 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
@@ -1063,11 +1067,12 @@ module Aws::Comprehend
     #
     # @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 (\|).
+    #   classifier can be trained in multi-class (single-label) mode or
+    #   multi-label mode. Multi-class mode identifies a single class label for
+    #   each document and multi-label mode identifies one or more class labels
+    #   for each document. Multiple labels for an individual document are
+    #   separated by a delimiter. The default delimiter between labels is a
+    #   pipe (\|).
     #
     # @option params [String] :model_kms_key_id
     #   ID for the KMS key that Amazon Comprehend uses to encrypt trained
@@ -2950,19 +2955,18 @@ module Aws::Comprehend
     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*
+    # provide as input. 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.
+    #   A list of up to 10 text strings. Each string has a maximum size of 1
+    #   KB, and the maximum size of the list is 10 KB.
     #
     # @option params [required, String] :language_code
     #   The language of the input text. Currently, English is the only
@@ -4340,9 +4344,9 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
-    # Starts an asynchronous document classification job. Use the
-    # `DescribeDocumentClassificationJob` operation to track the progress of
-    # the job.
+    # Starts an asynchronous document classification job using a custom
+    # classification model. Use the `DescribeDocumentClassificationJob`
+    # operation to track the progress of the job.
     #
     # @option params [String] :job_name
     #   The identifier of the job.
@@ -5909,7 +5913,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.77.0'
+      context[:gem_version] = '1.78.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -780,16 +780,19 @@ module Aws::Comprehend
     # @!attribute [rw] endpoint_arn
     #   The Amazon Resource Number (ARN) of the endpoint.
     #
-    #   For prompt classification, Amazon Comprehend provides the endpoint
-    #   ARN: `zzz`.
+    #   For prompt safety classification, Amazon Comprehend provides the
+    #   endpoint ARN. For more information about prompt safety classifiers,
+    #   see [Prompt safety classification][1] in the *Amazon Comprehend
+    #   Developer Guide*
     #
     #   For custom classification, you create an endpoint for your custom
     #   model. For more information, see [Using Amazon Comprehend
-    #   endpoints][1].
+    #   endpoints][2].
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
+    #   [1]: https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification
+    #   [2]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
     #   @return [String]
     #
     # @!attribute [rw] bytes
@@ -799,8 +802,8 @@ module Aws::Comprehend
     #   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.
+    #   To classify a document using the prompt safety 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
@@ -835,19 +838,19 @@ module Aws::Comprehend
 
     # @!attribute [rw] classes
     #   The classes used by the document being analyzed. These are used for
-    #   multi-class trained models. Individual classes are mutually
+    #   models trained in multi-class mode. Individual classes are mutually
     #   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.
+    #   For prompt safety classification, the response includes only two
+    #   classes (SAFE\_PROMPT and UNSAFE\_PROMPT), along with a confidence
+    #   score for each class. The value range of the score is zero to one,
+    #   where one is the highest confidence.
     #   @return [Array<Types::DocumentClass>]
     #
     # @!attribute [rw] labels
-    #   The labels used the document being analyzed. These are used for
+    #   The labels used in 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 mutually
     #   exclusive. For example, a movie can be just an action movie, or it
@@ -1074,11 +1077,12 @@ module Aws::Comprehend
     #
     # @!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 (\|).
+    #   classifier can be trained in multi-class (single-label) mode or
+    #   multi-label mode. Multi-class mode identifies a single class label
+    #   for each document and multi-label mode identifies one or more class
+    #   labels for each document. Multiple labels for an individual document
+    #   are separated by a delimiter. The default delimiter between labels
+    #   is a pipe (\|).
     #   @return [String]
     #
     # @!attribute [rw] model_kms_key_id
@@ -2669,8 +2673,8 @@ module Aws::Comprehend
     end
 
     # @!attribute [rw] text_segments
-    #   A list of up to 10 text strings. The maximum size for the list is 10
-    #   KB.
+    #   A list of up to 10 text strings. Each string has a maximum size of 1
+    #   KB, and the maximum size of the list is 10 KB.
     #   @return [Array<Types::TextSegment>]
     #
     # @!attribute [rw] language_code
@@ -3411,10 +3415,10 @@ module Aws::Comprehend
     #   chose `TEXTRACT_ANALYZE_DOCUMENT` as the read action, you must
     #   specify one or both of the following values:
     #
-    #   * `TABLES` - Returns information about any tables that are detected
-    #     in the input document.
+    #   * `TABLES` - Returns additional information about any tables that
+    #     are detected in the input document.
     #
-    #   * `FORMS` - Returns information and the data from any forms that are
+    #   * `FORMS` - Returns additional information about any forms that are
     #     detected in the input document.
     #   @return [Array<String>]
     #
@@ -4470,8 +4474,8 @@ module Aws::Comprehend
     #
     #   Entity types must not contain the following invalid characters: \\n
     #   (line break), \\\\n (escaped line break, \\r (carriage return),
-    #   \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),
-    #   space, and , (comma).
+    #   \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab), and
+    #   , (comma).
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem AWS API Documentation
@@ -5094,23 +5098,32 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
-    # Provides additional detail about why the request failed:
+    # Provides additional detail about why the request failed.
     #
-    # * Document size is too large - Check the size of your file and
-    #   resubmit the request.
+    # @!attribute [rw] reason
+    #   Reason codes include the following values:
     #
-    # * Document type is not supported - Check the file type and resubmit
-    #   the request.
+    #   * DOCUMENT\_SIZE\_EXCEEDED - Document size is too large. Check the
+    #     size of your file and resubmit the request.
     #
-    # * Too many pages in the document - Check the number of pages in your
-    #   file and resubmit the request.
+    #   * UNSUPPORTED\_DOC\_TYPE - Document type is not supported. Check the
+    #     file type and resubmit the request.
     #
-    # * Access denied to Amazon Textract - Verify that your account has
-    #   permission to use Amazon Textract API operations and resubmit the
-    #   request.
+    #   * PAGE\_LIMIT\_EXCEEDED - Too many pages in the document. Check the
+    #     number of pages in your file and resubmit the request.
     #
-    # @!attribute [rw] reason
-    #   Reason code is `INVALID_DOCUMENT`.
+    #   * TEXTRACT\_ACCESS\_DENIED - Access denied to Amazon Textract.
+    #     Verify that your account has permission to use Amazon Textract API
+    #     operations and resubmit the request.
+    #
+    #   * NOT\_TEXTRACT\_JSON - Document is not Amazon Textract JSON format.
+    #     Verify the format and resubmit the request.
+    #
+    #   * MISMATCHED\_TOTAL\_PAGE\_COUNT - Check the number of pages in your
+    #     file and resubmit the request.
+    #
+    #   * INVALID\_DOCUMENT - Invalid document. Check the file and resubmit
+    #     the request.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InvalidRequestDetail AWS API Documentation
@@ -5130,20 +5143,7 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] detail
-    #   Provides additional detail about why the request failed:
-    #
-    #   * Document size is too large - Check the size of your file and
-    #     resubmit the request.
-    #
-    #   * Document type is not supported - Check the file type and resubmit
-    #     the request.
-    #
-    #   * Too many pages in the document - Check the number of pages in your
-    #     file and resubmit the request.
-    #
-    #   * Access denied to Amazon Textract - Verify that your account has
-    #     permission to use Amazon Textract API operations and resubmit the
-    #     request.
+    #   Provides additional detail about why the request failed.
     #   @return [Types::InvalidRequestDetail]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InvalidRequestException AWS API Documentation
@@ -8694,7 +8694,7 @@ module Aws::Comprehend
 
     # Toxicity analysis result for one string. For more information about
     # toxicity detection, see [Toxicity detection][1] in the *Amazon
-    # Comprehend Developer Guide*
+    # Comprehend Developer Guide*.
     #
     #
     #
@@ -8705,7 +8705,8 @@ module Aws::Comprehend
     #   @return [Array<Types::ToxicContent>]
     #
     # @!attribute [rw] toxicity
-    #   Overall toxicity score for the string.
+    #   Overall toxicity score for the string. Value range is zero to one,
+    #   where one is the highest confidence.
     #   @return [Float]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ToxicLabels AWS API Documentation
@@ -8717,10 +8718,9 @@ module Aws::Comprehend
       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
-    # languages, [Supported languages][1] in the Comprehend Developer Guide.
+    # Amazon Comprehend can't process the language of the input text. For a
+    # list of supported languages, [Supported languages][1] in the
+    # Comprehend Developer Guide.
     #
     #
     #

data/lib/aws-sdk-comprehend.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.77.0
+  version: 1.78.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core