Class: Aws::Comprehend::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Comprehend::Client

show all

Includes:: Aws::ClientStubs

Defined in:: lib/aws-sdk-comprehend/client.rb

Overview

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 Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#batch_detect_dominant_language(params = {}) ⇒ Types::BatchDetectDominantLanguageResponse

Determines the dominant language of the input text for a batch of documents.
#batch_detect_entities(params = {}) ⇒ Types::BatchDetectEntitiesResponse

Inspects the text of a batch of documents for named entities and returns information about them.
#batch_detect_key_phrases(params = {}) ⇒ Types::BatchDetectKeyPhrasesResponse

Detects the key noun phrases found in a batch of documents.
#batch_detect_sentiment(params = {}) ⇒ Types::BatchDetectSentimentResponse

Inspects a batch of documents and returns an inference of the prevailing sentiment, ‘POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`, in each one.
#batch_detect_syntax(params = {}) ⇒ Types::BatchDetectSyntaxResponse

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them.
#batch_detect_targeted_sentiment(params = {}) ⇒ Types::BatchDetectTargetedSentimentResponse

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
#classify_document(params = {}) ⇒ Types::ClassifyDocumentResponse

Creates a classification request to analyze a single document in real-time.
#contains_pii_entities(params = {}) ⇒ Types::ContainsPiiEntitiesResponse

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse

Creates a dataset to upload training or test data for a model associated with a flywheel.
#create_document_classifier(params = {}) ⇒ Types::CreateDocumentClassifierResponse

Creates a new document classifier that you can use to categorize documents.
#create_endpoint(params = {}) ⇒ Types::CreateEndpointResponse

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see [Managing endpoints].
#create_entity_recognizer(params = {}) ⇒ Types::CreateEntityRecognizerResponse

Creates an entity recognizer using submitted files.
#create_flywheel(params = {}) ⇒ Types::CreateFlywheelResponse

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.
#delete_document_classifier(params = {}) ⇒ Struct

Deletes a previously created document classifier.
#delete_endpoint(params = {}) ⇒ Struct

Deletes a model-specific endpoint for a previously-trained custom model.
#delete_entity_recognizer(params = {}) ⇒ Struct

Deletes an entity recognizer.
#delete_flywheel(params = {}) ⇒ Struct

Deletes a flywheel.
#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource-based policy that is attached to a custom model.
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse

Returns information about the dataset that you specify.
#describe_document_classification_job(params = {}) ⇒ Types::DescribeDocumentClassificationJobResponse

Gets the properties associated with a document classification job.
#describe_document_classifier(params = {}) ⇒ Types::DescribeDocumentClassifierResponse

Gets the properties associated with a document classifier.
#describe_dominant_language_detection_job(params = {}) ⇒ Types::DescribeDominantLanguageDetectionJobResponse

Gets the properties associated with a dominant language detection job.
#describe_endpoint(params = {}) ⇒ Types::DescribeEndpointResponse

Gets the properties associated with a specific endpoint.
#describe_entities_detection_job(params = {}) ⇒ Types::DescribeEntitiesDetectionJobResponse

Gets the properties associated with an entities detection job.
#describe_entity_recognizer(params = {}) ⇒ Types::DescribeEntityRecognizerResponse

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
#describe_events_detection_job(params = {}) ⇒ Types::DescribeEventsDetectionJobResponse

Gets the status and details of an events detection job.
#describe_flywheel(params = {}) ⇒ Types::DescribeFlywheelResponse

Provides configuration information about the flywheel.
#describe_flywheel_iteration(params = {}) ⇒ Types::DescribeFlywheelIterationResponse

Retrieve the configuration properties of a flywheel iteration.
#describe_key_phrases_detection_job(params = {}) ⇒ Types::DescribeKeyPhrasesDetectionJobResponse

Gets the properties associated with a key phrases detection job.
#describe_pii_entities_detection_job(params = {}) ⇒ Types::DescribePiiEntitiesDetectionJobResponse

Gets the properties associated with a PII entities detection job.
#describe_resource_policy(params = {}) ⇒ Types::DescribeResourcePolicyResponse

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
#describe_sentiment_detection_job(params = {}) ⇒ Types::DescribeSentimentDetectionJobResponse

Gets the properties associated with a sentiment detection job.
#describe_targeted_sentiment_detection_job(params = {}) ⇒ Types::DescribeTargetedSentimentDetectionJobResponse

Gets the properties associated with a targeted sentiment detection job.
#describe_topics_detection_job(params = {}) ⇒ Types::DescribeTopicsDetectionJobResponse

Gets the properties associated with a topic detection job.
#detect_dominant_language(params = {}) ⇒ Types::DetectDominantLanguageResponse

Determines the dominant language of the input text.
#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse

Detects named entities in input text when you use the pre-trained model.
#detect_key_phrases(params = {}) ⇒ Types::DetectKeyPhrasesResponse

Detects the key noun phrases found in the text.
#detect_pii_entities(params = {}) ⇒ Types::DetectPiiEntitiesResponse

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
#detect_sentiment(params = {}) ⇒ Types::DetectSentimentResponse

Inspects text and returns an inference of the prevailing sentiment (‘POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
#detect_syntax(params = {}) ⇒ Types::DetectSyntaxResponse

Inspects text for syntax and the part of speech of words in the document.
#detect_targeted_sentiment(params = {}) ⇒ Types::DetectTargetedSentimentResponse

Inspects the input text and returns a sentiment analysis for each entity identified in the text.
#detect_toxic_content(params = {}) ⇒ Types::DetectToxicContentResponse

Performs toxicity analysis on the list of text strings that you provide as input.
#import_model(params = {}) ⇒ Types::ImportModelResponse

Creates a new custom model that replicates a source custom model that you import.
#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse

List the datasets that you have configured in this Region.
#list_document_classification_jobs(params = {}) ⇒ Types::ListDocumentClassificationJobsResponse

Gets a list of the documentation classification jobs that you have submitted.
#list_document_classifier_summaries(params = {}) ⇒ Types::ListDocumentClassifierSummariesResponse

Gets a list of summaries of the document classifiers that you have created.
#list_document_classifiers(params = {}) ⇒ Types::ListDocumentClassifiersResponse

Gets a list of the document classifiers that you have created.
#list_dominant_language_detection_jobs(params = {}) ⇒ Types::ListDominantLanguageDetectionJobsResponse

Gets a list of the dominant language detection jobs that you have submitted.
#list_endpoints(params = {}) ⇒ Types::ListEndpointsResponse

Gets a list of all existing endpoints that you’ve created.
#list_entities_detection_jobs(params = {}) ⇒ Types::ListEntitiesDetectionJobsResponse

Gets a list of the entity detection jobs that you have submitted.
#list_entity_recognizer_summaries(params = {}) ⇒ Types::ListEntityRecognizerSummariesResponse

Gets a list of summaries for the entity recognizers that you have created.
#list_entity_recognizers(params = {}) ⇒ Types::ListEntityRecognizersResponse

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training.
#list_events_detection_jobs(params = {}) ⇒ Types::ListEventsDetectionJobsResponse

Gets a list of the events detection jobs that you have submitted.
#list_flywheel_iteration_history(params = {}) ⇒ Types::ListFlywheelIterationHistoryResponse

Information about the history of a flywheel iteration.
#list_flywheels(params = {}) ⇒ Types::ListFlywheelsResponse

Gets a list of the flywheels that you have created.
#list_key_phrases_detection_jobs(params = {}) ⇒ Types::ListKeyPhrasesDetectionJobsResponse

Get a list of key phrase detection jobs that you have submitted.
#list_pii_entities_detection_jobs(params = {}) ⇒ Types::ListPiiEntitiesDetectionJobsResponse

Gets a list of the PII entity detection jobs that you have submitted.
#list_sentiment_detection_jobs(params = {}) ⇒ Types::ListSentimentDetectionJobsResponse

Gets a list of sentiment detection jobs that you have submitted.
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a given Amazon Comprehend resource.
#list_targeted_sentiment_detection_jobs(params = {}) ⇒ Types::ListTargetedSentimentDetectionJobsResponse

Gets a list of targeted sentiment detection jobs that you have submitted.
#list_topics_detection_jobs(params = {}) ⇒ Types::ListTopicsDetectionJobsResponse

Gets a list of the topic detection jobs that you have submitted.
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Attaches a resource-based policy to a custom model.
#start_document_classification_job(params = {}) ⇒ Types::StartDocumentClassificationJobResponse

Starts an asynchronous document classification job using a custom classification model.
#start_dominant_language_detection_job(params = {}) ⇒ Types::StartDominantLanguageDetectionJobResponse

Starts an asynchronous dominant language detection job for a collection of documents.
#start_entities_detection_job(params = {}) ⇒ Types::StartEntitiesDetectionJobResponse

Starts an asynchronous entity detection job for a collection of documents.
#start_events_detection_job(params = {}) ⇒ Types::StartEventsDetectionJobResponse

Starts an asynchronous event detection job for a collection of documents.
#start_flywheel_iteration(params = {}) ⇒ Types::StartFlywheelIterationResponse

Start the flywheel iteration.This operation uses any new datasets to train a new model version.
#start_key_phrases_detection_job(params = {}) ⇒ Types::StartKeyPhrasesDetectionJobResponse

Starts an asynchronous key phrase detection job for a collection of documents.
#start_pii_entities_detection_job(params = {}) ⇒ Types::StartPiiEntitiesDetectionJobResponse

Starts an asynchronous PII entity detection job for a collection of documents.
#start_sentiment_detection_job(params = {}) ⇒ Types::StartSentimentDetectionJobResponse

Starts an asynchronous sentiment detection job for a collection of documents.
#start_targeted_sentiment_detection_job(params = {}) ⇒ Types::StartTargetedSentimentDetectionJobResponse

Starts an asynchronous targeted sentiment detection job for a collection of documents.
#start_topics_detection_job(params = {}) ⇒ Types::StartTopicsDetectionJobResponse

Starts an asynchronous topic detection job.
#stop_dominant_language_detection_job(params = {}) ⇒ Types::StopDominantLanguageDetectionJobResponse

Stops a dominant language detection job in progress.
#stop_entities_detection_job(params = {}) ⇒ Types::StopEntitiesDetectionJobResponse

Stops an entities detection job in progress.
#stop_events_detection_job(params = {}) ⇒ Types::StopEventsDetectionJobResponse

Stops an events detection job in progress.
#stop_key_phrases_detection_job(params = {}) ⇒ Types::StopKeyPhrasesDetectionJobResponse

Stops a key phrases detection job in progress.
#stop_pii_entities_detection_job(params = {}) ⇒ Types::StopPiiEntitiesDetectionJobResponse

Stops a PII entities detection job in progress.
#stop_sentiment_detection_job(params = {}) ⇒ Types::StopSentimentDetectionJobResponse

Stops a sentiment detection job in progress.
#stop_targeted_sentiment_detection_job(params = {}) ⇒ Types::StopTargetedSentimentDetectionJobResponse

Stops a targeted sentiment detection job in progress.
#stop_training_document_classifier(params = {}) ⇒ Struct

Stops a document classifier training job while in progress.
#stop_training_entity_recognizer(params = {}) ⇒ Struct

Stops an entity recognizer training job while in progress.
#tag_resource(params = {}) ⇒ Struct

Associates a specific tag with an Amazon Comprehend resource.
#untag_resource(params = {}) ⇒ Struct

Removes a specific tag associated with an Amazon Comprehend resource.
#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse

Updates information about the specified endpoint.
#update_flywheel(params = {}) ⇒ Types::UpdateFlywheelResponse

Update the configuration information for an existing flywheel.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

Constructor Details

#initialize(options) ⇒ `Client`

Returns a new instance of Client.

Options Hash (options):

:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.
- ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.
- ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
- ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.
- ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.
- ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.
- ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.
- ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
- ‘Aws.config`
- The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.
- ENV, ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.
:region (required, String) —
The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
:adaptive_retry_wait_to_fill (Boolean) — default: 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.
:client_side_monitoring (Boolean) — default: false —

When ‘true`, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —

Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When ‘true`, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —

Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —

See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:disable_request_compression (Boolean) — default: false —

When set to ‘true’ the request body will not be compressed for supported operations.
:endpoint (String) —

The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —

When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —

When set to ‘true`, endpoint discovery will be enabled for operations when available.
:ignore_configured_endpoint_urls (Boolean) —

Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the ‘:logger` at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 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.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:request_min_compression_size_bytes (Integer) — default: 10240 —

The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
:retry_backoff (Proc) —

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_jitter (Symbol) — default: :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. This option is only used in the ‘legacy` retry mode.

@see www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —

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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.
:retry_max_delay (Integer) — default: 0 —

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.
:retry_mode (String) — default: "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.
:sdk_ua_app_id (String) —

A unique and opaque application ID that is appended to the User-Agent header as app/<sdk_ua_app_id>. It should have a maximum length of 50.
:secret_access_key (String)
:session_token (String)
:simple_json (Boolean) — default: false —

Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

When ‘:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.
:stub_responses (Boolean) — default: false —

Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:token_provider (Aws::TokenProvider) —
A Bearer Token Provider. This can be an instance of any one of the following classes:
- ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.
- ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.
When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —

When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.
:use_fips_endpoint (Boolean) —

When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.
:validate_params (Boolean) — default: true —

When ‘true`, request parameters are validated before sending the request.
:endpoint_provider (Aws::Comprehend::EndpointProvider) —

The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Comprehend::EndpointParameters`
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_open_timeout (Float) — default: 15 —

The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.
:http_read_timeout (Float) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_idle_timeout (Float) — default: 5 —

The number of 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.
:http_continue_timeout (Float) — default: 1 —

The number of seconds to wait for a 100-continue response before sending the 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.
:ssl_timeout (Float) — default: nil —

Sets the SSL timeout in seconds.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP debug output will be sent to the `:logger`.
:ssl_verify_peer (Boolean) — default: true —

When ‘true`, SSL peer certificates are verified when establishing a connection.
:ssl_ca_bundle (String) —

Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_directory (String) —

Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



395
396
397

# File 'lib/aws-sdk-comprehend/client.rb', line 395

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



5929
5930
5931

# File 'lib/aws-sdk-comprehend/client.rb', line 5929

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



5932
5933
5934

# File 'lib/aws-sdk-comprehend/client.rb', line 5932

def errors_module
  Errors
end

Instance Method Details

#batch_detect_dominant_language(params = {}) ⇒ `Types::BatchDetectDominantLanguageResponse`

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see [Amazon Comprehend Supported Languages].

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-languages.html

Examples:

Request syntax with placeholder values


resp = client.batch_detect_dominant_language({
  text_list: ["CustomerInputString"], # required
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].languages #=> Array
resp.result_list[0].languages[0].language_code #=> String
resp.result_list[0].languages[0].score #=> Float
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Options Hash (params):

:text_list (required, Array<String>) —

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 442

def batch_detect_dominant_language(params = {}, options = {})
  req = build_request(:batch_detect_dominant_language, params)
  req.send_request(options)
end

#batch_detect_entities(params = {}) ⇒ `Types::BatchDetectEntitiesResponse`

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see [Entities] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-entities.html

Examples:

Request syntax with placeholder values


resp = client.batch_detect_entities({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].entities #=> Array
resp.result_list[0].entities[0].score #=> Float
resp.result_list[0].entities[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "COMMERCIAL_ITEM", "EVENT", "DATE", "QUANTITY", "TITLE", "OTHER"
resp.result_list[0].entities[0].text #=> String
resp.result_list[0].entities[0].begin_offset #=> Integer
resp.result_list[0].entities[0].end_offset #=> Integer
resp.result_list[0].entities[0].block_references #=> Array
resp.result_list[0].entities[0].block_references[0].block_id #=> String
resp.result_list[0].entities[0].block_references[0].begin_offset #=> Integer
resp.result_list[0].entities[0].block_references[0].end_offset #=> Integer
resp.result_list[0].entities[0].block_references[0].child_blocks #=> Array
resp.result_list[0].entities[0].block_references[0].child_blocks[0].child_block_id #=> String
resp.result_list[0].entities[0].block_references[0].child_blocks[0].begin_offset #=> Integer
resp.result_list[0].entities[0].block_references[0].child_blocks[0].end_offset #=> Integer
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Options Hash (params):

:text_list (required, Array<String>) —

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 504

def batch_detect_entities(params = {}, options = {})
  req = build_request(:batch_detect_entities, params)
  req.send_request(options)
end

#batch_detect_key_phrases(params = {}) ⇒ `Types::BatchDetectKeyPhrasesResponse`

Detects the key noun phrases found in a batch of documents.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_key_phrases({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].key_phrases #=> Array
resp.result_list[0].key_phrases[0].score #=> Float
resp.result_list[0].key_phrases[0].text #=> String
resp.result_list[0].key_phrases[0].begin_offset #=> Integer
resp.result_list[0].key_phrases[0].end_offset #=> Integer
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Options Hash (params):

:text_list (required, Array<String>) —

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 551

def batch_detect_key_phrases(params = {}, options = {})
  req = build_request(:batch_detect_key_phrases, params)
  req.send_request(options)
end

#batch_detect_sentiment(params = {}) ⇒ `Types::BatchDetectSentimentResponse`

Inspects a batch of documents and returns an inference of the prevailing sentiment, ‘POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`, in each one.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_sentiment({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.result_list[0].sentiment_score.positive #=> Float
resp.result_list[0].sentiment_score.negative #=> Float
resp.result_list[0].sentiment_score.neutral #=> Float
resp.result_list[0].sentiment_score.mixed #=> Float
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Options Hash (params):

:text_list (required, Array<String>) —

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 600

def batch_detect_sentiment(params = {}, options = {})
  req = build_request(:batch_detect_sentiment, params)
  req.send_request(options)
end

#batch_detect_syntax(params = {}) ⇒ `Types::BatchDetectSyntaxResponse`

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see [Syntax] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html

Examples:

Request syntax with placeholder values


resp = client.batch_detect_syntax({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].syntax_tokens #=> Array
resp.result_list[0].syntax_tokens[0].token_id #=> Integer
resp.result_list[0].syntax_tokens[0].text #=> String
resp.result_list[0].syntax_tokens[0].begin_offset #=> Integer
resp.result_list[0].syntax_tokens[0].end_offset #=> Integer
resp.result_list[0].syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "CCONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
resp.result_list[0].syntax_tokens[0].part_of_speech.score #=> Float
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Options Hash (params):

:text_list (required, Array<String>) —

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.
:language_code (required, String) —

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German (“de”), English (“en”), Spanish (“es”), French (“fr”), Italian (“it”), or Portuguese (“pt”). All documents must be in the same language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 657

def batch_detect_syntax(params = {}, options = {})
  req = build_request(:batch_detect_syntax, params)
  req.send_request(options)
end

#batch_detect_targeted_sentiment(params = {}) ⇒ `Types::BatchDetectTargetedSentimentResponse`

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

For more information about targeted sentiment, see [Targeted sentiment] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html

Examples:

Request syntax with placeholder values


resp = client.batch_detect_targeted_sentiment({
  text_list: ["CustomerInputString"], # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.result_list #=> Array
resp.result_list[0].index #=> Integer
resp.result_list[0].entities #=> Array
resp.result_list[0].entities[0].descriptive_mention_index #=> Array
resp.result_list[0].entities[0].descriptive_mention_index[0] #=> Integer
resp.result_list[0].entities[0].mentions #=> Array
resp.result_list[0].entities[0].mentions[0].score #=> Float
resp.result_list[0].entities[0].mentions[0].group_score #=> Float
resp.result_list[0].entities[0].mentions[0].text #=> String
resp.result_list[0].entities[0].mentions[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "FACILITY", "BRAND", "COMMERCIAL_ITEM", "MOVIE", "MUSIC", "BOOK", "SOFTWARE", "GAME", "PERSONAL_TITLE", "EVENT", "DATE", "QUANTITY", "ATTRIBUTE", "OTHER"
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.positive #=> Float
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.negative #=> Float
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.neutral #=> Float
resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.mixed #=> Float
resp.result_list[0].entities[0].mentions[0].begin_offset #=> Integer
resp.result_list[0].entities[0].mentions[0].end_offset #=> Integer
resp.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Options Hash (params):

:text_list (required, Array<String>) —

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
:language_code (required, String) —

The language of the input documents. Currently, English is the only supported language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 721

def batch_detect_targeted_sentiment(params = {}, options = {})
  req = build_request(:batch_detect_targeted_sentiment, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-comprehend/client.rb', line 5907

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-comprehend'
  context[:gem_version] = '1.79.0'
  Seahorse::Client::Request.new(handlers, context)
end

#classify_document(params = {}) ⇒ `Types::ClassifyDocumentResponse`

Creates a classification request to analyze a single document in real-time. ‘ClassifyDocument` supports the following model types:

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 Amazon Textract API output. For more information, see [Custom classification] 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] in the *Amazon Comprehend Developer Guide*.

If the system detects errors while processing a page in the input 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 details about this exception, see [ Errors in semi-structured documents] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html [2]: docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification [3]: docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html

Examples:

Request syntax with placeholder values


resp = client.classify_document({
  text: "CustomerInputString",
  endpoint_arn: "DocumentClassifierEndpointArn", # required
  bytes: "data",
  document_reader_config: {
    document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
    document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
    feature_types: ["TABLES"], # accepts TABLES, FORMS
  },
})

Response structure


resp.classes #=> Array
resp.classes[0].name #=> String
resp.classes[0].score #=> Float
resp.classes[0].page #=> Integer
resp.labels #=> Array
resp.labels[0].name #=> String
resp.labels[0].score #=> Float
resp.labels[0].page #=> Integer
resp.document_metadata.pages #=> Integer
resp.document_metadata.extracted_characters #=> Array
resp.document_metadata.extracted_characters[0].page #=> Integer
resp.document_metadata.extracted_characters[0].count #=> Integer
resp.document_type #=> Array
resp.document_type[0].page #=> Integer
resp.document_type[0].type #=> String, one of "NATIVE_PDF", "SCANNED_PDF", "MS_WORD", "IMAGE", "PLAIN_TEXT", "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON", "TEXTRACT_ANALYZE_DOCUMENT_JSON"
resp.errors #=> Array
resp.errors[0].page #=> Integer
resp.errors[0].error_code #=> String, one of "TEXTRACT_BAD_PAGE", "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED", "PAGE_CHARACTERS_EXCEEDED", "PAGE_SIZE_EXCEEDED", "INTERNAL_SERVER_ERROR"
resp.errors[0].error_message #=> String
resp.warnings #=> Array
resp.warnings[0].page #=> Integer
resp.warnings[0].warn_code #=> String, one of "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL", "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL"
resp.warnings[0].warn_message #=> String

Options Hash (params):

:text (String) —

The document text to be analyzed. If you enter text using this parameter, do not use the ‘Bytes` parameter.
:endpoint_arn (required, String) —

The Amazon Resource Number (ARN) of the endpoint.

For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see [Prompt safety classification] 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]: docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification [2]: docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html
:bytes (String, StringIO, File) —

Use the ‘Bytes` parameter to input a text, PDF, Word or image 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 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 SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see [ Inputs for real-time custom analysis] in the Comprehend Developer Guide.

If you use the ‘Bytes` parameter, do not use the `Text` parameter.

[1]: docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html
:document_reader_config (Types::DocumentReaderConfig) —

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 858

def classify_document(params = {}, options = {})
  req = build_request(:classify_document, params)
  req.send_request(options)
end

#contains_pii_entities(params = {}) ⇒ `Types::ContainsPiiEntitiesResponse`

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

Examples:

Request syntax with placeholder values


resp = client.contains_pii_entities({
  text: "String", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.labels #=> Array
resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.labels[0].score #=> Float

Options Hash (params):

:text (required, String) —

A UTF-8 text string. The maximum string size is 100 KB.
:language_code (required, String) —

The language of the input documents. Currently, English is the only valid language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 895

def contains_pii_entities(params = {}, options = {})
  req = build_request(:contains_pii_entities, params)
  req.send_request(options)
end

#create_dataset(params = {}) ⇒ `Types::CreateDatasetResponse`

Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.create_dataset({
  flywheel_arn: "ComprehendFlywheelArn", # required
  dataset_name: "ComprehendArnName", # required
  dataset_type: "TRAIN", # accepts TRAIN, TEST
  description: "Description",
  input_data_config: { # required
    augmented_manifests: [
      {
        attribute_names: ["AttributeNamesListItem"], # required
        s3_uri: "S3Uri", # required
        annotation_data_s3_uri: "S3Uri",
        source_documents_s3_uri: "S3Uri",
        document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
      },
    ],
    data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
    document_classifier_input_data_config: {
      s3_uri: "S3Uri", # required
      label_delimiter: "LabelDelimiter",
    },
    entity_recognizer_input_data_config: {
      annotations: {
        s3_uri: "S3Uri", # required
      },
      documents: { # required
        s3_uri: "S3Uri", # required
        input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
      },
      entity_list: {
        s3_uri: "S3Uri", # required
      },
    },
  },
  client_request_token: "ClientRequestTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.dataset_arn #=> String

Options Hash (params):

:flywheel_arn (required, String) —

The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.
:dataset_name (required, String) —

Name of the dataset.
:dataset_type (String) —

The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.
:description (String) —

Description of the dataset.
:input_data_config (required, Types::DatasetInputDataConfig) —

Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:tags (Array<Types::Tag>) —

Tags for the dataset.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 993

def create_dataset(params = {}, options = {})
  req = build_request(:create_dataset, params)
  req.send_request(options)
end

#create_document_classifier(params = {}) ⇒ `Types::CreateDocumentClassifierResponse`

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see [Training classifier models] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html

Examples:

Request syntax with placeholder values


resp = client.create_document_classifier({
  document_classifier_name: "ComprehendArnName", # required
  version_name: "VersionName",
  data_access_role_arn: "IamRoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  input_data_config: { # required
    data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
    s3_uri: "S3Uri",
    test_s3_uri: "S3Uri",
    label_delimiter: "LabelDelimiter",
    augmented_manifests: [
      {
        s3_uri: "S3Uri", # required
        split: "TRAIN", # accepts TRAIN, TEST
        attribute_names: ["AttributeNamesListItem"], # required
        annotation_data_s3_uri: "S3Uri",
        source_documents_s3_uri: "S3Uri",
        document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
      },
    ],
    document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
    documents: {
      s3_uri: "S3Uri", # required
      test_s3_uri: "S3Uri",
    },
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: {
    s3_uri: "S3Uri",
    kms_key_id: "KmsKeyId",
    flywheel_stats_s3_prefix: "S3Uri",
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
  model_kms_key_id: "KmsKeyId",
  model_policy: "Policy",
})

Response structure


resp.document_classifier_arn #=> String

Options Hash (params):

:document_classifier_name (required, String) —

The name of the document classifier.
:version_name (String) —

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
:tags (Array<Types::Tag>) —

Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.
:input_data_config (required, Types::DocumentClassifierInputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (Types::DocumentClassifierOutputDataConfig) —

Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:language_code (required, String) —

The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:mode (String) —

Indicates the mode in which the classifier will be trained. The 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 (|).
:model_kms_key_id (String) —
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:model_policy (String) —

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

‘“”value“, ”attribute“: [”value“]”`

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

‘’“value”, “attribute”: [“value”]‘`

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1172

def create_document_classifier(params = {}, options = {})
  req = build_request(:create_document_classifier, params)
  req.send_request(options)
end

#create_endpoint(params = {}) ⇒ `Types::CreateEndpointResponse`

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.create_endpoint({
  endpoint_name: "ComprehendEndpointName", # required
  model_arn: "ComprehendModelArn",
  desired_inference_units: 1, # required
  client_request_token: "ClientRequestTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  data_access_role_arn: "IamRoleArn",
  flywheel_arn: "ComprehendFlywheelArn",
})

Response structure


resp.endpoint_arn #=> String
resp.model_arn #=> String

Options Hash (params):

:endpoint_name (required, String) —

This is the descriptive suffix that becomes part of the ‘EndpointArn` used for all subsequent requests to this resource.
:model_arn (String) —

The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
:desired_inference_units (required, Integer) —

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
:client_request_token (String) —

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ‘ResourceInUseException`.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:tags (Array<Types::Tag>) —

Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with “Sales” as the key might be added to an endpoint to indicate its use by the sales department.
:data_access_role_arn (String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
:flywheel_arn (String) —

The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1252

def create_endpoint(params = {}, options = {})
  req = build_request(:create_endpoint, params)
  req.send_request(options)
end

#create_entity_recognizer(params = {}) ⇒ `Types::CreateEntityRecognizerResponse`

Creates an entity recognizer using submitted files. After your ‘CreateEntityRecognizer` request is submitted, you can check job status using the `DescribeEntityRecognizer` API.

Examples:

Request syntax with placeholder values


resp = client.create_entity_recognizer({
  recognizer_name: "ComprehendArnName", # required
  version_name: "VersionName",
  data_access_role_arn: "IamRoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  input_data_config: { # required
    data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
    entity_types: [ # required
      {
        type: "EntityTypeName", # required
      },
    ],
    documents: {
      s3_uri: "S3Uri", # required
      test_s3_uri: "S3Uri",
      input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    },
    annotations: {
      s3_uri: "S3Uri", # required
      test_s3_uri: "S3Uri",
    },
    entity_list: {
      s3_uri: "S3Uri", # required
    },
    augmented_manifests: [
      {
        s3_uri: "S3Uri", # required
        split: "TRAIN", # accepts TRAIN, TEST
        attribute_names: ["AttributeNamesListItem"], # required
        annotation_data_s3_uri: "S3Uri",
        source_documents_s3_uri: "S3Uri",
        document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
      },
    ],
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  model_kms_key_id: "KmsKeyId",
  model_policy: "Policy",
})

Response structure


resp.entity_recognizer_arn #=> String

Options Hash (params):

:recognizer_name (required, String) —

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/Region.
:version_name (String) —

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
:tags (Array<Types::Tag>) —

Tags to associate with the entity recognizer. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.
:input_data_config (required, Types::EntityRecognizerInputDataConfig) —

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:language_code (required, String) —

You can specify any of the following languages: English (“en”), Spanish (“es”), French (“fr”), Italian (“it”), German (“de”), or Portuguese (“pt”). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:model_kms_key_id (String) —
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:model_policy (String) —

The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.

Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

‘“”value“, ”attribute“: [”value“]”`

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

‘’“value”, “attribute”: [“value”]‘`

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1415

def create_entity_recognizer(params = {}, options = {})
  req = build_request(:create_entity_recognizer, params)
  req.send_request(options)
end

#create_flywheel(params = {}) ⇒ `Types::CreateFlywheelResponse`

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model’s training data and test data into the flywheel’s data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.create_flywheel({
  flywheel_name: "ComprehendArnName", # required
  active_model_arn: "ComprehendModelArn",
  data_access_role_arn: "IamRoleArn", # required
  task_config: {
    language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    document_classification_config: {
      mode: "MULTI_CLASS", # required, accepts MULTI_CLASS, MULTI_LABEL
      labels: ["LabelListItem"],
    },
    entity_recognition_config: {
      entity_types: [ # required
        {
          type: "EntityTypeName", # required
        },
      ],
    },
  },
  model_type: "DOCUMENT_CLASSIFIER", # accepts DOCUMENT_CLASSIFIER, ENTITY_RECOGNIZER
  data_lake_s3_uri: "FlywheelS3Uri", # required
  data_security_config: {
    model_kms_key_id: "KmsKeyId",
    volume_kms_key_id: "KmsKeyId",
    data_lake_kms_key_id: "KmsKeyId",
    vpc_config: {
      security_group_ids: ["SecurityGroupId"], # required
      subnets: ["SubnetId"], # required
    },
  },
  client_request_token: "ClientRequestTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.flywheel_arn #=> String
resp.active_model_arn #=> String

Options Hash (params):

:flywheel_name (required, String) —

Name for the flywheel.
:active_model_arn (String) —

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set ‘TaskConfig` or `ModelType` if you specify an `ActiveModelArn`.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
:task_config (Types::TaskConfig) —

Configuration about the model associated with the flywheel. You need to set ‘TaskConfig` if you are creating a flywheel for a new model.
:model_type (String) —

The model type. You need to set ‘ModelType` if you are creating a flywheel for a new model.
:data_lake_s3_uri (required, String) —

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
:data_security_config (Types::DataSecurityConfig) —

Data security configurations.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:tags (Array<Types::Tag>) —

The tags to associate with this flywheel.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1537

def create_flywheel(params = {}, options = {})
  req = build_request(:create_flywheel, params)
  req.send_request(options)
end

#delete_document_classifier(params = {}) ⇒ `Struct`

Deletes a previously created document classifier

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ‘ResourceInUseException` will be returned.

This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.

Examples:

Request syntax with placeholder values


resp = client.delete_document_classifier({
  document_classifier_arn: "DocumentClassifierArn", # required
})

Options Hash (params):

:document_classifier_arn (required, String) —

The Amazon Resource Name (ARN) that identifies the document classifier.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1569

def delete_document_classifier(params = {}, options = {})
  req = build_request(:delete_document_classifier, params)
  req.send_request(options)
end

#delete_endpoint(params = {}) ⇒ `Struct`

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint({
  endpoint_arn: "ComprehendEndpointArn", # required
})

Options Hash (params):

:endpoint_arn (required, String) —

The Amazon Resource Number (ARN) of the endpoint being deleted.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1597

def delete_endpoint(params = {}, options = {})
  req = build_request(:delete_endpoint, params)
  req.send_request(options)
end

#delete_entity_recognizer(params = {}) ⇒ `Struct`

Deletes an entity recognizer.

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ‘ResourceInUseException` will be returned.

This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

Examples:

Request syntax with placeholder values


resp = client.delete_entity_recognizer({
  entity_recognizer_arn: "EntityRecognizerArn", # required
})

Options Hash (params):

:entity_recognizer_arn (required, String) —

The Amazon Resource Name (ARN) that identifies the entity recognizer.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1628

def delete_entity_recognizer(params = {}, options = {})
  req = build_request(:delete_entity_recognizer, params)
  req.send_request(options)
end

#delete_flywheel(params = {}) ⇒ `Struct`

Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

For more information about flywheels, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.delete_flywheel({
  flywheel_arn: "ComprehendFlywheelArn", # required
})

Options Hash (params):

:flywheel_arn (required, String) —

The Amazon Resource Number (ARN) of the flywheel to delete.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1659

def delete_flywheel(params = {}, options = {})
  req = build_request(:delete_flywheel, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ `Struct`

Deletes a resource-based policy that is attached to a custom model.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ComprehendModelArn", # required
  policy_revision_id: "PolicyRevisionId",
})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
:policy_revision_id (String) —

The revision ID of the policy to delete.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1686

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#describe_dataset(params = {}) ⇒ `Types::DescribeDatasetResponse`

Returns information about the dataset that you specify. For more information about datasets, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.describe_dataset({
  dataset_arn: "ComprehendDatasetArn", # required
})

Response structure


resp.dataset_properties.dataset_arn #=> String
resp.dataset_properties.dataset_name #=> String
resp.dataset_properties.dataset_type #=> String, one of "TRAIN", "TEST"
resp.dataset_properties.dataset_s3_uri #=> String
resp.dataset_properties.description #=> String
resp.dataset_properties.status #=> String, one of "CREATING", "COMPLETED", "FAILED"
resp.dataset_properties.message #=> String
resp.dataset_properties.number_of_documents #=> Integer
resp.dataset_properties.creation_time #=> Time
resp.dataset_properties.end_time #=> Time

Options Hash (params):

:dataset_arn (required, String) —

The ARN of the dataset.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1729

def describe_dataset(params = {}, options = {})
  req = build_request(:describe_dataset, params)
  req.send_request(options)
end

#describe_document_classification_job(params = {}) ⇒ `Types::DescribeDocumentClassificationJobResponse`

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

Examples:

Request syntax with placeholder values


resp = client.describe_document_classification_job({
  job_id: "JobId", # required
})

Response structure


resp.document_classification_job_properties.job_id #=> String
resp.document_classification_job_properties.job_arn #=> String
resp.document_classification_job_properties.job_name #=> String
resp.document_classification_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.document_classification_job_properties.message #=> String
resp.document_classification_job_properties.submit_time #=> Time
resp.document_classification_job_properties.end_time #=> Time
resp.document_classification_job_properties.document_classifier_arn #=> String
resp.document_classification_job_properties.input_data_config.s3_uri #=> String
resp.document_classification_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.document_classification_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.document_classification_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.document_classification_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.document_classification_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.document_classification_job_properties.output_data_config.s3_uri #=> String
resp.document_classification_job_properties.output_data_config.kms_key_id #=> String
resp.document_classification_job_properties.data_access_role_arn #=> String
resp.document_classification_job_properties.volume_kms_key_id #=> String
resp.document_classification_job_properties.vpc_config.security_group_ids #=> Array
resp.document_classification_job_properties.vpc_config.security_group_ids[0] #=> String
resp.document_classification_job_properties.vpc_config.subnets #=> Array
resp.document_classification_job_properties.vpc_config.subnets[0] #=> String
resp.document_classification_job_properties.flywheel_arn #=> String

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The ‘StartDocumentClassificationJob` operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1782

def describe_document_classification_job(params = {}, options = {})
  req = build_request(:describe_document_classification_job, params)
  req.send_request(options)
end

#describe_document_classifier(params = {}) ⇒ `Types::DescribeDocumentClassifierResponse`

Gets the properties associated with a document classifier.

Examples:

Request syntax with placeholder values


resp = client.describe_document_classifier({
  document_classifier_arn: "DocumentClassifierArn", # required
})

Response structure


resp.document_classifier_properties.document_classifier_arn #=> String
resp.document_classifier_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
resp.document_classifier_properties.message #=> String
resp.document_classifier_properties.submit_time #=> Time
resp.document_classifier_properties.end_time #=> Time
resp.document_classifier_properties.training_start_time #=> Time
resp.document_classifier_properties.training_end_time #=> Time
resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.document_classifier_properties.input_data_config.s3_uri #=> String
resp.document_classifier_properties.input_data_config.test_s3_uri #=> String
resp.document_classifier_properties.input_data_config.label_delimiter #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.document_classifier_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.document_classifier_properties.input_data_config.document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.document_classifier_properties.input_data_config.documents.s3_uri #=> String
resp.document_classifier_properties.input_data_config.documents.test_s3_uri #=> String
resp.document_classifier_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.document_classifier_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.document_classifier_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.document_classifier_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
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.output_data_config.flywheel_stats_s3_prefix #=> String
resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
resp.document_classifier_properties.classifier_metadata.number_of_trained_documents #=> Integer
resp.document_classifier_properties.classifier_metadata.number_of_test_documents #=> Integer
resp.document_classifier_properties.classifier_metadata.evaluation_metrics.accuracy #=> Float
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"
resp.document_classifier_properties.model_kms_key_id #=> String
resp.document_classifier_properties.version_name #=> String
resp.document_classifier_properties.source_model_arn #=> String
resp.document_classifier_properties.flywheel_arn #=> String

Options Hash (params):

:document_classifier_arn (required, String) —

The Amazon Resource Name (ARN) that identifies the document classifier. The ‘CreateDocumentClassifier` operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1863

def describe_document_classifier(params = {}, options = {})
  req = build_request(:describe_document_classifier, params)
  req.send_request(options)
end

#describe_dominant_language_detection_job(params = {}) ⇒ `Types::DescribeDominantLanguageDetectionJobResponse`

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_dominant_language_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.dominant_language_detection_job_properties.job_id #=> String
resp.dominant_language_detection_job_properties.job_arn #=> String
resp.dominant_language_detection_job_properties.job_name #=> String
resp.dominant_language_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.dominant_language_detection_job_properties.message #=> String
resp.dominant_language_detection_job_properties.submit_time #=> Time
resp.dominant_language_detection_job_properties.end_time #=> Time
resp.dominant_language_detection_job_properties.input_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.dominant_language_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.dominant_language_detection_job_properties.output_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties.output_data_config.kms_key_id #=> String
resp.dominant_language_detection_job_properties.data_access_role_arn #=> String
resp.dominant_language_detection_job_properties.volume_kms_key_id #=> String
resp.dominant_language_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.dominant_language_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.dominant_language_detection_job_properties.vpc_config.subnets #=> Array
resp.dominant_language_detection_job_properties.vpc_config.subnets[0] #=> String

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The ‘StartDominantLanguageDetectionJob` operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1914

def describe_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:describe_dominant_language_detection_job, params)
  req.send_request(options)
end

#describe_endpoint(params = {}) ⇒ `Types::DescribeEndpointResponse`

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint({
  endpoint_arn: "ComprehendEndpointArn", # required
})

Response structure


resp.endpoint_properties.endpoint_arn #=> String
resp.endpoint_properties.status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
resp.endpoint_properties.message #=> String
resp.endpoint_properties.model_arn #=> String
resp.endpoint_properties.desired_model_arn #=> String
resp.endpoint_properties.desired_inference_units #=> Integer
resp.endpoint_properties.current_inference_units #=> Integer
resp.endpoint_properties.creation_time #=> Time
resp.endpoint_properties.last_modified_time #=> Time
resp.endpoint_properties.data_access_role_arn #=> String
resp.endpoint_properties.desired_data_access_role_arn #=> String
resp.endpoint_properties.flywheel_arn #=> String

Options Hash (params):

:endpoint_arn (required, String) —

The Amazon Resource Number (ARN) of the endpoint being described.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 1959

def describe_endpoint(params = {}, options = {})
  req = build_request(:describe_endpoint, params)
  req.send_request(options)
end

#describe_entities_detection_job(params = {}) ⇒ `Types::DescribeEntitiesDetectionJobResponse`

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.entities_detection_job_properties.job_id #=> String
resp.entities_detection_job_properties.job_arn #=> String
resp.entities_detection_job_properties.job_name #=> String
resp.entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.entities_detection_job_properties.message #=> String
resp.entities_detection_job_properties.submit_time #=> Time
resp.entities_detection_job_properties.end_time #=> Time
resp.entities_detection_job_properties.entity_recognizer_arn #=> String
resp.entities_detection_job_properties.input_data_config.s3_uri #=> String
resp.entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entities_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.entities_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.entities_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.entities_detection_job_properties.output_data_config.s3_uri #=> String
resp.entities_detection_job_properties.output_data_config.kms_key_id #=> String
resp.entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entities_detection_job_properties.data_access_role_arn #=> String
resp.entities_detection_job_properties.volume_kms_key_id #=> String
resp.entities_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.entities_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.entities_detection_job_properties.vpc_config.subnets #=> Array
resp.entities_detection_job_properties.vpc_config.subnets[0] #=> String
resp.entities_detection_job_properties.flywheel_arn #=> String

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The ‘StartEntitiesDetectionJob` operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2013

def describe_entities_detection_job(params = {}, options = {})
  req = build_request(:describe_entities_detection_job, params)
  req.send_request(options)
end

#describe_entity_recognizer(params = {}) ⇒ `Types::DescribeEntityRecognizerResponse`

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Examples:

Request syntax with placeholder values


resp = client.describe_entity_recognizer({
  entity_recognizer_arn: "EntityRecognizerArn", # required
})

Response structure


resp.entity_recognizer_properties.entity_recognizer_arn #=> String
resp.entity_recognizer_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
resp.entity_recognizer_properties.message #=> String
resp.entity_recognizer_properties.submit_time #=> Time
resp.entity_recognizer_properties.end_time #=> Time
resp.entity_recognizer_properties.training_start_time #=> Time
resp.entity_recognizer_properties.training_end_time #=> Time
resp.entity_recognizer_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.documents.test_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.annotations.test_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties.recognizer_metadata.entity_types #=> Array
resp.entity_recognizer_properties.recognizer_metadata.entity_types[0].type #=> String
resp.entity_recognizer_properties.recognizer_metadata.entity_types[0].evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties.recognizer_metadata.entity_types[0].evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties.recognizer_metadata.entity_types[0].evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties.recognizer_metadata.entity_types[0].number_of_train_mentions #=> Integer
resp.entity_recognizer_properties.data_access_role_arn #=> String
resp.entity_recognizer_properties.volume_kms_key_id #=> String
resp.entity_recognizer_properties.vpc_config.security_group_ids #=> Array
resp.entity_recognizer_properties.vpc_config.security_group_ids[0] #=> String
resp.entity_recognizer_properties.vpc_config.subnets #=> Array
resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
resp.entity_recognizer_properties.model_kms_key_id #=> String
resp.entity_recognizer_properties.version_name #=> String
resp.entity_recognizer_properties.source_model_arn #=> String
resp.entity_recognizer_properties.flywheel_arn #=> String
resp.entity_recognizer_properties.output_data_config.flywheel_stats_s3_prefix #=> String

Options Hash (params):

:entity_recognizer_arn (required, String) —

The Amazon Resource Name (ARN) that identifies the entity recognizer.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2089

def describe_entity_recognizer(params = {}, options = {})
  req = build_request(:describe_entity_recognizer, params)
  req.send_request(options)
end

#describe_events_detection_job(params = {}) ⇒ `Types::DescribeEventsDetectionJobResponse`

Gets the status and details of an events detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_events_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.events_detection_job_properties.job_id #=> String
resp.events_detection_job_properties.job_arn #=> String
resp.events_detection_job_properties.job_name #=> String
resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.events_detection_job_properties.message #=> String
resp.events_detection_job_properties.submit_time #=> Time
resp.events_detection_job_properties.end_time #=> Time
resp.events_detection_job_properties.input_data_config.s3_uri #=> String
resp.events_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.events_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.events_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.events_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.events_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.events_detection_job_properties.output_data_config.s3_uri #=> String
resp.events_detection_job_properties.output_data_config.kms_key_id #=> String
resp.events_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.events_detection_job_properties.data_access_role_arn #=> String
resp.events_detection_job_properties.target_event_types #=> Array
resp.events_detection_job_properties.target_event_types[0] #=> String

Options Hash (params):

:job_id (required, String) —

The identifier of the events detection job.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2135

def describe_events_detection_job(params = {}, options = {})
  req = build_request(:describe_events_detection_job, params)
  req.send_request(options)
end

#describe_flywheel(params = {}) ⇒ `Types::DescribeFlywheelResponse`

Provides configuration information about the flywheel. For more information about flywheels, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.describe_flywheel({
  flywheel_arn: "ComprehendFlywheelArn", # required
})

Response structure


resp.flywheel_properties.flywheel_arn #=> String
resp.flywheel_properties.active_model_arn #=> String
resp.flywheel_properties.data_access_role_arn #=> String
resp.flywheel_properties.task_config.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.flywheel_properties.task_config.document_classification_config.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
resp.flywheel_properties.task_config.document_classification_config.labels #=> Array
resp.flywheel_properties.task_config.document_classification_config.labels[0] #=> String
resp.flywheel_properties.task_config.entity_recognition_config.entity_types #=> Array
resp.flywheel_properties.task_config.entity_recognition_config.entity_types[0].type #=> String
resp.flywheel_properties.data_lake_s3_uri #=> String
resp.flywheel_properties.data_security_config.model_kms_key_id #=> String
resp.flywheel_properties.data_security_config.volume_kms_key_id #=> String
resp.flywheel_properties.data_security_config.data_lake_kms_key_id #=> String
resp.flywheel_properties.data_security_config.vpc_config.security_group_ids #=> Array
resp.flywheel_properties.data_security_config.vpc_config.security_group_ids[0] #=> String
resp.flywheel_properties.data_security_config.vpc_config.subnets #=> Array
resp.flywheel_properties.data_security_config.vpc_config.subnets[0] #=> String
resp.flywheel_properties.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.flywheel_properties.model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
resp.flywheel_properties.message #=> String
resp.flywheel_properties.creation_time #=> Time
resp.flywheel_properties.last_modified_time #=> Time
resp.flywheel_properties.latest_flywheel_iteration #=> String

Options Hash (params):

:flywheel_arn (required, String) —

The Amazon Resource Number (ARN) of the flywheel.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2191

def describe_flywheel(params = {}, options = {})
  req = build_request(:describe_flywheel, params)
  req.send_request(options)
end

#describe_flywheel_iteration(params = {}) ⇒ `Types::DescribeFlywheelIterationResponse`

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.describe_flywheel_iteration({
  flywheel_arn: "ComprehendFlywheelArn", # required
  flywheel_iteration_id: "FlywheelIterationId", # required
})

Response structure


resp.flywheel_iteration_properties.flywheel_arn #=> String
resp.flywheel_iteration_properties.flywheel_iteration_id #=> String
resp.flywheel_iteration_properties.creation_time #=> Time
resp.flywheel_iteration_properties.end_time #=> Time
resp.flywheel_iteration_properties.status #=> String, one of "TRAINING", "EVALUATING", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.flywheel_iteration_properties.message #=> String
resp.flywheel_iteration_properties.evaluated_model_arn #=> String
resp.flywheel_iteration_properties.evaluated_model_metrics.average_f1_score #=> Float
resp.flywheel_iteration_properties.evaluated_model_metrics.average_precision #=> Float
resp.flywheel_iteration_properties.evaluated_model_metrics.average_recall #=> Float
resp.flywheel_iteration_properties.evaluated_model_metrics.average_accuracy #=> Float
resp.flywheel_iteration_properties.trained_model_arn #=> String
resp.flywheel_iteration_properties.trained_model_metrics.average_f1_score #=> Float
resp.flywheel_iteration_properties.trained_model_metrics.average_precision #=> Float
resp.flywheel_iteration_properties.trained_model_metrics.average_recall #=> Float
resp.flywheel_iteration_properties.trained_model_metrics.average_accuracy #=> Float
resp.flywheel_iteration_properties.evaluation_manifest_s3_prefix #=> String

Options Hash (params):

:flywheel_arn (required, String)
:flywheel_iteration_id (required, String)

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2243

def describe_flywheel_iteration(params = {}, options = {})
  req = build_request(:describe_flywheel_iteration, params)
  req.send_request(options)
end

#describe_key_phrases_detection_job(params = {}) ⇒ `Types::DescribeKeyPhrasesDetectionJobResponse`

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_key_phrases_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.key_phrases_detection_job_properties.job_id #=> String
resp.key_phrases_detection_job_properties.job_arn #=> String
resp.key_phrases_detection_job_properties.job_name #=> String
resp.key_phrases_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.key_phrases_detection_job_properties.message #=> String
resp.key_phrases_detection_job_properties.submit_time #=> Time
resp.key_phrases_detection_job_properties.end_time #=> Time
resp.key_phrases_detection_job_properties.input_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.key_phrases_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.key_phrases_detection_job_properties.output_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties.output_data_config.kms_key_id #=> String
resp.key_phrases_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.key_phrases_detection_job_properties.data_access_role_arn #=> String
resp.key_phrases_detection_job_properties.volume_kms_key_id #=> String
resp.key_phrases_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.key_phrases_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.key_phrases_detection_job_properties.vpc_config.subnets #=> Array
resp.key_phrases_detection_job_properties.vpc_config.subnets[0] #=> String

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The ‘StartKeyPhrasesDetectionJob` operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2295

def describe_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:describe_key_phrases_detection_job, params)
  req.send_request(options)
end

#describe_pii_entities_detection_job(params = {}) ⇒ `Types::DescribePiiEntitiesDetectionJobResponse`

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

Examples:

Request syntax with placeholder values


resp = client.describe_pii_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.pii_entities_detection_job_properties.job_id #=> String
resp.pii_entities_detection_job_properties.job_arn #=> String
resp.pii_entities_detection_job_properties.job_name #=> String
resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.pii_entities_detection_job_properties.message #=> String
resp.pii_entities_detection_job_properties.submit_time #=> Time
resp.pii_entities_detection_job_properties.end_time #=> Time
resp.pii_entities_detection_job_properties.input_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.pii_entities_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.pii_entities_detection_job_properties.data_access_role_arn #=> String
resp.pii_entities_detection_job_properties.mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2346

def describe_pii_entities_detection_job(params = {}, options = {})
  req = build_request(:describe_pii_entities_detection_job, params)
  req.send_request(options)
end

#describe_resource_policy(params = {}) ⇒ `Types::DescribeResourcePolicyResponse`

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_policy({
  resource_arn: "ComprehendModelArn", # required
})

Response structure


resp.resource_policy #=> String
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.policy_revision_id #=> String

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the custom model version that has the resource policy.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2382

def describe_resource_policy(params = {}, options = {})
  req = build_request(:describe_resource_policy, params)
  req.send_request(options)
end

#describe_sentiment_detection_job(params = {}) ⇒ `Types::DescribeSentimentDetectionJobResponse`

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.sentiment_detection_job_properties.job_id #=> String
resp.sentiment_detection_job_properties.job_arn #=> String
resp.sentiment_detection_job_properties.job_name #=> String
resp.sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.sentiment_detection_job_properties.message #=> String
resp.sentiment_detection_job_properties.submit_time #=> Time
resp.sentiment_detection_job_properties.end_time #=> Time
resp.sentiment_detection_job_properties.input_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.sentiment_detection_job_properties.output_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
resp.sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.sentiment_detection_job_properties.data_access_role_arn #=> String
resp.sentiment_detection_job_properties.volume_kms_key_id #=> String
resp.sentiment_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.sentiment_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.sentiment_detection_job_properties.vpc_config.subnets #=> Array
resp.sentiment_detection_job_properties.vpc_config.subnets[0] #=> String

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2433

def describe_sentiment_detection_job(params = {}, options = {})
  req = build_request(:describe_sentiment_detection_job, params)
  req.send_request(options)
end

#describe_targeted_sentiment_detection_job(params = {}) ⇒ `Types::DescribeTargetedSentimentDetectionJobResponse`

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

Examples:

Request syntax with placeholder values


resp = client.describe_targeted_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.targeted_sentiment_detection_job_properties.job_id #=> String
resp.targeted_sentiment_detection_job_properties.job_arn #=> String
resp.targeted_sentiment_detection_job_properties.job_name #=> String
resp.targeted_sentiment_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.targeted_sentiment_detection_job_properties.message #=> String
resp.targeted_sentiment_detection_job_properties.submit_time #=> Time
resp.targeted_sentiment_detection_job_properties.end_time #=> Time
resp.targeted_sentiment_detection_job_properties.input_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.targeted_sentiment_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.targeted_sentiment_detection_job_properties.output_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties.output_data_config.kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.targeted_sentiment_detection_job_properties.data_access_role_arn #=> String
resp.targeted_sentiment_detection_job_properties.volume_kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.targeted_sentiment_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.targeted_sentiment_detection_job_properties.vpc_config.subnets #=> Array
resp.targeted_sentiment_detection_job_properties.vpc_config.subnets[0] #=> String

Options Hash (params):

:job_id (required, String) —

The identifier that Amazon Comprehend generated for the job. The ‘StartTargetedSentimentDetectionJob` operation returns this identifier in its response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2485

def describe_targeted_sentiment_detection_job(params = {}, options = {})
  req = build_request(:describe_targeted_sentiment_detection_job, params)
  req.send_request(options)
end

#describe_topics_detection_job(params = {}) ⇒ `Types::DescribeTopicsDetectionJobResponse`

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_topics_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.topics_detection_job_properties.job_id #=> String
resp.topics_detection_job_properties.job_arn #=> String
resp.topics_detection_job_properties.job_name #=> String
resp.topics_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.topics_detection_job_properties.message #=> String
resp.topics_detection_job_properties.submit_time #=> Time
resp.topics_detection_job_properties.end_time #=> Time
resp.topics_detection_job_properties.input_data_config.s3_uri #=> String
resp.topics_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.topics_detection_job_properties.input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.topics_detection_job_properties.input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.topics_detection_job_properties.input_data_config.document_reader_config.feature_types #=> Array
resp.topics_detection_job_properties.input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.topics_detection_job_properties.output_data_config.s3_uri #=> String
resp.topics_detection_job_properties.output_data_config.kms_key_id #=> String
resp.topics_detection_job_properties.number_of_topics #=> Integer
resp.topics_detection_job_properties.data_access_role_arn #=> String
resp.topics_detection_job_properties.volume_kms_key_id #=> String
resp.topics_detection_job_properties.vpc_config.security_group_ids #=> Array
resp.topics_detection_job_properties.vpc_config.security_group_ids[0] #=> String
resp.topics_detection_job_properties.vpc_config.subnets #=> Array
resp.topics_detection_job_properties.vpc_config.subnets[0] #=> String

Options Hash (params):

:job_id (required, String) —

The identifier assigned by the user to the detection job.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2535

def describe_topics_detection_job(params = {}, options = {})
  req = build_request(:describe_topics_detection_job, params)
  req.send_request(options)
end

#detect_dominant_language(params = {}) ⇒ `Types::DetectDominantLanguageResponse`

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see [Amazon Comprehend Supported Languages].

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-languages.html

Examples:

Request syntax with placeholder values


resp = client.detect_dominant_language({
  text: "CustomerInputString", # required
})

Response structure


resp.languages #=> Array
resp.languages[0].language_code #=> String
resp.languages[0].score #=> Float

Options Hash (params):

:text (required, String) —

A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2572

def detect_dominant_language(params = {}, options = {})
  req = build_request(:detect_dominant_language, params)
  req.send_request(options)
end

#detect_entities(params = {}) ⇒ `Types::DetectEntitiesResponse`

Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see

Entities][1: in the Comprehend Developer Guide.

When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in ‘Errors` for each error.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-entities.html [2]: docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html

Examples:

Request syntax with placeholder values


resp = client.detect_entities({
  text: "CustomerInputString",
  language_code: "en", # accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  endpoint_arn: "EntityRecognizerEndpointArn",
  bytes: "data",
  document_reader_config: {
    document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
    document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
    feature_types: ["TABLES"], # accepts TABLES, FORMS
  },
})

Response structure


resp.entities #=> Array
resp.entities[0].score #=> Float
resp.entities[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "COMMERCIAL_ITEM", "EVENT", "DATE", "QUANTITY", "TITLE", "OTHER"
resp.entities[0].text #=> String
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].block_references #=> Array
resp.entities[0].block_references[0].block_id #=> String
resp.entities[0].block_references[0].begin_offset #=> Integer
resp.entities[0].block_references[0].end_offset #=> Integer
resp.entities[0].block_references[0].child_blocks #=> Array
resp.entities[0].block_references[0].child_blocks[0].child_block_id #=> String
resp.entities[0].block_references[0].child_blocks[0].begin_offset #=> Integer
resp.entities[0].block_references[0].child_blocks[0].end_offset #=> Integer
resp.document_metadata.pages #=> Integer
resp.document_metadata.extracted_characters #=> Array
resp.document_metadata.extracted_characters[0].page #=> Integer
resp.document_metadata.extracted_characters[0].count #=> Integer
resp.document_type #=> Array
resp.document_type[0].page #=> Integer
resp.document_type[0].type #=> String, one of "NATIVE_PDF", "SCANNED_PDF", "MS_WORD", "IMAGE", "PLAIN_TEXT", "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON", "TEXTRACT_ANALYZE_DOCUMENT_JSON"
resp.blocks #=> Array
resp.blocks[0].id #=> String
resp.blocks[0].block_type #=> String, one of "LINE", "WORD"
resp.blocks[0].text #=> String
resp.blocks[0].page #=> Integer
resp.blocks[0].geometry.bounding_box.height #=> Float
resp.blocks[0].geometry.bounding_box.left #=> Float
resp.blocks[0].geometry.bounding_box.top #=> Float
resp.blocks[0].geometry.bounding_box.width #=> Float
resp.blocks[0].geometry.polygon #=> Array
resp.blocks[0].geometry.polygon[0].x #=> Float
resp.blocks[0].geometry.polygon[0].y #=> Float
resp.blocks[0].relationships #=> Array
resp.blocks[0].relationships[0].ids #=> Array
resp.blocks[0].relationships[0].ids[0] #=> String
resp.blocks[0].relationships[0].type #=> String, one of "CHILD"
resp.errors #=> Array
resp.errors[0].page #=> Integer
resp.errors[0].error_code #=> String, one of "TEXTRACT_BAD_PAGE", "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED", "PAGE_CHARACTERS_EXCEEDED", "PAGE_SIZE_EXCEEDED", "INTERNAL_SERVER_ERROR"
resp.errors[0].error_message #=> String

Options Hash (params):

:text (String) —

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the ‘Bytes` parameter.
:language_code (String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

All input documents must be in the same language.
:endpoint_arn (String) —

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
:bytes (String, StringIO, File) —

This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the ‘Text` field.

Use the ‘Bytes` parameter to input a text, PDF, Word or image file. Using a plain-text file in the `Bytes` parameter is equivelent to using the `Text` parameter (the `Entities` field in the response is identical).

You can also use the ‘Bytes` parameter to input an Amazon Textract `DetectDocumentText` or `AnalyzeDocument` output file.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see [ Inputs for real-time custom analysis] in the Comprehend Developer Guide.

If you use the ‘Bytes` parameter, do not use the `Text` parameter.

[1]: docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html
:document_reader_config (Types::DocumentReaderConfig) —

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2733

def detect_entities(params = {}, options = {})
  req = build_request(:detect_entities, params)
  req.send_request(options)
end

#detect_key_phrases(params = {}) ⇒ `Types::DetectKeyPhrasesResponse`

Detects the key noun phrases found in the text.

Examples:

Request syntax with placeholder values


resp = client.detect_key_phrases({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.key_phrases #=> Array
resp.key_phrases[0].score #=> Float
resp.key_phrases[0].text #=> String
resp.key_phrases[0].begin_offset #=> Integer
resp.key_phrases[0].end_offset #=> Integer

Options Hash (params):

:text (required, String) —

A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2772

def detect_key_phrases(params = {}, options = {})
  req = build_request(:detect_key_phrases, params)
  req.send_request(options)
end

#detect_pii_entities(params = {}) ⇒ `Types::DetectPiiEntitiesResponse`

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Examples:

Request syntax with placeholder values


resp = client.detect_pii_entities({
  text: "String", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.entities #=> Array
resp.entities[0].score #=> Float
resp.entities[0].type #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer

Options Hash (params):

:text (required, String) —

A UTF-8 text string. The maximum string size is 100 KB.
:language_code (required, String) —

The language of the input documents. Currently, English is the only valid language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2810

def detect_pii_entities(params = {}, options = {})
  req = build_request(:detect_pii_entities, params)
  req.send_request(options)
end

#detect_sentiment(params = {}) ⇒ `Types::DetectSentimentResponse`

Inspects text and returns an inference of the prevailing sentiment (‘POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).

Examples:

Request syntax with placeholder values


resp = client.detect_sentiment({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.sentiment_score.positive #=> Float
resp.sentiment_score.negative #=> Float
resp.sentiment_score.neutral #=> Float
resp.sentiment_score.mixed #=> Float

Options Hash (params):

:text (required, String) —

A UTF-8 text string. The maximum string size is 5 KB.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2850

def detect_sentiment(params = {}, options = {})
  req = build_request(:detect_sentiment, params)
  req.send_request(options)
end

#detect_syntax(params = {}) ⇒ `Types::DetectSyntaxResponse`

Inspects text for syntax and the part of speech of words in the document. For more information, see [Syntax] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html

Examples:

Request syntax with placeholder values


resp = client.detect_syntax({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

Response structure


resp.syntax_tokens #=> Array
resp.syntax_tokens[0].token_id #=> Integer
resp.syntax_tokens[0].text #=> String
resp.syntax_tokens[0].begin_offset #=> Integer
resp.syntax_tokens[0].end_offset #=> Integer
resp.syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "CCONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
resp.syntax_tokens[0].part_of_speech.score #=> Float

Options Hash (params):

:text (required, String) —

A UTF-8 string. The maximum string size is 5 KB.
:language_code (required, String) —

The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German (“de”), English (“en”), Spanish (“es”), French (“fr”), Italian (“it”), or Portuguese (“pt”).

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2897

def detect_syntax(params = {}, options = {})
  req = build_request(:detect_syntax, params)
  req.send_request(options)
end

#detect_targeted_sentiment(params = {}) ⇒ `Types::DetectTargetedSentimentResponse`

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

For more information about targeted sentiment, see [Targeted sentiment] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html

Examples:

Request syntax with placeholder values


resp = client.detect_targeted_sentiment({
  text: "CustomerInputString", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
})

Response structure


resp.entities #=> Array
resp.entities[0].descriptive_mention_index #=> Array
resp.entities[0].descriptive_mention_index[0] #=> Integer
resp.entities[0].mentions #=> Array
resp.entities[0].mentions[0].score #=> Float
resp.entities[0].mentions[0].group_score #=> Float
resp.entities[0].mentions[0].text #=> String
resp.entities[0].mentions[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "FACILITY", "BRAND", "COMMERCIAL_ITEM", "MOVIE", "MUSIC", "BOOK", "SOFTWARE", "GAME", "PERSONAL_TITLE", "EVENT", "DATE", "QUANTITY", "ATTRIBUTE", "OTHER"
resp.entities[0].mentions[0].mention_sentiment.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.positive #=> Float
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.negative #=> Float
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.neutral #=> Float
resp.entities[0].mentions[0].mention_sentiment.sentiment_score.mixed #=> Float
resp.entities[0].mentions[0].begin_offset #=> Integer
resp.entities[0].mentions[0].end_offset #=> Integer

Options Hash (params):

:text (required, String) —

A UTF-8 text string. The maximum string length is 5 KB.
:language_code (required, String) —

The language of the input documents. Currently, English is the only supported language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 2952

def detect_targeted_sentiment(params = {}, options = {})
  req = build_request(:detect_targeted_sentiment, params)
  req.send_request(options)
end

#detect_toxic_content(params = {}) ⇒ `Types::DetectToxicContentResponse`

Performs toxicity analysis on the list of text strings that you 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] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html

Examples:

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
})

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

Options Hash (params):

:text_segments (required, Array<Types::TextSegment>) —

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.
:language_code (required, String) —

The language of the input text. Currently, English is the only supported language.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3002

def detect_toxic_content(params = {}, options = {})
  req = build_request(:detect_toxic_content, params)
  req.send_request(options)
end

#import_model(params = {}) ⇒ `Types::ImportModelResponse`

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.

If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

The source model must be in the same Amazon Web Services Region that you’re using when you import. You can’t import a model that’s in a different Region.

Examples:

Request syntax with placeholder values


resp = client.import_model({
  source_model_arn: "ComprehendModelArn", # required
  model_name: "ComprehendArnName",
  version_name: "VersionName",
  model_kms_key_id: "KmsKeyId",
  data_access_role_arn: "IamRoleArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.model_arn #=> String

Options Hash (params):

:source_model_arn (required, String) —

The Amazon Resource Name (ARN) of the custom model to import.
:model_name (String) —

The name to assign to the custom model that is created in Amazon Comprehend by this import.
:version_name (String) —

The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.
:model_kms_key_id (String) —
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:data_access_role_arn (String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
:tags (Array<Types::Tag>) —

Tags to associate with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3082

def import_model(params = {}, options = {})
  req = build_request(:import_model, params)
  req.send_request(options)
end

#list_datasets(params = {}) ⇒ `Types::ListDatasetsResponse`

List the datasets that you have configured in this Region. For more information about datasets, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_datasets({
  flywheel_arn: "ComprehendFlywheelArn",
  filter: {
    status: "CREATING", # accepts CREATING, COMPLETED, FAILED
    dataset_type: "TRAIN", # accepts TRAIN, TEST
    creation_time_after: Time.now,
    creation_time_before: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dataset_properties_list #=> Array
resp.dataset_properties_list[0].dataset_arn #=> String
resp.dataset_properties_list[0].dataset_name #=> String
resp.dataset_properties_list[0].dataset_type #=> String, one of "TRAIN", "TEST"
resp.dataset_properties_list[0].dataset_s3_uri #=> String
resp.dataset_properties_list[0].description #=> String
resp.dataset_properties_list[0].status #=> String, one of "CREATING", "COMPLETED", "FAILED"
resp.dataset_properties_list[0].message #=> String
resp.dataset_properties_list[0].number_of_documents #=> Integer
resp.dataset_properties_list[0].creation_time #=> Time
resp.dataset_properties_list[0].end_time #=> Time
resp.next_token #=> String

Options Hash (params):

:flywheel_arn (String) —

The Amazon Resource Number (ARN) of the flywheel.
:filter (Types::DatasetFilter) —

Filters the datasets to be returned in the response.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

Maximum number of results to return in a response. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3147

def list_datasets(params = {}, options = {})
  req = build_request(:list_datasets, params)
  req.send_request(options)
end

#list_document_classification_jobs(params = {}) ⇒ `Types::ListDocumentClassificationJobsResponse`

Gets a list of the documentation classification jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_document_classification_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.document_classification_job_properties_list #=> Array
resp.document_classification_job_properties_list[0].job_id #=> String
resp.document_classification_job_properties_list[0].job_arn #=> String
resp.document_classification_job_properties_list[0].job_name #=> String
resp.document_classification_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.document_classification_job_properties_list[0].message #=> String
resp.document_classification_job_properties_list[0].submit_time #=> Time
resp.document_classification_job_properties_list[0].end_time #=> Time
resp.document_classification_job_properties_list[0].document_classifier_arn #=> String
resp.document_classification_job_properties_list[0].input_data_config.s3_uri #=> String
resp.document_classification_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.document_classification_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.document_classification_job_properties_list[0].output_data_config.s3_uri #=> String
resp.document_classification_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.document_classification_job_properties_list[0].data_access_role_arn #=> String
resp.document_classification_job_properties_list[0].volume_kms_key_id #=> String
resp.document_classification_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.document_classification_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.document_classification_job_properties_list[0].vpc_config.subnets #=> Array
resp.document_classification_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.document_classification_job_properties_list[0].flywheel_arn #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::DocumentClassificationJobFilter) —

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3219

def list_document_classification_jobs(params = {}, options = {})
  req = build_request(:list_document_classification_jobs, params)
  req.send_request(options)
end

#list_document_classifier_summaries(params = {}) ⇒ `Types::ListDocumentClassifierSummariesResponse`

Gets a list of summaries of the document classifiers that you have created

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_document_classifier_summaries({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.document_classifier_summaries_list #=> Array
resp.document_classifier_summaries_list[0].document_classifier_name #=> String
resp.document_classifier_summaries_list[0].number_of_versions #=> Integer
resp.document_classifier_summaries_list[0].latest_version_created_at #=> Time
resp.document_classifier_summaries_list[0].latest_version_name #=> String
resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
resp.next_token #=> String

Options Hash (params):

:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return on each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3262

def list_document_classifier_summaries(params = {}, options = {})
  req = build_request(:list_document_classifier_summaries, params)
  req.send_request(options)
end

#list_document_classifiers(params = {}) ⇒ `Types::ListDocumentClassifiersResponse`

Gets a list of the document classifiers that you have created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_document_classifiers({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
    document_classifier_name: "ComprehendArnName",
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.document_classifier_properties_list #=> Array
resp.document_classifier_properties_list[0].document_classifier_arn #=> String
resp.document_classifier_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
resp.document_classifier_properties_list[0].message #=> String
resp.document_classifier_properties_list[0].submit_time #=> Time
resp.document_classifier_properties_list[0].end_time #=> Time
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.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.test_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.document_classifier_properties_list[0].input_data_config.document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.document_classifier_properties_list[0].input_data_config.documents.s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.documents.test_s3_uri #=> String
resp.document_classifier_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.document_classifier_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.document_classifier_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.document_classifier_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
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].output_data_config.flywheel_stats_s3_prefix #=> String
resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
resp.document_classifier_properties_list[0].classifier_metadata.number_of_trained_documents #=> Integer
resp.document_classifier_properties_list[0].classifier_metadata.number_of_test_documents #=> Integer
resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.accuracy #=> Float
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.document_classifier_properties_list[0].model_kms_key_id #=> String
resp.document_classifier_properties_list[0].version_name #=> String
resp.document_classifier_properties_list[0].source_model_arn #=> String
resp.document_classifier_properties_list[0].flywheel_arn #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::DocumentClassifierFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3362

def list_document_classifiers(params = {}, options = {})
  req = build_request(:list_document_classifiers, params)
  req.send_request(options)
end

#list_dominant_language_detection_jobs(params = {}) ⇒ `Types::ListDominantLanguageDetectionJobsResponse`

Gets a list of the dominant language detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dominant_language_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.dominant_language_detection_job_properties_list #=> Array
resp.dominant_language_detection_job_properties_list[0].job_id #=> String
resp.dominant_language_detection_job_properties_list[0].job_arn #=> String
resp.dominant_language_detection_job_properties_list[0].job_name #=> String
resp.dominant_language_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.dominant_language_detection_job_properties_list[0].message #=> String
resp.dominant_language_detection_job_properties_list[0].submit_time #=> Time
resp.dominant_language_detection_job_properties_list[0].end_time #=> Time
resp.dominant_language_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.dominant_language_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.dominant_language_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.dominant_language_detection_job_properties_list[0].data_access_role_arn #=> String
resp.dominant_language_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.dominant_language_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.dominant_language_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.dominant_language_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.dominant_language_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::DominantLanguageDetectionJobFilter) —

Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3432

def list_dominant_language_detection_jobs(params = {}, options = {})
  req = build_request(:list_dominant_language_detection_jobs, params)
  req.send_request(options)
end

#list_endpoints(params = {}) ⇒ `Types::ListEndpointsResponse`

Gets a list of all existing endpoints that you’ve created. For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_endpoints({
  filter: {
    model_arn: "ComprehendModelArn",
    status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
    creation_time_before: Time.now,
    creation_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.endpoint_properties_list #=> Array
resp.endpoint_properties_list[0].endpoint_arn #=> String
resp.endpoint_properties_list[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
resp.endpoint_properties_list[0].message #=> String
resp.endpoint_properties_list[0].model_arn #=> String
resp.endpoint_properties_list[0].desired_model_arn #=> String
resp.endpoint_properties_list[0].desired_inference_units #=> Integer
resp.endpoint_properties_list[0].current_inference_units #=> Integer
resp.endpoint_properties_list[0].creation_time #=> Time
resp.endpoint_properties_list[0].last_modified_time #=> Time
resp.endpoint_properties_list[0].data_access_role_arn #=> String
resp.endpoint_properties_list[0].desired_data_access_role_arn #=> String
resp.endpoint_properties_list[0].flywheel_arn #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::EndpointFilter) —

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3497

def list_endpoints(params = {}, options = {})
  req = build_request(:list_endpoints, params)
  req.send_request(options)
end

#list_entities_detection_jobs(params = {}) ⇒ `Types::ListEntitiesDetectionJobsResponse`

Gets a list of the entity detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entities_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.entities_detection_job_properties_list #=> Array
resp.entities_detection_job_properties_list[0].job_id #=> String
resp.entities_detection_job_properties_list[0].job_arn #=> String
resp.entities_detection_job_properties_list[0].job_name #=> String
resp.entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.entities_detection_job_properties_list[0].message #=> String
resp.entities_detection_job_properties_list[0].submit_time #=> Time
resp.entities_detection_job_properties_list[0].end_time #=> Time
resp.entities_detection_job_properties_list[0].entity_recognizer_arn #=> String
resp.entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entities_detection_job_properties_list[0].data_access_role_arn #=> String
resp.entities_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.entities_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.entities_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.entities_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.entities_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.entities_detection_job_properties_list[0].flywheel_arn #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::EntitiesDetectionJobFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3569

def list_entities_detection_jobs(params = {}, options = {})
  req = build_request(:list_entities_detection_jobs, params)
  req.send_request(options)
end

#list_entity_recognizer_summaries(params = {}) ⇒ `Types::ListEntityRecognizerSummariesResponse`

Gets a list of summaries for the entity recognizers that you have created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entity_recognizer_summaries({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.entity_recognizer_summaries_list #=> Array
resp.entity_recognizer_summaries_list[0].recognizer_name #=> String
resp.entity_recognizer_summaries_list[0].number_of_versions #=> Integer
resp.entity_recognizer_summaries_list[0].latest_version_created_at #=> Time
resp.entity_recognizer_summaries_list[0].latest_version_name #=> String
resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
resp.next_token #=> String

Options Hash (params):

:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return on each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3612

def list_entity_recognizer_summaries(params = {}, options = {})
  req = build_request(:list_entity_recognizer_summaries, params)
  req.send_request(options)
end

#list_entity_recognizers(params = {}) ⇒ `Types::ListEntityRecognizersResponse`

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entity_recognizers({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
    recognizer_name: "ComprehendArnName",
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.entity_recognizer_properties_list #=> Array
resp.entity_recognizer_properties_list[0].entity_recognizer_arn #=> String
resp.entity_recognizer_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
resp.entity_recognizer_properties_list[0].message #=> String
resp.entity_recognizer_properties_list[0].submit_time #=> Time
resp.entity_recognizer_properties_list[0].end_time #=> Time
resp.entity_recognizer_properties_list[0].training_start_time #=> Time
resp.entity_recognizer_properties_list[0].training_end_time #=> Time
resp.entity_recognizer_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.documents.test_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.annotations.test_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].source_documents_s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types #=> Array
resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types[0].type #=> String
resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types[0].evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types[0].evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types[0].evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties_list[0].recognizer_metadata.entity_types[0].number_of_train_mentions #=> Integer
resp.entity_recognizer_properties_list[0].data_access_role_arn #=> String
resp.entity_recognizer_properties_list[0].volume_kms_key_id #=> String
resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids #=> Array
resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
resp.entity_recognizer_properties_list[0].version_name #=> String
resp.entity_recognizer_properties_list[0].source_model_arn #=> String
resp.entity_recognizer_properties_list[0].flywheel_arn #=> String
resp.entity_recognizer_properties_list[0].output_data_config.flywheel_stats_s3_prefix #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::EntityRecognizerFilter) —

Filters the list of entities returned. You can filter on ‘Status`, `SubmitTimeBefore`, or `SubmitTimeAfter`. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return on each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3714

def list_entity_recognizers(params = {}, options = {})
  req = build_request(:list_entity_recognizers, params)
  req.send_request(options)
end

#list_events_detection_jobs(params = {}) ⇒ `Types::ListEventsDetectionJobsResponse`

Gets a list of the events detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_events_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.events_detection_job_properties_list #=> Array
resp.events_detection_job_properties_list[0].job_id #=> String
resp.events_detection_job_properties_list[0].job_arn #=> String
resp.events_detection_job_properties_list[0].job_name #=> String
resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.events_detection_job_properties_list[0].message #=> String
resp.events_detection_job_properties_list[0].submit_time #=> Time
resp.events_detection_job_properties_list[0].end_time #=> Time
resp.events_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.events_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.events_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.events_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.events_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.events_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.events_detection_job_properties_list[0].data_access_role_arn #=> String
resp.events_detection_job_properties_list[0].target_event_types #=> Array
resp.events_detection_job_properties_list[0].target_event_types[0] #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::EventsDetectionJobFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3780

def list_events_detection_jobs(params = {}, options = {})
  req = build_request(:list_events_detection_jobs, params)
  req.send_request(options)
end

#list_flywheel_iteration_history(params = {}) ⇒ `Types::ListFlywheelIterationHistoryResponse`

Information about the history of a flywheel iteration. For more information about flywheels, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_flywheel_iteration_history({
  flywheel_arn: "ComprehendFlywheelArn", # required
  filter: {
    creation_time_after: Time.now,
    creation_time_before: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.flywheel_iteration_properties_list #=> Array
resp.flywheel_iteration_properties_list[0].flywheel_arn #=> String
resp.flywheel_iteration_properties_list[0].flywheel_iteration_id #=> String
resp.flywheel_iteration_properties_list[0].creation_time #=> Time
resp.flywheel_iteration_properties_list[0].end_time #=> Time
resp.flywheel_iteration_properties_list[0].status #=> String, one of "TRAINING", "EVALUATING", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.flywheel_iteration_properties_list[0].message #=> String
resp.flywheel_iteration_properties_list[0].evaluated_model_arn #=> String
resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_f1_score #=> Float
resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_precision #=> Float
resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_recall #=> Float
resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_accuracy #=> Float
resp.flywheel_iteration_properties_list[0].trained_model_arn #=> String
resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_f1_score #=> Float
resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_precision #=> Float
resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_recall #=> Float
resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_accuracy #=> Float
resp.flywheel_iteration_properties_list[0].evaluation_manifest_s3_prefix #=> String
resp.next_token #=> String

Options Hash (params):

:flywheel_arn (required, String) —

The ARN of the flywheel.
:filter (Types::FlywheelIterationFilter) —

Filter the flywheel iteration history based on creation time.
:next_token (String) —

Next token
:max_results (Integer) —

Maximum number of iteration history results to return

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3850

def list_flywheel_iteration_history(params = {}, options = {})
  req = build_request(:list_flywheel_iteration_history, params)
  req.send_request(options)
end

#list_flywheels(params = {}) ⇒ `Types::ListFlywheelsResponse`

Gets a list of the flywheels that you have created.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_flywheels({
  filter: {
    status: "CREATING", # accepts CREATING, ACTIVE, UPDATING, DELETING, FAILED
    creation_time_after: Time.now,
    creation_time_before: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.flywheel_summary_list #=> Array
resp.flywheel_summary_list[0].flywheel_arn #=> String
resp.flywheel_summary_list[0].active_model_arn #=> String
resp.flywheel_summary_list[0].data_lake_s3_uri #=> String
resp.flywheel_summary_list[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.flywheel_summary_list[0].model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
resp.flywheel_summary_list[0].message #=> String
resp.flywheel_summary_list[0].creation_time #=> Time
resp.flywheel_summary_list[0].last_modified_time #=> Time
resp.flywheel_summary_list[0].latest_flywheel_iteration #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::FlywheelFilter) —

Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

Maximum number of results to return in a response. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3905

def list_flywheels(params = {}, options = {})
  req = build_request(:list_flywheels, params)
  req.send_request(options)
end

#list_key_phrases_detection_jobs(params = {}) ⇒ `Types::ListKeyPhrasesDetectionJobsResponse`

Get a list of key phrase detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_key_phrases_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.key_phrases_detection_job_properties_list #=> Array
resp.key_phrases_detection_job_properties_list[0].job_id #=> String
resp.key_phrases_detection_job_properties_list[0].job_arn #=> String
resp.key_phrases_detection_job_properties_list[0].job_name #=> String
resp.key_phrases_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.key_phrases_detection_job_properties_list[0].message #=> String
resp.key_phrases_detection_job_properties_list[0].submit_time #=> Time
resp.key_phrases_detection_job_properties_list[0].end_time #=> Time
resp.key_phrases_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.key_phrases_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.key_phrases_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.key_phrases_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.key_phrases_detection_job_properties_list[0].data_access_role_arn #=> String
resp.key_phrases_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.key_phrases_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.key_phrases_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.key_phrases_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.key_phrases_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::KeyPhrasesDetectionJobFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 3975

def list_key_phrases_detection_jobs(params = {}, options = {})
  req = build_request(:list_key_phrases_detection_jobs, params)
  req.send_request(options)
end

#list_pii_entities_detection_jobs(params = {}) ⇒ `Types::ListPiiEntitiesDetectionJobsResponse`

Gets a list of the PII entity detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_pii_entities_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.pii_entities_detection_job_properties_list #=> Array
resp.pii_entities_detection_job_properties_list[0].job_id #=> String
resp.pii_entities_detection_job_properties_list[0].job_arn #=> String
resp.pii_entities_detection_job_properties_list[0].job_name #=> String
resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.pii_entities_detection_job_properties_list[0].message #=> String
resp.pii_entities_detection_job_properties_list[0].submit_time #=> Time
resp.pii_entities_detection_job_properties_list[0].end_time #=> Time
resp.pii_entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.pii_entities_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
resp.pii_entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.pii_entities_detection_job_properties_list[0].data_access_role_arn #=> String
resp.pii_entities_detection_job_properties_list[0].mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
resp.next_token #=> String

Options Hash (params):

:filter (Types::PiiEntitiesDetectionJobFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4044

def list_pii_entities_detection_jobs(params = {}, options = {})
  req = build_request(:list_pii_entities_detection_jobs, params)
  req.send_request(options)
end

#list_sentiment_detection_jobs(params = {}) ⇒ `Types::ListSentimentDetectionJobsResponse`

Gets a list of sentiment detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_sentiment_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.sentiment_detection_job_properties_list #=> Array
resp.sentiment_detection_job_properties_list[0].job_id #=> String
resp.sentiment_detection_job_properties_list[0].job_arn #=> String
resp.sentiment_detection_job_properties_list[0].job_name #=> String
resp.sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.sentiment_detection_job_properties_list[0].message #=> String
resp.sentiment_detection_job_properties_list[0].submit_time #=> Time
resp.sentiment_detection_job_properties_list[0].end_time #=> Time
resp.sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
resp.sentiment_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.sentiment_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.sentiment_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.sentiment_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.sentiment_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::SentimentDetectionJobFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4114

def list_sentiment_detection_jobs(params = {}, options = {})
  req = build_request(:list_sentiment_detection_jobs, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

Lists all tags associated with a given Amazon Comprehend resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ComprehendArn", # required
})

Response structure


resp.resource_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4147

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_targeted_sentiment_detection_jobs(params = {}) ⇒ `Types::ListTargetedSentimentDetectionJobsResponse`

Gets a list of targeted sentiment detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_targeted_sentiment_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.targeted_sentiment_detection_job_properties_list #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].job_id #=> String
resp.targeted_sentiment_detection_job_properties_list[0].job_arn #=> String
resp.targeted_sentiment_detection_job_properties_list[0].job_name #=> String
resp.targeted_sentiment_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.targeted_sentiment_detection_job_properties_list[0].message #=> String
resp.targeted_sentiment_detection_job_properties_list[0].submit_time #=> Time
resp.targeted_sentiment_detection_job_properties_list[0].end_time #=> Time
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.targeted_sentiment_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.targeted_sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
resp.targeted_sentiment_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.targeted_sentiment_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::TargetedSentimentDetectionJobFilter) —

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4218

def list_targeted_sentiment_detection_jobs(params = {}, options = {})
  req = build_request(:list_targeted_sentiment_detection_jobs, params)
  req.send_request(options)
end

#list_topics_detection_jobs(params = {}) ⇒ `Types::ListTopicsDetectionJobsResponse`

Gets a list of the topic detection jobs that you have submitted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_topics_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.topics_detection_job_properties_list #=> Array
resp.topics_detection_job_properties_list[0].job_id #=> String
resp.topics_detection_job_properties_list[0].job_arn #=> String
resp.topics_detection_job_properties_list[0].job_name #=> String
resp.topics_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.topics_detection_job_properties_list[0].message #=> String
resp.topics_detection_job_properties_list[0].submit_time #=> Time
resp.topics_detection_job_properties_list[0].end_time #=> Time
resp.topics_detection_job_properties_list[0].input_data_config.s3_uri #=> String
resp.topics_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_action #=> String, one of "TEXTRACT_DETECT_DOCUMENT_TEXT", "TEXTRACT_ANALYZE_DOCUMENT"
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.document_read_mode #=> String, one of "SERVICE_DEFAULT", "FORCE_DOCUMENT_READ_ACTION"
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types #=> Array
resp.topics_detection_job_properties_list[0].input_data_config.document_reader_config.feature_types[0] #=> String, one of "TABLES", "FORMS"
resp.topics_detection_job_properties_list[0].output_data_config.s3_uri #=> String
resp.topics_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
resp.topics_detection_job_properties_list[0].number_of_topics #=> Integer
resp.topics_detection_job_properties_list[0].data_access_role_arn #=> String
resp.topics_detection_job_properties_list[0].volume_kms_key_id #=> String
resp.topics_detection_job_properties_list[0].vpc_config.security_group_ids #=> Array
resp.topics_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
resp.topics_detection_job_properties_list[0].vpc_config.subnets #=> Array
resp.topics_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
resp.next_token #=> String

Options Hash (params):

:filter (Types::TopicsDetectionJobFilter) —

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.
:next_token (String) —

Identifies the next page of results to return.
:max_results (Integer) —

The maximum number of results to return in each page. The default is 100.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4288

def list_topics_detection_jobs(params = {}, options = {})
  req = build_request(:list_topics_detection_jobs, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ `Types::PutResourcePolicyResponse`

Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ComprehendModelArn", # required
  resource_policy: "Policy", # required
  policy_revision_id: "PolicyRevisionId",
})

Response structure


resp.policy_revision_id #=> String

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the custom model to attach the policy to.
:resource_policy (required, String) —

The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

‘“”value“, ”attribute“: [”value“]”`

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

‘’“value”, “attribute”: [“value”]‘`
:policy_revision_id (String) —

The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don’t use this parameter. Amazon Comprehend creates the revision ID for you.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4342

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#start_document_classification_job(params = {}) ⇒ `Types::StartDocumentClassificationJobResponse`

Starts an asynchronous document classification job using a custom classification model. Use the ‘DescribeDocumentClassificationJob` operation to track the progress of the job.

Examples:

Request syntax with placeholder values


resp = client.start_document_classification_job({
  job_name: "JobName",
  document_classifier_arn: "DocumentClassifierArn",
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  flywheel_arn: "ComprehendFlywheelArn",
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.document_classifier_arn #=> String

Options Hash (params):

:job_name (String) —

The identifier of the job.
:document_classifier_arn (String) —

The Amazon Resource Name (ARN) of the document classifier to use to process the job.
:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
:client_request_token (String) —

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the document classification job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.
:flywheel_arn (String) —

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4457

def start_document_classification_job(params = {}, options = {})
  req = build_request(:start_document_classification_job, params)
  req.send_request(options)
end

#start_dominant_language_detection_job(params = {}) ⇒ `Types::StartDominantLanguageDetectionJobResponse`

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_dominant_language_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
:job_name (String) —

An identifier for the job.
:client_request_token (String) —

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the dominant language detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4565

def start_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:start_dominant_language_detection_job, params)
  req.send_request(options)
end

#start_entities_detection_job(params = {}) ⇒ `Types::StartEntitiesDetectionJobResponse`

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional ‘EntityRecognizerArn` must be used in order to provide access to the recognizer being used to detect the custom entity.

Examples:

Request syntax with placeholder values


resp = client.start_entities_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  entity_recognizer_arn: "EntityRecognizerArn",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  flywheel_arn: "ComprehendFlywheelArn",
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.entity_recognizer_arn #=> String

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
:job_name (String) —

The identifier of the job.
:entity_recognizer_arn (String) —

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the ‘StartEntitiesDetectionJob`. This ARN is optional and is only used for a custom entity recognition job.
:language_code (required, String) —

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.
:flywheel_arn (String) —

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4697

def start_entities_detection_job(params = {}, options = {})
  req = build_request(:start_entities_detection_job, params)
  req.send_request(options)
end

#start_events_detection_job(params = {}) ⇒ `Types::StartEventsDetectionJobResponse`

Starts an asynchronous event detection job for a collection of documents.

Examples:

Request syntax with placeholder values


resp = client.start_events_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  target_event_types: ["EventTypeString"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
:job_name (String) —

The identifier of the events detection job.
:language_code (required, String) —

The language code of the input documents.
:client_request_token (String) —

An unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:target_event_types (required, Array<String>) —

The types of events to detect in the input documents.
:tags (Array<Types::Tag>) —

Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4782

def start_events_detection_job(params = {}, options = {})
  req = build_request(:start_events_detection_job, params)
  req.send_request(options)
end

#start_flywheel_iteration(params = {}) ⇒ `Types::StartFlywheelIterationResponse`

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see [ Flywheel overview] in the *Amazon Comprehend Developer Guide*.

[1]: docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html

Examples:

Request syntax with placeholder values


resp = client.start_flywheel_iteration({
  flywheel_arn: "ComprehendFlywheelArn", # required
  client_request_token: "ClientRequestTokenString",
})

Response structure


resp.flywheel_arn #=> String
resp.flywheel_iteration_id #=> String

Options Hash (params):

:flywheel_arn (required, String) —

The ARN of the flywheel.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4823

def start_flywheel_iteration(params = {}, options = {})
  req = build_request(:start_flywheel_iteration, params)
  req.send_request(options)
end

#start_key_phrases_detection_job(params = {}) ⇒ `Types::StartKeyPhrasesDetectionJobResponse`

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_key_phrases_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
:job_name (String) —

The identifier of the job.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the key phrases detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 4936

def start_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:start_key_phrases_detection_job, params)
  req.send_request(options)
end

#start_pii_entities_detection_job(params = {}) ⇒ `Types::StartPiiEntitiesDetectionJobResponse`

Starts an asynchronous PII entity detection job for a collection of documents.

Examples:

Request syntax with placeholder values


resp = client.start_pii_entities_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
  redaction_config: {
    pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER
    mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
    mask_character: "MaskCharacter",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

The input properties for a PII entities detection job.
:output_data_config (required, Types::OutputDataConfig) —

Provides conﬁguration parameters for the output of PII entity detection jobs.
:mode (required, String) —

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
:redaction_config (Types::RedactionConfig) —

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the ‘Mode` parameter to `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig` definition that includes the `PiiEntityTypes` parameter.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
:job_name (String) —

The identifier of the job.
:language_code (required, String) —

The language of the input documents. Currently, English is the only valid language.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:tags (Array<Types::Tag>) —

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5036

def start_pii_entities_detection_job(params = {}, options = {})
  req = build_request(:start_pii_entities_detection_job, params)
  req.send_request(options)
end

#start_sentiment_detection_job(params = {}) ⇒ `Types::StartSentimentDetectionJobResponse`

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_sentiment_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
:job_name (String) —

The identifier of the job.
:language_code (required, String) —

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5149

def start_sentiment_detection_job(params = {}, options = {})
  req = build_request(:start_sentiment_detection_job, params)
  req.send_request(options)
end

#start_targeted_sentiment_detection_job(params = {}) ⇒ `Types::StartTargetedSentimentDetectionJobResponse`

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the ‘DescribeTargetedSentimentDetectionJob` operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_targeted_sentiment_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files.
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
:job_name (String) —

The identifier of the job.
:language_code (required, String) —

The language of the input documents. Currently, English is the only supported language.
:client_request_token (String) —

A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5264

def start_targeted_sentiment_detection_job(params = {}, options = {})
  req = build_request(:start_targeted_sentiment_detection_job, params)
  req.send_request(options)
end

#start_topics_detection_job(params = {}) ⇒ `Types::StartTopicsDetectionJobResponse`

Starts an asynchronous topic detection job. Use the ‘DescribeTopicDetectionJob` operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_topics_detection_job({
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  number_of_topics: 1,
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:input_data_config (required, Types::InputDataConfig) —

Specifies the format and location of the input data for the job.
:output_data_config (required, Types::OutputDataConfig) —

Specifies where to send the output files. The output is a compressed archive with two files, ‘topic-terms.csv` that lists the terms associated with each topic, and `doc-topics.csv` that lists the documents associated with each topic
:data_access_role_arn (required, String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see [Role-based permissions].

[1]: docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
:job_name (String) —

The identifier of the job.
:number_of_topics (Integer) —

The number of topics to detect.
:client_request_token (String) —

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

**A suitable default value is auto-generated.** You should normally not need to pass this option.**
:volume_kms_key_id (String) —
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: ‘“1234abcd-12ab-34cd-56ef-1234567890ab”`
- Amazon Resource Name (ARN) of a KMS Key: ‘“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”`
:vpc_config (Types::VpcConfig) —

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
:tags (Array<Types::Tag>) —

Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5378

def start_topics_detection_job(params = {}, options = {})
  req = build_request(:start_topics_detection_job, params)
  req.send_request(options)
end

#stop_dominant_language_detection_job(params = {}) ⇒ `Types::StopDominantLanguageDetectionJobResponse`

Stops a dominant language detection job in progress.

If the job state is ‘IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state; otherwise the job is stopped and put into the `STOPPED` state.

If the job is in the ‘COMPLETED` or `FAILED` state when you call the `StopDominantLanguageDetectionJob` operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_dominant_language_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the dominant language detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5420

def stop_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:stop_dominant_language_detection_job, params)
  req.send_request(options)
end

#stop_entities_detection_job(params = {}) ⇒ `Types::StopEntitiesDetectionJobResponse`

Stops an entities detection job in progress.

If the job is in the ‘COMPLETED` or `FAILED` state when you call the `StopDominantLanguageDetectionJob` operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the entities detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5462

def stop_entities_detection_job(params = {}, options = {})
  req = build_request(:stop_entities_detection_job, params)
  req.send_request(options)
end

#stop_events_detection_job(params = {}) ⇒ `Types::StopEventsDetectionJobResponse`

Stops an events detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_events_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the events detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5492

def stop_events_detection_job(params = {}, options = {})
  req = build_request(:stop_events_detection_job, params)
  req.send_request(options)
end

#stop_key_phrases_detection_job(params = {}) ⇒ `Types::StopKeyPhrasesDetectionJobResponse`

Stops a key phrases detection job in progress.

If the job is in the ‘COMPLETED` or `FAILED` state when you call the `StopDominantLanguageDetectionJob` operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_key_phrases_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the key phrases detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5534

def stop_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:stop_key_phrases_detection_job, params)
  req.send_request(options)
end

#stop_pii_entities_detection_job(params = {}) ⇒ `Types::StopPiiEntitiesDetectionJobResponse`

Stops a PII entities detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_pii_entities_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the PII entities detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5564

def stop_pii_entities_detection_job(params = {}, options = {})
  req = build_request(:stop_pii_entities_detection_job, params)
  req.send_request(options)
end

#stop_sentiment_detection_job(params = {}) ⇒ `Types::StopSentimentDetectionJobResponse`

Stops a sentiment detection job in progress.

If the job state is ‘IN_PROGRESS`, the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state; otherwise the job is be stopped and put into the `STOPPED` state.

If the job is in the ‘COMPLETED` or `FAILED` state when you call the `StopDominantLanguageDetectionJob` operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the sentiment detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5606

def stop_sentiment_detection_job(params = {}, options = {})
  req = build_request(:stop_sentiment_detection_job, params)
  req.send_request(options)
end

#stop_targeted_sentiment_detection_job(params = {}) ⇒ `Types::StopTargetedSentimentDetectionJobResponse`

Stops a targeted sentiment detection job in progress.

If the job is in the ‘COMPLETED` or `FAILED` state when you call the `StopDominantLanguageDetectionJob` operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Examples:

Request syntax with placeholder values


resp = client.stop_targeted_sentiment_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"

Options Hash (params):

:job_id (required, String) —

The identifier of the targeted sentiment detection job to stop.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5648

def stop_targeted_sentiment_detection_job(params = {}, options = {})
  req = build_request(:stop_targeted_sentiment_detection_job, params)
  req.send_request(options)
end

#stop_training_document_classifier(params = {}) ⇒ `Struct`

Stops a document classifier training job while in progress.

If the training job state is ‘TRAINING`, the job is marked for termination and put into the `STOP_REQUESTED` state. If the training job completes before it can be stopped, it is put into the `TRAINED`; otherwise the training job is stopped and put into the `STOPPED` state and the service sends back an HTTP 200 response with an empty HTTP body.

Examples:

Request syntax with placeholder values


resp = client.stop_training_document_classifier({
  document_classifier_arn: "DocumentClassifierArn", # required
})

Options Hash (params):

:document_classifier_arn (required, String) —

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5678

def stop_training_document_classifier(params = {}, options = {})
  req = build_request(:stop_training_document_classifier, params)
  req.send_request(options)
end

#stop_training_entity_recognizer(params = {}) ⇒ `Struct`

Stops an entity recognizer training job while in progress.

If the training job state is ‘TRAINING`, the job is marked for termination and put into the `STOP_REQUESTED` state. If the training job completes before it can be stopped, it is put into the `TRAINED`; otherwise the training job is stopped and putted into the `STOPPED` state and the service sends back an HTTP 200 response with an empty HTTP body.

Examples:

Request syntax with placeholder values


resp = client.stop_training_entity_recognizer({
  entity_recognizer_arn: "EntityRecognizerArn", # required
})

Options Hash (params):

:entity_recognizer_arn (required, String) —

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5708

def stop_training_entity_recognizer(params = {}, options = {})
  req = build_request(:stop_training_entity_recognizer, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ComprehendArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
:tags (required, Array<Types::Tag>) —

Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5745

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Removes a specific tag associated with an Amazon Comprehend resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ComprehendArn", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
:tag_keys (required, Array<String>) —

The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5776

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_endpoint(params = {}) ⇒ `Types::UpdateEndpointResponse`

Updates information about the specified endpoint. For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html

Examples:

Request syntax with placeholder values


resp = client.update_endpoint({
  endpoint_arn: "ComprehendEndpointArn", # required
  desired_model_arn: "ComprehendModelArn",
  desired_inference_units: 1,
  desired_data_access_role_arn: "IamRoleArn",
  flywheel_arn: "ComprehendFlywheelArn",
})

Response structure


resp.desired_model_arn #=> String

Options Hash (params):

:endpoint_arn (required, String) —

The Amazon Resource Number (ARN) of the endpoint being updated.
:desired_model_arn (String) —

The ARN of the new model to use when updating an existing endpoint.
:desired_inference_units (Integer) —

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
:desired_data_access_role_arn (String) —

Data access role ARN to use in case the new model is encrypted with a customer CMK.
:flywheel_arn (String) —

The Amazon Resource Number (ARN) of the flywheel

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5828

def update_endpoint(params = {}, options = {})
  req = build_request(:update_endpoint, params)
  req.send_request(options)
end

#update_flywheel(params = {}) ⇒ `Types::UpdateFlywheelResponse`

Update the configuration information for an existing flywheel.

Examples:

Request syntax with placeholder values


resp = client.update_flywheel({
  flywheel_arn: "ComprehendFlywheelArn", # required
  active_model_arn: "ComprehendModelArn",
  data_access_role_arn: "IamRoleArn",
  data_security_config: {
    model_kms_key_id: "KmsKeyId",
    volume_kms_key_id: "KmsKeyId",
    vpc_config: {
      security_group_ids: ["SecurityGroupId"], # required
      subnets: ["SubnetId"], # required
    },
  },
})

Response structure


resp.flywheel_properties.flywheel_arn #=> String
resp.flywheel_properties.active_model_arn #=> String
resp.flywheel_properties.data_access_role_arn #=> String
resp.flywheel_properties.task_config.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
resp.flywheel_properties.task_config.document_classification_config.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
resp.flywheel_properties.task_config.document_classification_config.labels #=> Array
resp.flywheel_properties.task_config.document_classification_config.labels[0] #=> String
resp.flywheel_properties.task_config.entity_recognition_config.entity_types #=> Array
resp.flywheel_properties.task_config.entity_recognition_config.entity_types[0].type #=> String
resp.flywheel_properties.data_lake_s3_uri #=> String
resp.flywheel_properties.data_security_config.model_kms_key_id #=> String
resp.flywheel_properties.data_security_config.volume_kms_key_id #=> String
resp.flywheel_properties.data_security_config.data_lake_kms_key_id #=> String
resp.flywheel_properties.data_security_config.vpc_config.security_group_ids #=> Array
resp.flywheel_properties.data_security_config.vpc_config.security_group_ids[0] #=> String
resp.flywheel_properties.data_security_config.vpc_config.subnets #=> Array
resp.flywheel_properties.data_security_config.vpc_config.subnets[0] #=> String
resp.flywheel_properties.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.flywheel_properties.model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
resp.flywheel_properties.message #=> String
resp.flywheel_properties.creation_time #=> Time
resp.flywheel_properties.last_modified_time #=> Time
resp.flywheel_properties.latest_flywheel_iteration #=> String

Options Hash (params):

:flywheel_arn (required, String) —

The Amazon Resource Number (ARN) of the flywheel to update.
:active_model_arn (String) —

The Amazon Resource Number (ARN) of the active model version.
:data_access_role_arn (String) —

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
:data_security_config (Types::UpdateDataSecurityConfig) —

Flywheel data security configuration.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-comprehend/client.rb', line 5898

def update_flywheel(params = {}, options = {})
  req = build_request(:update_flywheel, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



5922
5923
5924

# File 'lib/aws-sdk-comprehend/client.rb', line 5922

def waiter_names
  []
end

Class: Aws::Comprehend::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#batch_detect_dominant_language(params = {}) ⇒ Types::BatchDetectDominantLanguageResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_detect_entities(params = {}) ⇒ Types::BatchDetectEntitiesResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_detect_key_phrases(params = {}) ⇒ Types::BatchDetectKeyPhrasesResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_detect_sentiment(params = {}) ⇒ Types::BatchDetectSentimentResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_detect_syntax(params = {}) ⇒ Types::BatchDetectSyntaxResponse

Examples:

Request syntax with placeholder values

Response structure

#batch_detect_targeted_sentiment(params = {}) ⇒ Types::BatchDetectTargetedSentimentResponse

Examples:

Request syntax with placeholder values

Response structure

#build_request(operation_name, params = {}) ⇒ Object

#classify_document(params = {}) ⇒ Types::ClassifyDocumentResponse

Examples:

Request syntax with placeholder values

Response structure

#contains_pii_entities(params = {}) ⇒ Types::ContainsPiiEntitiesResponse

Examples:

Request syntax with placeholder values

Response structure

#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse

Examples:

Request syntax with placeholder values

Response structure

#create_document_classifier(params = {}) ⇒ Types::CreateDocumentClassifierResponse

Examples:

Request syntax with placeholder values

Response structure

#create_endpoint(params = {}) ⇒ Types::CreateEndpointResponse

Examples:

Request syntax with placeholder values

Response structure

#create_entity_recognizer(params = {}) ⇒ Types::CreateEntityRecognizerResponse

Examples:

Request syntax with placeholder values

Response structure

#create_flywheel(params = {}) ⇒ Types::CreateFlywheelResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_document_classifier(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_endpoint(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_entity_recognizer(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_flywheel(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_resource_policy(params = {}) ⇒ Struct

Examples:

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#batch_detect_dominant_language(params = {}) ⇒ `Types::BatchDetectDominantLanguageResponse`

#batch_detect_entities(params = {}) ⇒ `Types::BatchDetectEntitiesResponse`

#batch_detect_key_phrases(params = {}) ⇒ `Types::BatchDetectKeyPhrasesResponse`

#batch_detect_sentiment(params = {}) ⇒ `Types::BatchDetectSentimentResponse`

#batch_detect_syntax(params = {}) ⇒ `Types::BatchDetectSyntaxResponse`

#batch_detect_targeted_sentiment(params = {}) ⇒ `Types::BatchDetectTargetedSentimentResponse`

#build_request(operation_name, params = {}) ⇒ `Object`

#classify_document(params = {}) ⇒ `Types::ClassifyDocumentResponse`

#contains_pii_entities(params = {}) ⇒ `Types::ContainsPiiEntitiesResponse`

#create_dataset(params = {}) ⇒ `Types::CreateDatasetResponse`

#create_document_classifier(params = {}) ⇒ `Types::CreateDocumentClassifierResponse`

#create_endpoint(params = {}) ⇒ `Types::CreateEndpointResponse`

#create_entity_recognizer(params = {}) ⇒ `Types::CreateEntityRecognizerResponse`

#create_flywheel(params = {}) ⇒ `Types::CreateFlywheelResponse`

#delete_document_classifier(params = {}) ⇒ `Struct`

#delete_endpoint(params = {}) ⇒ `Struct`

#delete_entity_recognizer(params = {}) ⇒ `Struct`

#delete_flywheel(params = {}) ⇒ `Struct`

#delete_resource_policy(params = {}) ⇒ `Struct`

#describe_dataset(params = {}) ⇒ `Types::DescribeDatasetResponse`

#describe_document_classification_job(params = {}) ⇒ `Types::DescribeDocumentClassificationJobResponse`

#describe_document_classifier(params = {}) ⇒ `Types::DescribeDocumentClassifierResponse`

#describe_dominant_language_detection_job(params = {}) ⇒ `Types::DescribeDominantLanguageDetectionJobResponse`

#describe_endpoint(params = {}) ⇒ `Types::DescribeEndpointResponse`

#describe_entities_detection_job(params = {}) ⇒ `Types::DescribeEntitiesDetectionJobResponse`

#describe_entity_recognizer(params = {}) ⇒ `Types::DescribeEntityRecognizerResponse`

#describe_events_detection_job(params = {}) ⇒ `Types::DescribeEventsDetectionJobResponse`

#describe_flywheel(params = {}) ⇒ `Types::DescribeFlywheelResponse`

#describe_flywheel_iteration(params = {}) ⇒ `Types::DescribeFlywheelIterationResponse`

#describe_key_phrases_detection_job(params = {}) ⇒ `Types::DescribeKeyPhrasesDetectionJobResponse`

#describe_pii_entities_detection_job(params = {}) ⇒ `Types::DescribePiiEntitiesDetectionJobResponse`

#describe_resource_policy(params = {}) ⇒ `Types::DescribeResourcePolicyResponse`

#describe_sentiment_detection_job(params = {}) ⇒ `Types::DescribeSentimentDetectionJobResponse`

#describe_targeted_sentiment_detection_job(params = {}) ⇒ `Types::DescribeTargetedSentimentDetectionJobResponse`

#describe_topics_detection_job(params = {}) ⇒ `Types::DescribeTopicsDetectionJobResponse`

#detect_dominant_language(params = {}) ⇒ `Types::DetectDominantLanguageResponse`

#detect_entities(params = {}) ⇒ `Types::DetectEntitiesResponse`