Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

transcribe Update models to latest #3567

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

transcribe Update models to latest #3567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
185 changes: 181 additions & 4 deletions ...roid-sdk-transcribe/src/main/java/com/amazonaws/services/transcribe/AmazonTranscribe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
Expand Down Expand Up @@ -421,6 +421,28 @@ DeleteCallAnalyticsJobResult deleteCallAnalyticsJob(
void deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest)
throws AmazonClientException, AmazonServiceException;

/**
* <p>
* Deletes a Medical Scribe job. To use this operation, specify the name of
* the job you want to delete using <code>MedicalScribeJobName</code>. Job
* names are case sensitive.
* </p>
*
* @param deleteMedicalScribeJobRequest
* @throws LimitExceededException
* @throws BadRequestException
* @throws InternalFailureException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Transcribe indicating either a problem with the data in the
* request, or a server side issue.
*/
void deleteMedicalScribeJob(DeleteMedicalScribeJobRequest deleteMedicalScribeJobRequest)
throws AmazonClientException, AmazonServiceException;

/**
* <p>
* Deletes a medical transcription job. To use this operation, specify the
Expand Down Expand Up @@ -646,6 +668,42 @@ GetCallAnalyticsJobResult getCallAnalyticsJob(
GetCallAnalyticsJobRequest getCallAnalyticsJobRequest) throws AmazonClientException,
AmazonServiceException;

/**
* <p>
* Provides information about the specified Medical Scribe job.
* </p>
* <p>
* To view the status of the specified medical transcription job, check the
* <code>MedicalScribeJobStatus</code> field. If the status is
* <code>COMPLETED</code>, the job is finished. You can find the results at
* the location specified in <code>MedicalScribeOutput</code>. If the status
* is <code>FAILED</code>, <code>FailureReason</code> provides details on
* why your Medical Scribe job failed.
* </p>
* <p>
* To get a list of your Medical Scribe jobs, use the operation.
* </p>
*
* @param getMedicalScribeJobRequest
* @return getMedicalScribeJobResult The response from the
* GetMedicalScribeJob service method, as returned by Amazon
* Transcribe.
* @throws BadRequestException
* @throws LimitExceededException
* @throws InternalFailureException
* @throws NotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Transcribe indicating either a problem with the data in the
* request, or a server side issue.
*/
GetMedicalScribeJobResult getMedicalScribeJob(
GetMedicalScribeJobRequest getMedicalScribeJobRequest) throws AmazonClientException,
AmazonServiceException;

/**
* <p>
* Provides information about the specified medical transcription job.
Expand Down Expand Up @@ -904,6 +962,35 @@ ListCallAnalyticsJobsResult listCallAnalyticsJobs(
ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest)
throws AmazonClientException, AmazonServiceException;

/**
* <p>
* Provides a list of Medical Scribe jobs that match the specified criteria.
* If no criteria are specified, all Medical Scribe jobs are returned.
* </p>
* <p>
* To get detailed information about a specific Medical Scribe job, use the
* operation.
* </p>
*
* @param listMedicalScribeJobsRequest
* @return listMedicalScribeJobsResult The response from the
* ListMedicalScribeJobs service method, as returned by Amazon
* Transcribe.
* @throws BadRequestException
* @throws LimitExceededException
* @throws InternalFailureException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Transcribe indicating either a problem with the data in the
* request, or a server side issue.
*/
ListMedicalScribeJobsResult listMedicalScribeJobs(
ListMedicalScribeJobsRequest listMedicalScribeJobsRequest)
throws AmazonClientException, AmazonServiceException;

/**
* <p>
* Provides a list of medical transcription jobs that match the specified
Expand Down Expand Up @@ -1179,6 +1266,96 @@ StartCallAnalyticsJobResult startCallAnalyticsJob(
StartCallAnalyticsJobRequest startCallAnalyticsJobRequest)
throws AmazonClientException, AmazonServiceException;

/**
* <p>
* Transcribes patient-clinician conversations and generates clinical notes.
* </p>
* <p>
* Amazon Web Services HealthScribe automatically provides rich conversation
* transcripts, identifies speaker roles, classifies dialogues, extracts
* medical terms, and generates preliminary clinical notes. To learn more
* about these features, refer to <a href=
* "https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html"
* >Amazon Web Services HealthScribe</a>.
* </p>
* <p>
* To make a <code>StartMedicalScribeJob</code> request, you must first
* upload your media file into an Amazon S3 bucket; you can then specify the
* Amazon S3 location of the file using the <code>Media</code> parameter.
* </p>
* <p>
* You must include the following parameters in your
* <code>StartMedicalTranscriptionJob</code> request:
* </p>
* <ul>
* <li>
* <p>
* <code>DataAccessRoleArn</code>: The ARN of an IAM role with the these
* minimum permissions: read permission on input file Amazon S3 bucket
* specified in <code>Media</code>, write permission on the Amazon S3 bucket
* specified in <code>OutputBucketName</code>, and full permissions on the
* KMS key specified in <code>OutputEncryptionKMSKeyId</code> (if set). The
* role should also allow <code>transcribe.amazonaws.com</code> to assume
* it.
* </p>
* </li>
* <li>
* <p>
* <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location of
* your media file.
* </p>
* </li>
* <li>
* <p>
* <code>MedicalScribeJobName</code>: A custom name you create for your
* MedicalScribe job that is unique within your Amazon Web Services account.
* </p>
* </li>
* <li>
* <p>
* <code>OutputBucketName</code>: The Amazon S3 bucket where you want your
* output files stored.
* </p>
* </li>
* <li>
* <p>
* <code>Settings</code>: A <code>MedicalScribeSettings</code> obect that
* must set exactly one of <code>ShowSpeakerLabels</code> or
* <code>ChannelIdentification</code> to true. If
* <code>ShowSpeakerLabels</code> is true, <code>MaxSpeakerLabels</code>
* must also be set.
* </p>
* </li>
* <li>
* <p>
* <code>ChannelDefinitions</code>: A
* <code>MedicalScribeChannelDefinitions</code> array should be set if and
* only if the <code>ChannelIdentification</code> value of
* <code>Settings</code> is set to true.
* </p>
* </li>
* </ul>
*
* @param startMedicalScribeJobRequest
* @return startMedicalScribeJobResult The response from the
* StartMedicalScribeJob service method, as returned by Amazon
* Transcribe.
* @throws BadRequestException
* @throws LimitExceededException
* @throws InternalFailureException
* @throws ConflictException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Transcribe indicating either a problem with the data in the
* request, or a server side issue.
*/
StartMedicalScribeJobResult startMedicalScribeJob(
StartMedicalScribeJobRequest startMedicalScribeJobRequest)
throws AmazonClientException, AmazonServiceException;

/**
* <p>
* Transcribes the audio from a medical dictation or conversation and
Expand All @@ -1196,7 +1373,7 @@ StartCallAnalyticsJobResult startCallAnalyticsJob(
* <p>
* To make a <code>StartMedicalTranscriptionJob</code> request, you must
* first upload your media file into an Amazon S3 bucket; you can then
* specify the S3 location of the file using the <code>Media</code>
* specify the Amazon S3 location of the file using the <code>Media</code>
* parameter.
* </p>
* <p>
Expand Down Expand Up @@ -1314,8 +1491,8 @@ StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(
* media file, specify it using the <code>LanguageCode</code> parameter; you
* can find all valid language codes in the <a href=
* "https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html"
* >Supported languages</a> table. If you don't know the languages spoken in
* your media, use either <code>IdentifyLanguage</code> or
* >Supported languages</a> table. If you do not know the languages spoken
* in your media, use either <code>IdentifyLanguage</code> or
* <code>IdentifyMultipleLanguages</code> and let Amazon Transcribe identify
* the languages for you.
* </p>
Expand Down
Loading