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.
420 421 422 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 420 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.
467 468 469 470 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 467 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.
529 530 531 532 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 529 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.
576 577 578 579 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 576 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.
625 626 627 628 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 625 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.
682 683 684 685 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 682 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.
746 747 748 749 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 746 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.
883 884 885 886 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 883 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.
919 920 921 922 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 919 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.
1017 1018 1019 1020 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1017 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.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1196 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.
1276 1277 1278 1279 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1276 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.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1439 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.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1561 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.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1593 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.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1621 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.
1652 1653 1654 1655 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1652 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.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1683 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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1710 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.
1753 1754 1755 1756 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1753 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.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1806 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.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1887 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.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1938 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.
1983 1984 1985 1986 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1983 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.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2037 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.
2113 2114 2115 2116 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2113 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.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2159 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.
2215 2216 2217 2218 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2215 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.
2267 2268 2269 2270 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2267 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.
2319 2320 2321 2322 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2319 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.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2370 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.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2406 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.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2457 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.
2509 2510 2511 2512 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2509 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.
2559 2560 2561 2562 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2559 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.
2596 2597 2598 2599 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2596 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.
2757 2758 2759 2760 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2757 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.
2796 2797 2798 2799 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2796 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.
2834 2835 2836 2837 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2834 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
).
2874 2875 2876 2877 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2874 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.
2921 2922 2923 2924 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2921 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.
2976 2977 2978 2979 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2976 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.
3026 3027 3028 3029 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3026 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.
3106 3107 3108 3109 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3106 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.
3171 3172 3173 3174 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3171 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.
3243 3244 3245 3246 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3243 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.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3286 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.
3386 3387 3388 3389 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3386 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.
3456 3457 3458 3459 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3456 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.
3521 3522 3523 3524 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3521 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.
3593 3594 3595 3596 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3593 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.
3636 3637 3638 3639 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3636 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.
3738 3739 3740 3741 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3738 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.
3804 3805 3806 3807 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3804 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.
3874 3875 3876 3877 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3874 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.
3929 3930 3931 3932 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3929 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.
3999 4000 4001 4002 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3999 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.
4068 4069 4070 4071 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4068 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.
4138 4139 4140 4141 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4138 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.
4171 4172 4173 4174 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4171 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.
4242 4243 4244 4245 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4242 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.
4312 4313 4314 4315 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4312 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.
4366 4367 4368 4369 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4366 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.
4481 4482 4483 4484 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4481 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.
4589 4590 4591 4592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4589 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.
4721 4722 4723 4724 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4721 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.
4806 4807 4808 4809 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4806 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.
4847 4848 4849 4850 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4847 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.
4960 4961 4962 4963 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4960 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.
5060 5061 5062 5063 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5060 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.
5173 5174 5175 5176 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5173 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.
5288 5289 5290 5291 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5288 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.
5402 5403 5404 5405 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5402 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.
5444 5445 5446 5447 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5444 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.
5486 5487 5488 5489 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5486 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.
5516 5517 5518 5519 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5516 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.
5558 5559 5560 5561 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5558 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.
5588 5589 5590 5591 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5588 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.
5630 5631 5632 5633 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5630 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.
5672 5673 5674 5675 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5672 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.
5702 5703 5704 5705 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5702 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.
5732 5733 5734 5735 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5732 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.
5769 5770 5771 5772 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5769 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.
5800 5801 5802 5803 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5800 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.
5852 5853 5854 5855 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5852 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.
5922 5923 5924 5925 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 5922 def update_flywheel(params = {}, = {}) req = build_request(:update_flywheel, params) req.send_request() end |