Client

transcribeservice

R Documentation

Amazon Transcribe Service¶

Description¶

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.

Standard transcriptions are the most common option. Refer to for details.
Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.
Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.

Usage¶

transcribeservice(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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.

Service syntax¶

svc <- transcribeservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_call_analytics_category: Creates a new Call Analytics category
create_language_model: Creates a new custom language model
create_medical_vocabulary: Creates a new custom medical vocabulary
create_vocabulary: Creates a new custom vocabulary
create_vocabulary_filter: Creates a new custom vocabulary filter
delete_call_analytics_category: Deletes a Call Analytics category
delete_call_analytics_job: Deletes a Call Analytics job
delete_language_model: Deletes a custom language model
delete_medical_scribe_job: Deletes a Medical Scribe job
delete_medical_transcription_job: Deletes a medical transcription job
delete_medical_vocabulary: Deletes a custom medical vocabulary
delete_transcription_job: Deletes a transcription job
delete_vocabulary: Deletes a custom vocabulary
delete_vocabulary_filter: Deletes a custom vocabulary filter
describe_language_model: Provides information about the specified custom language model
get_call_analytics_category: Provides information about the specified Call Analytics category
get_call_analytics_job: Provides information about the specified Call Analytics job
get_medical_scribe_job: Provides information about the specified Medical Scribe job
get_medical_transcription_job: Provides information about the specified medical transcription job
get_medical_vocabulary: Provides information about the specified custom medical vocabulary
get_transcription_job: Provides information about the specified transcription job
get_vocabulary: Provides information about the specified custom vocabulary
get_vocabulary_filter: Provides information about the specified custom vocabulary filter
list_call_analytics_categories: Provides a list of Call Analytics categories, including all rules that make up each category
list_call_analytics_jobs: Provides a list of Call Analytics jobs that match the specified criteria
list_language_models: Provides a list of custom language models that match the specified criteria
list_medical_scribe_jobs: Provides a list of Medical Scribe jobs that match the specified criteria
list_medical_transcription_jobs: Provides a list of medical transcription jobs that match the specified criteria
list_medical_vocabularies: Provides a list of custom medical vocabularies that match the specified criteria
list_tags_for_resource: Lists all tags associated with the specified transcription job, vocabulary, model, or resource
list_transcription_jobs: Provides a list of transcription jobs that match the specified criteria
list_vocabularies: Provides a list of custom vocabularies that match the specified criteria
list_vocabulary_filters: Provides a list of custom vocabulary filters that match the specified criteria
start_call_analytics_job: Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request
start_medical_scribe_job: Transcribes patient-clinician conversations and generates clinical notes
start_medical_transcription_job: Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request
start_transcription_job: Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request
tag_resource: Adds one or more custom tags, each in the form of a key:value pair, to the specified resource
untag_resource: Removes the specified tags from the specified Amazon Transcribe resource
update_call_analytics_category: Updates the specified Call Analytics category with new rules
update_medical_vocabulary: Updates an existing custom medical vocabulary with new values
update_vocabulary: Updates an existing custom vocabulary with new values
update_vocabulary_filter: Updates an existing custom vocabulary filter with a new list of words

Examples¶

## Not run: 
svc <- transcribeservice()
svc$create_call_analytics_category(
  Foo = 123
)

## End(Not run)