StartMedicalTranscriptionJob - Transcribe
Sintaxe da solicitaçãoParâmetros de solicitaçãoSintaxe da respostaElementos de respostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

StartMedicalTranscriptionJob

Transcreve o áudio de um ditado ou conversa médica e aplica quaisquer parâmetros de solicitação adicionais que você escolher incluir em sua solicitação.

Além de muitos recursos de transcrição padrão, o Amazon Transcribe Medical fornece um vocabulário médico robusto e, opcionalmente, identificação de conteúdo, que adiciona bandeiras às informações pessoais de saúde (PHI). Para saber mais sobre esses recursos, consulte Como funciona o Amazon Transcribe Medical.

Para fazer umaStartMedicalTranscriptionJob solicitação, você deve primeiro carregar seu arquivo de mídia em um bucket do Amazon S3; depois, você pode especificar a localização do arquivo no S3 usando oMedia parâmetro.

Você deve incluir os seguintes parâmetros em suaStartMedicalTranscriptionJob solicitação:

  • region: ORegião da AWS local em que você está fazendo sua solicitação. Para obter uma lista deRegiões da AWS opções compatíveis com o Amazon Transcribe, consulte os endpoints e cotas do Amazon Transcribe.

  • MedicalTranscriptionJobName: um nome personalizado que você cria para seu trabalho de transcrição que é exclusivo dentro do seuConta da AWS.

  • Media(MediaFileUri): A localização do seu arquivo de mídia no Amazon S3.

  • LanguageCode: Isso deve seren-US.

  • OutputBucketName: o bucket do Amazon S3 no qual você deseja armazenar sua transcrição. Se você quiser que sua saída seja armazenada em uma subpasta desse bucket, você também deve incluirOutputKey.

  • Specialty: Isso deve serPRIMARYCARE.

  • Type: escolha se seu áudio é uma conversa ou um ditado.

Sintaxe da solicitação

{
   "ContentIdentificationType": "string",
   "KMSEncryptionContext": { 
      "string" : "string" 
   },
   "LanguageCode": "string",
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "MediaFormat": "string",
   "MediaSampleRateHertz": number,
   "MedicalTranscriptionJobName": "string",
   "OutputBucketName": "string",
   "OutputEncryptionKMSKeyId": "string",
   "OutputKey": "string",
   "Settings": { 
      "ChannelIdentification": boolean,
      "MaxAlternatives": number,
      "MaxSpeakerLabels": number,
      "ShowAlternatives": boolean,
      "ShowSpeakerLabels": boolean,
      "VocabularyName": "string"
   },
   "Specialty": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string"
}

Parâmetros de solicitação

Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

ContentIdentificationType

Rotula todas as informações pessoais de saúde (PHI) identificadas em sua transcrição. Para obter mais informações, consulte Identificação de informações pessoais de saúde (PHI) em uma transcrição.

Tipo: String

Valores válidos: PHI

Obrigatório: não

KMSEncryptionContext

Um mapa de pares chave-valor não secretos de texto simples, conhecidos como pares de contexto de criptografia, que fornecem uma camada adicional de segurança para seus dados. Para obter mais informações, consulte Contexto deAWS KMS criptografia e Chaves assimétricas emAWS KMS.

Tipo:: mapa de string para string

Entradas do mapa: número máximo de 10 itens.

Restrições de tamanho de chave: tamanho mínimo de 1. Tamanho máximo de 2000.

Padrão da chave: .*\S.*

Restrições de tamanho do valor: tamanho mínimo de 1. Tamanho máximo de 2000.

Padrão de valor:.*\S.*

Obrigatório: não

LanguageCode

O código do idioma que representa o idioma falado no arquivo de mídia de entrada. O inglês dos EUA (en-US) é o único valor válido para trabalhos de transcrição médica. Qualquer outro valor inserido para o código do idioma resulta em umBadRequestException erro.

Tipo: String

Valores válidos: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE

Obrigatório: Sim

Media

Descreve a localização do arquivo de mídia no Amazon S3 que você deseja usar em sua solicitação.

Para obter informações sobre formatos de mídia compatíveis, consulte o MediaFormatparâmetro ou a seção Formatos de mídia no Guia do desenvolvedor do Amazon S3.

Tipo: objeto Media

Obrigatório: Sim

MediaFormat

Especifique o formato do seu arquivo de mídia de entrada.

Tipo: String

Valores válidos: mp3 | mp4 | wav | flac | ogg | amr | webm

Obrigatório: não

MediaSampleRateHertz

A taxa de amostragem, em hertz, da faixa de áudio em seu arquivo de mídia de entrada.

Se você não especificar a taxa de amostragem de mídia, o Amazon Transcribe Medical a determinará para você. Se você especificar a taxa de amostragem, ela deverá corresponder à taxa detectada pelo Amazon Transcribe Medical; se houver uma incompatibilidade entre o valor especificado e o valor detectado, seu trabalho falhará. Portanto, na maioria dos casos, é aconselhável omitirMediaSampleRateHertz e deixar que o Amazon Transcribe Medical determine a taxa de amostragem.

Tipo: inteiro

Intervalo válido: valor mínimo de 16000. Valor máximo de 48000.

Obrigatório: não

MedicalTranscriptionJobName

Um nome exclusivo, escolhido por você, para seu trabalho de transcrição médica. O nome que você especifica também é usado como o nome padrão do seu arquivo de saída de transcrição. Se você quiser especificar um nome diferente para sua saída de transcrição, use oOutputKey parâmetro.

Esse nome diferencia maiúsculas de minúsculas, não pode conter espaços e deve ser exclusivo em umConta da AWS. Se você tentar criar um novo trabalho com o mesmo nome de um trabalho existente, você receberá umConflictException erro.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 200.

Padrão: ^[0-9a-zA-Z._-]+

Obrigatório: Sim

OutputBucketName

O nome do bucket do Amazon S3 no qual você deseja armazenar sua saída de transcrição médica. Não inclua oS3:// prefixo do bucket especificado.

Se você quiser que sua saída vá para uma subpasta desse bucket, especifique-a usando oOutputKey parâmetro;OutputBucketName só aceita o nome de um bucket.

Por exemplo, se você quiser que sua saída seja armazenada emS3://DOC-EXAMPLE-BUCKET,OutputBucketName defina comoDOC-EXAMPLE-BUCKET. No entanto, se você quiser que sua saída seja armazenada emS3://DOC-EXAMPLE-BUCKET/test-files/,OutputBucketName defina comoDOC-EXAMPLE-BUCKET eOutputKey paratest-files/.

Observe que o Amazon Transcribe deve ter permissão para usar o local selecionado. Você pode alterar as permissões do Amazon S3 usando AWS Management Consoleo. Consulte também Permissões necessárias para funções de usuário do IAM.

Tipo: String

Restrições de comprimento: comprimento máximo de 64.

Padrão: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]

Obrigatório: Sim

OutputEncryptionKMSKeyId

A chave KMS que você deseja usar para criptografar sua saída de transcrição médica.

Se estiver usando uma chave localizada na atualConta da AWS, você pode especificar sua chave KMS de uma das quatro maneiras:

  1. Use o próprio ID da chave KMS. Por exemplo, 1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use um alias para o ID da chave do KMS. Por exemplo, alias/ExampleAlias.

  3. Use o nome do recurso da Amazon (ARN) para o ID da chave do KMS. Por exemplo, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  4. Use o ARN para o alias da chave do KMS. Por exemplo, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Se estiver usando uma chave localizada em umaConta da AWS posição diferente da atualConta da AWS, você pode especificar sua chave KMS de duas maneiras:

  1. Use o ARN para o ID da chave KMS. Por exemplo, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  2. Use o ARN para o alias da chave do KMS. Por exemplo, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Se você não especificar uma chave de criptografia), sua saída será criptografada com a chave do Amazon S3) (Chave do Amazon S3) (Chave do Amazon S3) (Chave do Amazon S3) (SSE-S3).

Se você especificar uma chave KMS para criptografar sua saída, também deverá especificar um local de saída usando oOutputLocation parâmetro.

Observe que a função que está fazendo aStartCallAnalyticsJob solicitação deve ter permissão para usar a chave do KMS selecionada.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 2048.

Padrão: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

Obrigatório: não

OutputKey

Use em combinação comOutputBucketName para especificar o local de saída de sua transcrição e, opcionalmente, um nome exclusivo para seu arquivo de saída. O nome padrão para sua saída de transcrição é o mesmo que você especificou para seu trabalho de transcrição médica (MedicalTranscriptionJobName).

Estes são alguns exemplos de como você pode usarOutputKey:

  • Se você especificar 'DOC-EXAMPLE-BUCKET' comoOutputBucketName e 'my-transcript.json' como oOutputKey, seu caminho de saída da transcrição serás3://DOC-EXAMPLE-BUCKET/my-transcript.json.

  • Se você especificar 'my-first-transcription' como oMedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' como e 'my-transcript' como oOutputKey, seu caminho de saída da transcrição serás3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.OutputBucketName

  • Se você especificar 'DOC-EXAMPLE-BUCKET' comoOutputBucketName e 'test-files/my-transcript.json' como oOutputKey, seu caminho de saída da transcrição serás3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

  • Se você especificar 'my-first-transcription' como oMedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' como oOutputBucketName e 'test-files/my-transcript' como oOutputKey, seu caminho de saída da transcrição serás3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

Se você especificar o nome de uma subpasta de bucket do Amazon S3 que não existe, uma será criada para você.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1024.

Padrão: [a-zA-Z0-9-_.!*'()/]{1,1024}$

Obrigatório: não

Settings

Especifique configurações opcionais adicionais em suaStartMedicalTranscriptionJob solicitação, incluindo identificação de canal, transcrições alternativas e particionamento de alto-falantes. Você pode usar isso para aplicar vocabulários personalizados ao seu trabalho de transcrição.

Tipo: objeto MedicalTranscriptionSetting

Obrigatório: não

Specialty

Especifique a especialidade médica predominante representada em sua mídia. Para transcrições em lote,PRIMARYCARE é o único valor válido. Se você precisar de especialidades adicionais, consulteStartMedicalStreamTranscription.

Tipo: String

Valores válidos: PRIMARYCARE

Obrigatório: Sim

Tags

Adiciona uma ou mais etiquetas personalizadas, cada uma na forma de um par chave:valor, a um novo trabalho de transcrição médica no momento em que você inicia esse novo trabalho.

Para saber mais sobre como usar tags com o Amazon Transcribe, consulte Chave de marcação.

Tipo: matriz de objetos Tag

Membros da matriz: número mínimo de 1 item. Número máximo de 200 itens.

Obrigatório: não

Type

Especifique se sua mídia de entrada contém somente uma pessoa (DICTATION) ou se contém uma conversa entre duas pessoas (CONVERSATION).

Por exemplo,DICTATION pode ser usado para um profissional médico que deseja transcrever memorandos de voz;CONVERSATION pode ser usado para transcrever o diálogo médico-paciente durante a visita ao consultório do paciente.

Tipo: String

Valores válidos: CONVERSATION | DICTATION

Obrigatório: Sim

Sintaxe da resposta

{
   "MedicalTranscriptionJob": { 
      "CompletionTime": number,
      "ContentIdentificationType": "string",
      "CreationTime": number,
      "FailureReason": "string",
      "LanguageCode": "string",
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "MedicalTranscriptionJobName": "string",
      "Settings": { 
         "ChannelIdentification": boolean,
         "MaxAlternatives": number,
         "MaxSpeakerLabels": number,
         "ShowAlternatives": boolean,
         "ShowSpeakerLabels": boolean,
         "VocabularyName": "string"
      },
      "Specialty": "string",
      "StartTime": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Transcript": { 
         "TranscriptFileUri": "string"
      },
      "TranscriptionJobStatus": "string",
      "Type": "string"
   }
}

Elementos de resposta

Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.

Os seguintes dados são retornados no formato JSON pelo serviço.

MedicalTranscriptionJob

Fornece informações detalhadas sobre o trabalho atual de transcrição médica, incluindo o status do trabalho e, se aplicável, o motivo da falha.

Tipo: objeto MedicalTranscriptionJob

Erros

Para obter informações sobre os erros comuns a todas as ações, consulteErros comuns.

BadRequestException

Sua solicitação não passou em um ou mais testes de validação. Isso pode ocorrer quando a entidade que você está tentando excluir não existe ou se está em um estado não terminal (comoIN PROGRESS). Consulte o campo da mensagem de exceção para obter mais informações.

Código de status HTTP: 400

ConflictException

Já existe um recurso com esse nome. Os nomes de recurso devem ser exclusivos dentro de umConta da AWS.

Código de status HTTP: 400

InternalFailureException

Ocorreu um erro interno. Verifique a mensagem de erro, corrija o problema e tente fazer sua solicitação novamente.

Código de status HTTP: 500

LimitExceededException

Você enviou muitas solicitações ou seu arquivo de entrada é muito longo. Espere antes de repetir sua solicitação ou use um arquivo menor e tente novamente.

Código de status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: