You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Comprehend::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.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.

  • :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_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.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to false.

  • :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.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :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.

    @see https://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 and auth errors from expired credentials.

  • :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.

  • :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 Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.



212
213
214
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 212

def initialize(*args)
  super
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.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_dominant_language({
  text_list: ["String"], # 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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

Returns:

See Also:



259
260
261
262
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 259

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 how-entities

Examples:

Request syntax with placeholder values


resp = client.batch_detect_entities({
  text_list: ["String"], # 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].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.error_list #=> Array
resp.error_list[0].index #=> Integer
resp.error_list[0].error_code #=> String
resp.error_list[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



308
309
310
311
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 308

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: ["String"], # 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].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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



354
355
356
357
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 354

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: ["String"], # 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].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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



402
403
404
405
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 402

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 how-syntax.

Examples:

Request syntax with placeholder values


resp = client.batch_detect_syntax({
  text_list: ["String"], # 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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text_list (required, Array<String>)

    A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



452
453
454
455
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 452

def batch_detect_syntax(params = {}, options = {})
  req = build_request(:batch_detect_syntax, 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 labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

Examples:

Request syntax with placeholder values


resp = client.create_document_classifier({
  document_classifier_name: "ComprehendArnName", # required
  data_access_role_arn: "IamRoleArn", # required
  input_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

Response structure


resp.document_classifier_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_name (required, String)

    The name of the document classifier.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :input_data_config (required, Types::DocumentClassifierInputDataConfig)

    Specifies the format and location of the input data for the job.

  • :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 English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



510
511
512
513
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 510

def create_document_classifier(params = {}, options = {})
  req = build_request(:create_document_classifier, 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 API.

Examples:

Request syntax with placeholder values


resp = client.create_entity_recognizer({
  recognizer_name: "ComprehendArnName", # required
  data_access_role_arn: "IamRoleArn", # required
  input_data_config: { # required
    entity_types: [ # required
      {
        type: "EntityTypeName", # required
      },
    ],
    documents: { # required
      s3_uri: "S3Uri", # required
    },
    annotations: {
      s3_uri: "S3Uri", # required
    },
    entity_list: {
      s3_uri: "S3Uri", # required
    },
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

Response structure


resp.entity_recognizer_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

  • :data_access_role_arn (required, String)

    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

  • :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)

    The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Returns:

See Also:



583
584
585
586
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 583

def create_entity_recognizer(params = {}, options = {})
  req = build_request(:create_entity_recognizer, 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
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



615
616
617
618
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 615

def delete_document_classifier(params = {}, options = {})
  req = build_request(:delete_document_classifier, 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
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entity_recognizer_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



646
647
648
649
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 646

def delete_entity_recognizer(params = {}, options = {})
  req = build_request(:delete_entity_recognizer, 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_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.output_data_config.s3_uri #=> String
resp.document_classification_job_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

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

Returns:

See Also:



686
687
688
689
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 686

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"
resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
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.s3_uri #=> String
resp.document_classifier_properties..number_of_labels #=> Integer
resp.document_classifier_properties..number_of_trained_documents #=> Integer
resp.document_classifier_properties..number_of_test_documents #=> Integer
resp.document_classifier_properties..evaluation_metrics.accuracy #=> Float
resp.document_classifier_properties..evaluation_metrics.precision #=> Float
resp.document_classifier_properties..evaluation_metrics.recall #=> Float
resp.document_classifier_properties..evaluation_metrics.f1_score #=> Float
resp.document_classifier_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_arn (required, String)

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

Returns:

See Also:



731
732
733
734
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 731

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_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.output_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

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

Returns:

See Also:



770
771
772
773
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 770

def describe_dominant_language_detection_job(params = {}, options = {})
  req = build_request(:describe_dominant_language_detection_job, 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_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.output_data_config.s3_uri #=> String
resp.entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
resp.entities_detection_job_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

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

Returns:

See Also:



811
812
813
814
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 811

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"
resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
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.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.annotations.s3_uri #=> String
resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
resp.entity_recognizer_properties..number_of_trained_documents #=> Integer
resp.entity_recognizer_properties..number_of_test_documents #=> Integer
resp.entity_recognizer_properties..evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties..evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties..evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties..entity_types #=> Array
resp.entity_recognizer_properties..entity_types[0].type #=> String
resp.entity_recognizer_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entity_recognizer_arn (required, String)

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

Returns:

See Also:



861
862
863
864
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 861

def describe_entity_recognizer(params = {}, options = {})
  req = build_request(:describe_entity_recognizer, 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_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.output_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
resp.key_phrases_detection_job_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

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

Returns:

See Also:



901
902
903
904
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 901

def describe_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:describe_key_phrases_detection_job, 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_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.output_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
resp.sentiment_detection_job_properties.data_access_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

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

Returns:

See Also:



941
942
943
944
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 941

def describe_sentiment_detection_job(params = {}, options = {})
  req = build_request(:describe_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_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.output_data_config.s3_uri #=> String
resp.topics_detection_job_properties.number_of_topics #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier assigned by the user to the detection job.

Returns:

See Also:



979
980
981
982
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 979

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Returns:

See Also:



1016
1017
1018
1019
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1016

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

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

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

Examples:

Request syntax with placeholder values


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

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



1056
1057
1058
1059
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1056

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: "String", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



1094
1095
1096
1097
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1094

def detect_key_phrases(params = {}, options = {})
  req = build_request(:detect_key_phrases, 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: "String", # required
  language_code: "en", # required, accepts en, es, fr, de, it, pt
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

  • :language_code (required, String)

    The language of the input documents. You can specify English ("en") or Spanish ("es"). All documents must be in the same language.

Returns:

See Also:



1134
1135
1136
1137
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1134

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, how-syntax.

Examples:

Request syntax with placeholder values


resp = client.detect_syntax({
  text: "String", # 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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :text (required, String)

    A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

  • :language_code (required, String)

    The language code of the input documents. You can specify English ("en") or Spanish ("es").

Returns:

See Also:



1175
1176
1177
1178
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1175

def detect_syntax(params = {}, options = {})
  req = build_request(:detect_syntax, 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.

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_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].output_data_config.s3_uri #=> String
resp.document_classification_job_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1233
1234
1235
1236
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1233

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_document_classifiers({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    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"
resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
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.s3_uri #=> String
resp.document_classifier_properties_list[0]..number_of_labels #=> Integer
resp.document_classifier_properties_list[0]..number_of_trained_documents #=> Integer
resp.document_classifier_properties_list[0]..number_of_test_documents #=> Integer
resp.document_classifier_properties_list[0]..evaluation_metrics.accuracy #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.precision #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.recall #=> Float
resp.document_classifier_properties_list[0]..evaluation_metrics.f1_score #=> Float
resp.document_classifier_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1295
1296
1297
1298
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1295

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.

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_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].output_data_config.s3_uri #=> String
resp.dominant_language_detection_job_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1352
1353
1354
1355
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1352

def list_dominant_language_detection_jobs(params = {}, options = {})
  req = build_request(:list_dominant_language_detection_jobs, 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.

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_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].output_data_config.s3_uri #=> String
resp.entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
resp.entities_detection_job_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1410
1411
1412
1413
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1410

def list_entities_detection_jobs(params = {}, options = {})
  req = build_request(:list_entities_detection_jobs, 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.

Examples:

Request syntax with placeholder values


resp = client.list_entity_recognizers({
  filter: {
    status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    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"
resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
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.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.annotations.s3_uri #=> String
resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
resp.entity_recognizer_properties_list[0]..number_of_trained_documents #=> Integer
resp.entity_recognizer_properties_list[0]..number_of_test_documents #=> Integer
resp.entity_recognizer_properties_list[0]..evaluation_metrics.precision #=> Float
resp.entity_recognizer_properties_list[0]..evaluation_metrics.recall #=> Float
resp.entity_recognizer_properties_list[0]..evaluation_metrics.f1_score #=> Float
resp.entity_recognizer_properties_list[0]..entity_types #=> Array
resp.entity_recognizer_properties_list[0]..entity_types[0].type #=> String
resp.entity_recognizer_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1483
1484
1485
1486
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1483

def list_entity_recognizers(params = {}, options = {})
  req = build_request(:list_entity_recognizers, 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.

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_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].output_data_config.s3_uri #=> String
resp.key_phrases_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
resp.key_phrases_detection_job_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1540
1541
1542
1543
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1540

def list_key_phrases_detection_jobs(params = {}, options = {})
  req = build_request(:list_key_phrases_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.

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_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].output_data_config.s3_uri #=> String
resp.sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
resp.sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1597
1598
1599
1600
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1597

def list_sentiment_detection_jobs(params = {}, options = {})
  req = build_request(:list_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.

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_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].output_data_config.s3_uri #=> String
resp.topics_detection_job_properties_list[0].number_of_topics #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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.

Returns:

See Also:



1653
1654
1655
1656
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1653

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

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

Starts an asynchronous document classification job. Use the 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", # required
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  client_request_token: "ClientRequestTokenString",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_name (String)

    The identifier of the job.

  • :document_classifier_arn (required, 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 AWS Identity and Access Management (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.**

Returns:

See Also:



1716
1717
1718
1719
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1716

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
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.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.**

Returns:

See Also:



1780
1781
1782
1783
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1780

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
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  entity_recognizer_arn: "EntityRecognizerArn",
  language_code: "en", # required, accepts en, es, fr, de, it, pt
  client_request_token: "ClientRequestTokenString",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.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: English ("en"), Spanish ("es"), French ("fr"), German ("de"), Italian ("it"), or Portuguese ("pt"). 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.**

Returns:

See Also:



1863
1864
1865
1866
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1863

def start_entities_detection_job(params = {}, options = {})
  req = build_request(:start_entities_detection_job, 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
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt
  client_request_token: "ClientRequestTokenString",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.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 English ("en") or Spanish ("es"). 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.**

Returns:

See Also:



1931
1932
1933
1934
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1931

def start_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:start_key_phrases_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
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  language_code: "en", # required, accepts en, es, fr, de, it, pt
  client_request_token: "ClientRequestTokenString",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.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 English ("en") or Spanish ("es"). 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.**

Returns:

See Also:



1999
2000
2001
2002
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1999

def start_sentiment_detection_job(params = {}, options = {})
  req = build_request(:start_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
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  number_of_topics: 1,
  client_request_token: "ClientRequestTokenString",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.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.**

Returns:

See Also:



2069
2070
2071
2072
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2069

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"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the dominant language detection job to stop.

Returns:

See Also:



2111
2112
2113
2114
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2111

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 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_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"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the entities detection job to stop.

Returns:

See Also:



2153
2154
2155
2156
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2153

def stop_entities_detection_job(params = {}, options = {})
  req = build_request(:stop_entities_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 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_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"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the key phrases detection job to stop.

Returns:

See Also:



2195
2196
2197
2198
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2195

def stop_key_phrases_detection_job(params = {}, options = {})
  req = build_request(:stop_key_phrases_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"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :job_id (required, String)

    The identifier of the sentiment detection job to stop.

Returns:

See Also:



2237
2238
2239
2240
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2237

def stop_sentiment_detection_job(params = {}, options = {})
  req = build_request(:stop_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
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :document_classifier_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2267
2268
2269
2270
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2267

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :entity_recognizer_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2297
2298
2299
2300
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2297

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