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.
-
#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.
-
#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_sentiment_detection_job(params = {}) ⇒ Types::DescribeSentimentDetectionJobResponse
Gets the properties associated with a 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.
-
#list_document_classification_jobs(params = {}) ⇒ Types::ListDocumentClassificationJobsResponse
Gets a list of the documentation classification jobs that you have submitted.
-
#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_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_topics_detection_jobs(params = {}) ⇒ Types::ListTopicsDetectionJobsResponse
Gets a list of the topic detection jobs that you have submitted.
-
#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_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_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.
334 335 336 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 334 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.
381 382 383 384 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 381 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
431 432 433 434 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 431 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.
478 479 480 481 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 478 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.
527 528 529 530 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 527 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.
579 580 581 582 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 579 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.
619 620 621 622 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 619 def classify_document(params = {}, = {}) req = build_request(:classify_document, 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.
741 742 743 744 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 741 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
803 804 805 806 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 803 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.
922 923 924 925 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 922 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.
954 955 956 957 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 954 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.
978 979 980 981 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 978 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.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1009 def delete_entity_recognizer(params = {}, = {}) req = build_request(:delete_entity_recognizer, 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.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1055 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.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1118 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.
1163 1164 1165 1166 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1163 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.
1199 1200 1201 1202 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1199 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.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1246 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.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1310 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.
1351 1352 1353 1354 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1351 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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1397 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.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1443 def describe_pii_entities_detection_job(params = {}, = {}) req = build_request(:describe_pii_entities_detection_job, 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.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1489 def describe_sentiment_detection_job(params = {}, = {}) req = build_request(:describe_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.
1534 1535 1536 1537 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1534 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.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1571 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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1627 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.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1666 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.
1704 1705 1706 1707 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1704 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
).
1745 1746 1747 1748 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1745 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.
1788 1789 1790 1791 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1788 def detect_syntax(params = {}, = {}) req = build_request(:detect_syntax, 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.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1854 def list_document_classification_jobs(params = {}, = {}) req = build_request(:list_document_classification_jobs, 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.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 1936 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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2001 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.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2055 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.
2121 2122 2123 2124 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2121 def list_entities_detection_jobs(params = {}, = {}) req = build_request(:list_entities_detection_jobs, 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.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2210 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.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2271 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.
2336 2337 2338 2339 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2336 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.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2398 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.
2463 2464 2465 2466 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2463 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.
2496 2497 2498 2499 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2496 def (params = {}, = {}) req = build_request(:list_tags_for_resource, 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.
2561 2562 2563 2564 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2561 def list_topics_detection_jobs(params = {}, = {}) req = build_request(:list_topics_detection_jobs, 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.
2650 2651 2652 2653 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2650 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.
2740 2741 2742 2743 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2740 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.
2847 2848 2849 2850 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2847 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.
2914 2915 2916 2917 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 2914 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.
3009 3010 3011 3012 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3009 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.
3090 3091 3092 3093 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3090 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.
3185 3186 3187 3188 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3185 def start_sentiment_detection_job(params = {}, = {}) req = build_request(:start_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.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3281 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.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3323 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.
3365 3366 3367 3368 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3365 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.
3395 3396 3397 3398 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3395 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.
3437 3438 3439 3440 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3437 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.
3467 3468 3469 3470 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3467 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.
3509 3510 3511 3512 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3509 def stop_sentiment_detection_job(params = {}, = {}) req = build_request(:stop_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.
3539 3540 3541 3542 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3539 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.
3569 3570 3571 3572 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3569 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.
3606 3607 3608 3609 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3606 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.
3637 3638 3639 3640 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3637 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_endpoint(params = {}) ⇒ Struct
Updates information about the specified endpoint.
3665 3666 3667 3668 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/client.rb', line 3665 def update_endpoint(params = {}, = {}) req = build_request(:update_endpoint, params) req.send_request() end |