Learn R Programming

paws (version 0.1.12)

comprehend: Amazon Comprehend

Description

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

Usage

comprehend(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- comprehend(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

batch_detect_dominant_languageDetermines the dominant language of the input text for a batch of documents
batch_detect_entitiesInspects the text of a batch of documents for named entities and returns information about them
batch_detect_key_phrasesDetects the key noun phrases found in a batch of documents
batch_detect_sentimentInspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one
batch_detect_syntaxInspects 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_documentCreates 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_classifierCreates a new document classifier that you can use to categorize documents
create_endpointCreates a model-specific endpoint for synchronous inference for a previously trained custom model
create_entity_recognizerCreates an entity recognizer using submitted files
delete_document_classifierDeletes a previously created document classifier
delete_endpointDeletes a model-specific endpoint for a previously-trained custom model
delete_entity_recognizerDeletes an entity recognizer
describe_document_classification_jobGets the properties associated with a document classification job
describe_document_classifierGets the properties associated with a document classifier
describe_dominant_language_detection_jobGets the properties associated with a dominant language detection job
describe_endpointGets the properties associated with a specific endpoint
describe_entities_detection_jobGets the properties associated with an entities detection job
describe_entity_recognizerProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on
describe_events_detection_jobGets the status and details of an events detection job
describe_key_phrases_detection_jobGets the properties associated with a key phrases detection job
describe_pii_entities_detection_jobGets the properties associated with a PII entities detection job
describe_sentiment_detection_jobGets the properties associated with a sentiment detection job
describe_topics_detection_jobGets the properties associated with a topic detection job
detect_dominant_languageDetermines the dominant language of the input text
detect_entitiesInspects text for named entities, and returns information about them
detect_key_phrasesDetects the key noun phrases found in the text
detect_pii_entitiesInspects the input text for entities that contain personally identifiable information (PII) and returns information about them
detect_sentimentInspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE)
detect_syntaxInspects text for syntax and the part of speech of words in the document
list_document_classification_jobsGets a list of the documentation classification jobs that you have submitted
list_document_classifiersGets a list of the document classifiers that you have created
list_dominant_language_detection_jobsGets a list of the dominant language detection jobs that you have submitted
list_endpointsGets a list of all existing endpoints that you've created
list_entities_detection_jobsGets a list of the entity detection jobs that you have submitted
list_entity_recognizersGets a list of the properties of all entity recognizers that you created, including recognizers currently in training
list_events_detection_jobsGets a list of the events detection jobs that you have submitted
list_key_phrases_detection_jobsGet a list of key phrase detection jobs that you have submitted
list_pii_entities_detection_jobsGets a list of the PII entity detection jobs that you have submitted
list_sentiment_detection_jobsGets a list of sentiment detection jobs that you have submitted
list_tags_for_resourceLists all tags associated with a given Amazon Comprehend resource
list_topics_detection_jobsGets a list of the topic detection jobs that you have submitted
start_document_classification_jobStarts an asynchronous document classification job
start_dominant_language_detection_jobStarts an asynchronous dominant language detection job for a collection of documents
start_entities_detection_jobStarts an asynchronous entity detection job for a collection of documents
start_events_detection_jobStarts an asynchronous event detection job for a collection of documents
start_key_phrases_detection_jobStarts an asynchronous key phrase detection job for a collection of documents
start_pii_entities_detection_jobStarts an asynchronous PII entity detection job for a collection of documents
start_sentiment_detection_jobStarts an asynchronous sentiment detection job for a collection of documents
start_topics_detection_jobStarts an asynchronous topic detection job
stop_dominant_language_detection_jobStops a dominant language detection job in progress
stop_entities_detection_jobStops an entities detection job in progress
stop_events_detection_jobStops an events detection job in progress
stop_key_phrases_detection_jobStops a key phrases detection job in progress
stop_pii_entities_detection_jobStops a PII entities detection job in progress
stop_sentiment_detection_jobStops a sentiment detection job in progress
stop_training_document_classifierStops a document classifier training job while in progress
stop_training_entity_recognizerStops an entity recognizer training job while in progress
tag_resourceAssociates a specific tag with an Amazon Comprehend resource
untag_resourceRemoves a specific tag associated with an Amazon Comprehend resource
update_endpointUpdates information about the specified endpoint

Examples

Run this code
if (FALSE) {
svc <- comprehend()
svc$batch_detect_dominant_language(
  Foo = 123
)
}

Run the code above in your browser using DataLab