Class: Aws::Comprehend::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Comprehend::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-comprehend/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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
, orNEGATIVE
, 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][1].
-
#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
, orNEGATIVE
). -
#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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
395 396 397 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 395 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.
442 443 444 445 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 442 def batch_detect_dominant_language(params = {}, = {}) req = build_request(:batch_detect_dominant_language, params) req.send_request() 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.
504 505 506 507 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 504 def batch_detect_entities(params = {}, = {}) req = build_request(:batch_detect_entities, params) req.send_request() end |
#batch_detect_key_phrases(params = {}) ⇒ Types::BatchDetectKeyPhrasesResponse
Detects the key noun phrases found in a batch of documents.
551 552 553 554 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 551 def batch_detect_key_phrases(params = {}, = {}) req = build_request(:batch_detect_key_phrases, params) req.send_request() 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.
600 601 602 603 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 600 def batch_detect_sentiment(params = {}, = {}) req = build_request(:batch_detect_sentiment, params) req.send_request() 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.
657 658 659 660 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 657 def batch_detect_syntax(params = {}, = {}) req = build_request(:batch_detect_syntax, params) req.send_request() 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.
721 722 723 724 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 721 def batch_detect_targeted_sentiment(params = {}, = {}) req = build_request(:batch_detect_targeted_sentiment, params) req.send_request() 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.
858 859 860 861 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 858 def classify_document(params = {}, = {}) req = build_request(:classify_document, params) req.send_request() 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.
894 895 896 897 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 894 def contains_pii_entities(params = {}, = {}) req = build_request(:contains_pii_entities, params) req.send_request() 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.
992 993 994 995 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 992 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() 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.
1171 1172 1173 1174 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1171 def create_document_classifier(params = {}, = {}) req = build_request(:create_document_classifier, params) req.send_request() 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.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1251 def create_endpoint(params = {}, = {}) req = build_request(:create_endpoint, params) req.send_request() 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.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1414 def create_entity_recognizer(params = {}, = {}) req = build_request(:create_entity_recognizer, params) req.send_request() 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.
1536 1537 1538 1539 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1536 def create_flywheel(params = {}, = {}) req = build_request(:create_flywheel, params) req.send_request() 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.
1568 1569 1570 1571 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1568 def delete_document_classifier(params = {}, = {}) req = build_request(:delete_document_classifier, params) req.send_request() 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.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1596 def delete_endpoint(params = {}, = {}) req = build_request(:delete_endpoint, params) req.send_request() 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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1627 def delete_entity_recognizer(params = {}, = {}) req = build_request(:delete_entity_recognizer, params) req.send_request() 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.
1658 1659 1660 1661 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1658 def delete_flywheel(params = {}, = {}) req = build_request(:delete_flywheel, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource-based policy that is attached to a custom model.
1685 1686 1687 1688 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1685 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() 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.
1728 1729 1730 1731 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1728 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() 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.
1781 1782 1783 1784 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1781 def describe_document_classification_job(params = {}, = {}) req = build_request(:describe_document_classification_job, params) req.send_request() end |
#describe_document_classifier(params = {}) ⇒ Types::DescribeDocumentClassifierResponse
Gets the properties associated with a document classifier.
1862 1863 1864 1865 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1862 def describe_document_classifier(params = {}, = {}) req = build_request(:describe_document_classifier, params) req.send_request() 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.
1913 1914 1915 1916 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1913 def describe_dominant_language_detection_job(params = {}, = {}) req = build_request(:describe_dominant_language_detection_job, params) req.send_request() 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.
1958 1959 1960 1961 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1958 def describe_endpoint(params = {}, = {}) req = build_request(:describe_endpoint, params) req.send_request() 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.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2012 def describe_entities_detection_job(params = {}, = {}) req = build_request(:describe_entities_detection_job, params) req.send_request() 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.
2088 2089 2090 2091 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2088 def describe_entity_recognizer(params = {}, = {}) req = build_request(:describe_entity_recognizer, params) req.send_request() end |
#describe_events_detection_job(params = {}) ⇒ Types::DescribeEventsDetectionJobResponse
Gets the status and details of an events detection job.
2134 2135 2136 2137 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2134 def describe_events_detection_job(params = {}, = {}) req = build_request(:describe_events_detection_job, params) req.send_request() 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.
2190 2191 2192 2193 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2190 def describe_flywheel(params = {}, = {}) req = build_request(:describe_flywheel, params) req.send_request() 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.
2242 2243 2244 2245 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2242 def describe_flywheel_iteration(params = {}, = {}) req = build_request(:describe_flywheel_iteration, params) req.send_request() 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.
2294 2295 2296 2297 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2294 def describe_key_phrases_detection_job(params = {}, = {}) req = build_request(:describe_key_phrases_detection_job, params) req.send_request() 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.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2345 def describe_pii_entities_detection_job(params = {}, = {}) req = build_request(:describe_pii_entities_detection_job, params) req.send_request() 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.
2381 2382 2383 2384 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2381 def describe_resource_policy(params = {}, = {}) req = build_request(:describe_resource_policy, params) req.send_request() 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.
2432 2433 2434 2435 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2432 def describe_sentiment_detection_job(params = {}, = {}) req = build_request(:describe_sentiment_detection_job, params) req.send_request() 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.
2484 2485 2486 2487 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2484 def describe_targeted_sentiment_detection_job(params = {}, = {}) req = build_request(:describe_targeted_sentiment_detection_job, params) req.send_request() 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.
2534 2535 2536 2537 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2534 def describe_topics_detection_job(params = {}, = {}) req = build_request(:describe_topics_detection_job, params) req.send_request() 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.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2571 def detect_dominant_language(params = {}, = {}) req = build_request(:detect_dominant_language, params) req.send_request() 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 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.
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.
2732 2733 2734 2735 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2732 def detect_entities(params = {}, = {}) req = build_request(:detect_entities, params) req.send_request() end |
#detect_key_phrases(params = {}) ⇒ Types::DetectKeyPhrasesResponse
Detects the key noun phrases found in the text.
2771 2772 2773 2774 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2771 def detect_key_phrases(params = {}, = {}) req = build_request(:detect_key_phrases, params) req.send_request() end |
#detect_pii_entities(params = {}) ⇒ Types::DetectPiiEntitiesResponse
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
2809 2810 2811 2812 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2809 def detect_pii_entities(params = {}, = {}) req = build_request(:detect_pii_entities, params) req.send_request() end |
#detect_sentiment(params = {}) ⇒ Types::DetectSentimentResponse
Inspects text and returns an inference of the prevailing sentiment
(POSITIVE
, NEUTRAL
, MIXED
, or NEGATIVE
).
2849 2850 2851 2852 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2849 def detect_sentiment(params = {}, = {}) req = build_request(:detect_sentiment, params) req.send_request() 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.
2896 2897 2898 2899 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2896 def detect_syntax(params = {}, = {}) req = build_request(:detect_syntax, params) req.send_request() 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.
2951 2952 2953 2954 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2951 def detect_targeted_sentiment(params = {}, = {}) req = build_request(:detect_targeted_sentiment, params) req.send_request() 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.
3001 3002 3003 3004 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3001 def detect_toxic_content(params = {}, = {}) req = build_request(:detect_toxic_content, params) req.send_request() 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.
3081 3082 3083 3084 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3081 def import_model(params = {}, = {}) req = build_request(:import_model, params) req.send_request() 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3146 def list_datasets(params = {}, = {}) req = build_request(:list_datasets, params) req.send_request() 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.
3218 3219 3220 3221 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3218 def list_document_classification_jobs(params = {}, = {}) req = build_request(:list_document_classification_jobs, params) req.send_request() 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.
3261 3262 3263 3264 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3261 def list_document_classifier_summaries(params = {}, = {}) req = build_request(:list_document_classifier_summaries, params) req.send_request() 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.
3361 3362 3363 3364 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3361 def list_document_classifiers(params = {}, = {}) req = build_request(:list_document_classifiers, params) req.send_request() 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.
3431 3432 3433 3434 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3431 def list_dominant_language_detection_jobs(params = {}, = {}) req = build_request(:list_dominant_language_detection_jobs, params) req.send_request() end |
#list_endpoints(params = {}) ⇒ Types::ListEndpointsResponse
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3496 3497 3498 3499 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3496 def list_endpoints(params = {}, = {}) req = build_request(:list_endpoints, params) req.send_request() 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.
3568 3569 3570 3571 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3568 def list_entities_detection_jobs(params = {}, = {}) req = build_request(:list_entities_detection_jobs, params) req.send_request() 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.
3611 3612 3613 3614 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3611 def list_entity_recognizer_summaries(params = {}, = {}) req = build_request(:list_entity_recognizer_summaries, params) req.send_request() 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.
3713 3714 3715 3716 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3713 def list_entity_recognizers(params = {}, = {}) req = build_request(:list_entity_recognizers, params) req.send_request() 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.
3779 3780 3781 3782 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3779 def list_events_detection_jobs(params = {}, = {}) req = build_request(:list_events_detection_jobs, params) req.send_request() 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3849 3850 3851 3852 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3849 def list_flywheel_iteration_history(params = {}, = {}) req = build_request(:list_flywheel_iteration_history, params) req.send_request() 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.
3904 3905 3906 3907 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3904 def list_flywheels(params = {}, = {}) req = build_request(:list_flywheels, params) req.send_request() 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.
3974 3975 3976 3977 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3974 def list_key_phrases_detection_jobs(params = {}, = {}) req = build_request(:list_key_phrases_detection_jobs, params) req.send_request() 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.
4043 4044 4045 4046 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4043 def list_pii_entities_detection_jobs(params = {}, = {}) req = build_request(:list_pii_entities_detection_jobs, params) req.send_request() 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.
4113 4114 4115 4116 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4113 def list_sentiment_detection_jobs(params = {}, = {}) req = build_request(:list_sentiment_detection_jobs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a given Amazon Comprehend resource.
4146 4147 4148 4149 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4146 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
4217 4218 4219 4220 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4217 def list_targeted_sentiment_detection_jobs(params = {}, = {}) req = build_request(:list_targeted_sentiment_detection_jobs, params) req.send_request() 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.
4287 4288 4289 4290 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4287 def list_topics_detection_jobs(params = {}, = {}) req = build_request(:list_topics_detection_jobs, params) req.send_request() 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.
4341 4342 4343 4344 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4341 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() 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.
4456 4457 4458 4459 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4456 def start_document_classification_job(params = {}, = {}) req = build_request(:start_document_classification_job, params) req.send_request() 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.
4564 4565 4566 4567 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4564 def start_dominant_language_detection_job(params = {}, = {}) req = build_request(:start_dominant_language_detection_job, params) req.send_request() 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.
4696 4697 4698 4699 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4696 def start_entities_detection_job(params = {}, = {}) req = build_request(:start_entities_detection_job, params) req.send_request() end |
#start_events_detection_job(params = {}) ⇒ Types::StartEventsDetectionJobResponse
Starts an asynchronous event detection job for a collection of documents.
4781 4782 4783 4784 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4781 def start_events_detection_job(params = {}, = {}) req = build_request(:start_events_detection_job, params) req.send_request() 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.
4822 4823 4824 4825 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4822 def start_flywheel_iteration(params = {}, = {}) req = build_request(:start_flywheel_iteration, params) req.send_request() 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.
4935 4936 4937 4938 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4935 def start_key_phrases_detection_job(params = {}, = {}) req = build_request(:start_key_phrases_detection_job, params) req.send_request() end |
#start_pii_entities_detection_job(params = {}) ⇒ Types::StartPiiEntitiesDetectionJobResponse
Starts an asynchronous PII entity detection job for a collection of documents.
5035 5036 5037 5038 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5035 def start_pii_entities_detection_job(params = {}, = {}) req = build_request(:start_pii_entities_detection_job, params) req.send_request() 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.
5148 5149 5150 5151 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5148 def start_sentiment_detection_job(params = {}, = {}) req = build_request(:start_sentiment_detection_job, params) req.send_request() 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.
5263 5264 5265 5266 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5263 def start_targeted_sentiment_detection_job(params = {}, = {}) req = build_request(:start_targeted_sentiment_detection_job, params) req.send_request() 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.
5377 5378 5379 5380 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5377 def start_topics_detection_job(params = {}, = {}) req = build_request(:start_topics_detection_job, params) req.send_request() 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.
5419 5420 5421 5422 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5419 def stop_dominant_language_detection_job(params = {}, = {}) req = build_request(:stop_dominant_language_detection_job, params) req.send_request() 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.
5461 5462 5463 5464 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5461 def stop_entities_detection_job(params = {}, = {}) req = build_request(:stop_entities_detection_job, params) req.send_request() end |
#stop_events_detection_job(params = {}) ⇒ Types::StopEventsDetectionJobResponse
Stops an events detection job in progress.
5491 5492 5493 5494 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5491 def stop_events_detection_job(params = {}, = {}) req = build_request(:stop_events_detection_job, params) req.send_request() 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.
5533 5534 5535 5536 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5533 def stop_key_phrases_detection_job(params = {}, = {}) req = build_request(:stop_key_phrases_detection_job, params) req.send_request() end |
#stop_pii_entities_detection_job(params = {}) ⇒ Types::StopPiiEntitiesDetectionJobResponse
Stops a PII entities detection job in progress.
5563 5564 5565 5566 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5563 def stop_pii_entities_detection_job(params = {}, = {}) req = build_request(:stop_pii_entities_detection_job, params) req.send_request() 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.
5605 5606 5607 5608 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5605 def stop_sentiment_detection_job(params = {}, = {}) req = build_request(:stop_sentiment_detection_job, params) req.send_request() end |
#stop_targeted_sentiment_detection_job(params = {}) ⇒ Types::StopTargetedSentimentDetectionJobResponse
Stops a targeted 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.
5647 5648 5649 5650 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5647 def stop_targeted_sentiment_detection_job(params = {}, = {}) req = build_request(:stop_targeted_sentiment_detection_job, params) req.send_request() 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.
5677 5678 5679 5680 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5677 def stop_training_document_classifier(params = {}, = {}) req = build_request(:stop_training_document_classifier, params) req.send_request() 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.
5707 5708 5709 5710 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5707 def stop_training_entity_recognizer(params = {}, = {}) req = build_request(:stop_training_entity_recognizer, params) req.send_request() 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.
5744 5745 5746 5747 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5744 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a specific tag associated with an Amazon Comprehend resource.
5775 5776 5777 5778 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5775 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_endpoint(params = {}) ⇒ Types::UpdateEndpointResponse
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.
5827 5828 5829 5830 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5827 def update_endpoint(params = {}, = {}) req = build_request(:update_endpoint, params) req.send_request() end |
#update_flywheel(params = {}) ⇒ Types::UpdateFlywheelResponse
Update the configuration information for an existing flywheel.
5897 5898 5899 5900 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5897 def update_flywheel(params = {}, = {}) req = build_request(:update_flywheel, params) req.send_request() end |