StartTranscriptionJob - 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á.

StartTranscriptionJob

Transcreve o áudio de um arquivo de mídia e aplica quaisquer parâmetros de solicitação adicionais que você escolher incluir em sua solicitação.

Para fazer umaStartTranscriptionJob 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 Amazon S3 usando oMedia parâmetro.

Você deve incluir os seguintes parâmetros em suaStartTranscriptionJob 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.

  • TranscriptionJobName: 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.

  • Um dosLanguageCodeIdentifyLanguage, ouIdentifyMultipleLanguages: Se você souber o idioma do seu arquivo de mídia, especifique-o usando oLanguageCode parâmetro; você pode encontrar todos os códigos de idioma válidos na tabela Idiomas suportados. Se você não conhece os idiomas falados em sua mídia, use umIdentifyLanguage ouIdentifyMultipleLanguages e deixe que o Amazon Transcribe identifique os idiomas para você.

Sintaxe da solicitação

{
   "ContentRedaction": { 
      "PiiEntityTypes": [ "string" ],
      "RedactionOutput": "string",
      "RedactionType": "string"
   },
   "IdentifyLanguage": boolean,
   "IdentifyMultipleLanguages": boolean,
   "JobExecutionSettings": { 
      "AllowDeferredExecution": boolean,
      "DataAccessRoleArn": "string"
   },
   "KMSEncryptionContext": { 
      "string" : "string" 
   },
   "LanguageCode": "string",
   "LanguageIdSettings": { 
      "string" : { 
         "LanguageModelName": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      }
   },
   "LanguageOptions": [ "string" ],
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "MediaFormat": "string",
   "MediaSampleRateHertz": number,
   "ModelSettings": { 
      "LanguageModelName": "string"
   },
   "OutputBucketName": "string",
   "OutputEncryptionKMSKeyId": "string",
   "OutputKey": "string",
   "Settings": { 
      "ChannelIdentification": boolean,
      "MaxAlternatives": number,
      "MaxSpeakerLabels": number,
      "ShowAlternatives": boolean,
      "ShowSpeakerLabels": boolean,
      "VocabularyFilterMethod": "string",
      "VocabularyFilterName": "string",
      "VocabularyName": "string"
   },
   "Subtitles": { 
      "Formats": [ "string" ],
      "OutputStartIndex": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TranscriptionJobName": "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.

ContentRedaction

Permite redigir ou sinalizar informações de identificação pessoal (PII) (PII) em sua transcrição). Se você usarContentRedaction, também deverá incluir os subparâmetros:PiiEntityTypesRedactionOutput,RedactionType e.

Tipo: objeto ContentRedaction

Obrigatório: não

IdentifyLanguage

Permite a identificação automática do idioma em sua solicitação de trabalho de transcrição. Use esse parâmetro se seu arquivo de mídia contiver somente um idioma. Se sua mídia contiver vários idiomas, useIdentifyMultipleLanguages em vez disso.

Se você incluirIdentifyLanguage, você pode, opcionalmente, incluir uma lista de códigos de idioma, usandoLanguageOptions, que você acha que podem estar presentes em seu arquivo de mídia. LanguageOptionsIncluir restrições somenteIdentifyLanguage às opções de idioma que você especificar, o que pode melhorar a precisão da transcrição.

Se você quiser aplicar um modelo de idioma personalizado, um vocabulário personalizado ou um filtro de vocabulário personalizado à sua solicitação de identificação automática de idioma,LanguageIdSettings inclua os subparâmetros relevantes (VocabularyNameLanguageModelName, eVocabularyFilterName). Se você incluirLanguageIdSettings, inclua tambémLanguageOptions.

Observe que você deve incluir um dosLanguageCodeIdentifyLanguage, ouIdentifyMultipleLanguages em sua solicitação. Se você incluir mais de um desses parâmetros, seu trabalho de transcrição falhará.

Tipo: booliano

Obrigatório: não

IdentifyMultipleLanguages

Permite a identificação automática em vários idiomas em sua solicitação de trabalho de transcrição. Use esse parâmetro se seu arquivo de mídia contiver mais de um idioma. Se sua mídia contiver apenas um idioma, useIdentifyLanguage em vez disso.

Se você incluirIdentifyMultipleLanguages, você pode, opcionalmente, incluir uma lista de códigos de idioma, usandoLanguageOptions, que você acha que podem estar presentes em seu arquivo de mídia. LanguageOptionsIncluir restrições somenteIdentifyLanguage às opções de idioma que você especificar, o que pode melhorar a precisão da transcrição.

Se você quiser aplicar um vocabulário personalizado ou um filtro de vocabulário personalizado à sua solicitação de identificação automática de idioma,LanguageIdSettings inclua os subparâmetros relevantes (VocabularyNameeVocabularyFilterName). Se você incluirLanguageIdSettings, inclua tambémLanguageOptions.

Observe que você deve incluir um dosLanguageCodeIdentifyLanguage, ouIdentifyMultipleLanguages em sua solicitação. Se você incluir mais de um desses parâmetros, seu trabalho de transcrição falhará.

Tipo: booliano

Obrigatório: não

JobExecutionSettings

Permite controlar como seu trabalho de transcrição é processado. Atualmente, a únicaJobExecutionSettings modificação que você pode escolher é habilitar o enfileiramento de trabalhos usando oAllowDeferredExecution subparâmetro.

Se você incluirJobExecutionSettings em sua solicitação, também deverá incluir os subparâmetros:AllowDeferredExecutionDataAccessRoleArn e.

Tipo: objeto JobExecutionSettings

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 contextoAWS KMS de 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.

Se você não tiver certeza do idioma falado em seu arquivo de mídia, considere usarIdentifyLanguage ouIdentifyMultipleLanguages habilitar a identificação automática do idioma.

Observe que você deve incluir um dosLanguageCodeIdentifyLanguage, ouIdentifyMultipleLanguages em sua solicitação. Se você incluir mais de um desses parâmetros, seu trabalho de transcrição falhará.

Para obter uma lista dos idiomas suportados e seus códigos de idioma associados, consulte a tabela de idiomas suportados.

nota

Para transcrever a fala em árabe padrão moderno (ar-SA), seu arquivo de mídia deve ser codificado a uma taxa de amostragem de 16.000 Hz ou superior.

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: não

LanguageIdSettings

Se estiver usando a identificação automática de idioma em sua solicitação e você quiser aplicar um modelo de idioma personalizado, um vocabulário personalizado ou um filtro de vocabulário personalizado,LanguageIdSettings inclua os subparâmetros relevantes (VocabularyNameLanguageModelName, eVocabularyFilterName). Observe que a identificação multilíngue (IdentifyMultipleLanguages) não oferece suporte a modelos de linguagem personalizados.

LanguageIdSettingssuporta códigos de dois a cinco idiomas. Cada código de idioma que você incluir pode ter um modelo de idioma personalizado associado, vocabulário personalizado e filtro de vocabulário personalizado. Os códigos de idioma que você especificar devem corresponder aos idiomas dos modelos de idioma personalizados associados, vocabulários personalizados e filtros de vocabulário personalizados.

É recomendável que você incluaLanguageOptions ao usarLanguageIdSettings para garantir que o dialeto correto do idioma seja identificado. Por exemplo, se você especificar um vocabulário personalizado que está em usoen-US, mas o Amazon Transcribe determina que o idioma falado em sua mídia éen-AU, seu vocabulário personalizado não será aplicado à sua transcrição. Se você incluirLanguageOptions e incluiren-US como único dialeto em inglês, seu vocabulário personalizado será aplicado à sua transcrição.

Se você quiser incluir um modelo de idioma personalizado em sua solicitação, mas não quiser usar a identificação automática de idioma, use o ModelSettings parâmetro com oLanguageModelName subparâmetro. Se você quiser incluir um vocabulário personalizado ou um filtro de vocabulário personalizado (ou ambos) em sua solicitação, mas não quiser usar a identificação automática de idioma, use o Settings parâmetro com o subparâmetroVocabularyName ouVocabularyFilterName (ou ambos).

Tipo: mapa de string paraLanguageIdSettings o objeto

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

Chaves válidas: 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: não

LanguageOptions

Você pode especificar dois ou mais códigos de idioma que representem os idiomas que você acha que podem estar presentes na sua mídia. Incluir mais de cinco não é recomendado. Se você não tiver certeza de quais idiomas estão presentes, não inclua esse parâmetro.

Se você incluirLanguageOptions em sua solicitação, também deverá incluirIdentifyLanguage.

Para obter mais informações, consulte Idiomas suportados.

Para transcrever a fala em árabe padrão moderno (ar-SA), seu arquivo de mídia deve ser codificado a uma taxa de amostragem de 16.000 Hz ou superior.

Tipo: matriz de strings

Membros da matriz: número mínimo de 1 item.

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: não

Media

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

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 a determinará para você. Se você especificar a taxa de amostragem, ela deverá corresponder à taxa detectada pelo Amazon Transcribe. Se houver uma incompatibilidade entre o valor que você especifica e o valor detectado, seu trabalho falhará. Na maioria dos casos, você pode omitirMediaSampleRateHertz e deixar o Amazon Transcribe determinar a taxa de amostragem.

Tipo: inteiro

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

Obrigatório: não

ModelSettings

Especifique o modelo de idioma personalizado que você deseja incluir em seu trabalho de transcrição. Se você incluirModelSettings em sua solicitação, deverá incluir oLanguageModelName subparâmetro.

Para obter mais informações, consulte Modelos de linguagem personalizados.

Tipo: objeto ModelSettings

Obrigatório: não

OutputBucketName

O nome do bucket do Amazon S3 onde você deseja armazenar sua saída de transcrição. 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 especificado. 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.

Se você não especificarOutputBucketName, sua transcrição será colocada em um bucket Amazon S3 gerenciado por serviços e você receberá um URI para acessar sua transcrição.

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: não

OutputEncryptionKMSKeyId

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

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) (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 faz 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 sua tarefa de transcrição (TranscriptionJobName).

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 oTranscriptionJobName, '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 oTranscriptionJobName, '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 suaStartTranscriptionJob solicitação, incluindo identificação de canal, transcrições alternativas e particionamento de alto-falantes. Você pode usar isso para aplicar vocabulários e filtros de vocabulário personalizados.

Se você quiser incluir um vocabulário personalizado ou um filtro de vocabulário personalizado (ou ambos) em sua solicitação, mas não quiser usar a identificação automática de idioma, useSettings com o subparâmetroVocabularyName ouVocabularyFilterName (ou ambos).

Se você estiver usando a identificação automática de idioma com sua solicitação e quiser incluir um modelo de idioma personalizado, um vocabulário personalizado ou um filtro de vocabulário personalizado, use o LanguageIdSettings parâmetro comVocabularyFilterName os subparâmetrosVocabularyName ou.LanguageModelName

Tipo: objeto Settings

Obrigatório: não

Subtitles

Produz arquivos de legenda para sua mídia de entrada. Você pode especificar os formatos WebVTT (*.vtt) e SubRip (*.srt).

Tipo: objeto Subtitles

Obrigatório: não

Tags

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

Para saber mais sobre como usar tags com o Amazon Transcribe, consulte os recursos 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

TranscriptionJobName

Um nome exclusivo, escolhido por você, para seu trabalho de transcrição. 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

Sintaxe da resposta

{
   "TranscriptionJob": { 
      "CompletionTime": number,
      "ContentRedaction": { 
         "PiiEntityTypes": [ "string" ],
         "RedactionOutput": "string",
         "RedactionType": "string"
      },
      "CreationTime": number,
      "FailureReason": "string",
      "IdentifiedLanguageScore": number,
      "IdentifyLanguage": boolean,
      "IdentifyMultipleLanguages": boolean,
      "JobExecutionSettings": { 
         "AllowDeferredExecution": boolean,
         "DataAccessRoleArn": "string"
      },
      "LanguageCode": "string",
      "LanguageCodes": [ 
         { 
            "DurationInSeconds": number,
            "LanguageCode": "string"
         }
      ],
      "LanguageIdSettings": { 
         "string" : { 
            "LanguageModelName": "string",
            "VocabularyFilterName": "string",
            "VocabularyName": "string"
         }
      },
      "LanguageOptions": [ "string" ],
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "ModelSettings": { 
         "LanguageModelName": "string"
      },
      "Settings": { 
         "ChannelIdentification": boolean,
         "MaxAlternatives": number,
         "MaxSpeakerLabels": number,
         "ShowAlternatives": boolean,
         "ShowSpeakerLabels": boolean,
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      },
      "StartTime": number,
      "Subtitles": { 
         "Formats": [ "string" ],
         "OutputStartIndex": number,
         "SubtitleFileUris": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Transcript": { 
         "RedactedTranscriptFileUri": "string",
         "TranscriptFileUri": "string"
      },
      "TranscriptionJobName": "string",
      "TranscriptionJobStatus": "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.

TranscriptionJob

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

Tipo: objeto TranscriptionJob

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 dos recursos devem ser exclusivos em 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: