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.
-
#classify_document(params = {}) ⇒ Types::ClassifyDocumentResponse
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
-
#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_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.
-
#create_entity_recognizer(params = {}) ⇒ Types::CreateEntityRecognizerResponse
Creates an entity recognizer using submitted files.
-
#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_resource_policy(params = {}) ⇒ Struct
Deletes a resource-based policy that is attached to a custom model.
-
#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_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
Inspects text for named entities, and returns information about them.
-
#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.
-
#import_model(params = {}) ⇒ Types::ImportModelResponse
Creates a new custom model that replicates a source custom model that you import.
-
#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_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.
-
#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_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 = {}) ⇒ Struct
Updates information about the specified endpoint.
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.
358 359 360 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 358 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.
405 406 407 408 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 405 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 how-entities
455 456 457 458 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 455 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.
502 503 504 505 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 502 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.
551 552 553 554 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 551 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 how-syntax.
603 604 605 606 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 603 def batch_detect_syntax(params = {}, = {}) req = build_request(:batch_detect_syntax, params) req.send_request() end |
#classify_document(params = {}) ⇒ Types::ClassifyDocumentResponse
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
643 644 645 646 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 643 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.
681 682 683 684 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 681 def contains_pii_entities(params = {}, = {}) req = build_request(:contains_pii_entities, 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 labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.
846 847 848 849 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 846 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
915 916 917 918 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 915 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 API.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1079 def create_entity_recognizer(params = {}, = {}) req = build_request(:create_entity_recognizer, 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.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1111 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.
1135 1136 1137 1138 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1135 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.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1166 def delete_entity_recognizer(params = {}, = {}) req = build_request(:delete_entity_recognizer, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a resource-based policy that is attached to a custom model.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1193 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, 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.
1244 1245 1246 1247 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1244 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.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1315 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.
1365 1366 1367 1368 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1365 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.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1404 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.
1456 1457 1458 1459 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1456 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.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1530 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.
1576 1577 1578 1579 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1576 def describe_events_detection_job(params = {}, = {}) req = build_request(:describe_events_detection_job, 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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1627 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.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1678 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.
1713 1714 1715 1716 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1713 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.
1764 1765 1766 1767 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1764 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.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1815 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.
1865 1866 1867 1868 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1865 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.
1902 1903 1904 1905 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1902 def detect_dominant_language(params = {}, = {}) req = build_request(:detect_dominant_language, params) req.send_request() end |
#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse
Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
1958 1959 1960 1961 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1958 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.
1997 1998 1999 2000 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1997 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.
2035 2036 2037 2038 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2035 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
).
2076 2077 2078 2079 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2076 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, how-syntax.
2119 2120 2121 2122 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2119 def detect_syntax(params = {}, = {}) req = build_request(:detect_syntax, 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 AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
2199 2200 2201 2202 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2199 def import_model(params = {}, = {}) req = build_request(:import_model, 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.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2270 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.
2313 2314 2315 2316 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2313 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.
2404 2405 2406 2407 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2404 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.
2474 2475 2476 2477 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2474 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.
2531 2532 2533 2534 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2531 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.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2602 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.
2645 2646 2647 2648 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2645 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.
2745 2746 2747 2748 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2745 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.
2811 2812 2813 2814 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2811 def list_events_detection_jobs(params = {}, = {}) req = build_request(:list_events_detection_jobs, 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.
2881 2882 2883 2884 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2881 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.
2948 2949 2950 2951 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2948 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.
3018 3019 3020 3021 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3018 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.
3051 3052 3053 3054 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3051 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.
3122 3123 3124 3125 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3122 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.
3192 3193 3194 3195 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3192 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 AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
3246 3247 3248 3249 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3246 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. Use the operation to track the progress of the job.
3354 3355 3356 3357 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3354 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.
3463 3464 3465 3466 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3463 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.
3589 3590 3591 3592 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3589 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.
3675 3676 3677 3678 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3675 def start_events_detection_job(params = {}, = {}) req = build_request(:start_events_detection_job, 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.
3789 3790 3791 3792 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3789 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.
3889 3890 3891 3892 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3889 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.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4003 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 operation to track the status of a job.
4118 4119 4120 4121 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4118 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.
4233 4234 4235 4236 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4233 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.
4275 4276 4277 4278 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4275 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.
4317 4318 4319 4320 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4317 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.
4347 4348 4349 4350 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4347 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.
4389 4390 4391 4392 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4389 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.
4419 4420 4421 4422 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4419 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.
4461 4462 4463 4464 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4461 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.
4503 4504 4505 4506 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4503 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.
4533 4534 4535 4536 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4533 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.
4563 4564 4565 4566 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4563 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.
4600 4601 4602 4603 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4600 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.
4631 4632 4633 4634 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4631 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_endpoint(params = {}) ⇒ Struct
Updates information about the specified endpoint.
4668 4669 4670 4671 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 4668 def update_endpoint(params = {}, = {}) req = build_request(:update_endpoint, params) req.send_request() end |