

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

# StartCallAnalyticsJob
<a name="API_StartCallAnalyticsJob"></a>

Transcreve o áudio de uma chamada de atendimento ao cliente 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 Call Analytics fornece as características da chamada, o resumo da chamada, o sentimento do palestrante e a redação opcional da transcrição do texto e do arquivo de áudio. Você também pode aplicar categorias personalizadas para sinalizar condições especificadas. Para saber mais sobre esses recursos e insights, consulte [Análise do áudio do call center com o Call Analytics](https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html).

Se você quiser aplicar categorias ao seu trabalho de Call Analytics, você deve criá-las antes de enviar sua solicitação de emprego. As categorias não podem ser aplicadas retroativamente a uma vaga. Para criar uma nova categoria, use a[CreateCallAnalyticsCategory](API_CreateCallAnalyticsCategory.md) operação. Para saber mais sobre as categorias de análise de chamadas, consulte [Criação de categorias para transcrições pós-chamada](https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) e [Criação de categorias para transcrições em tempo real](https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html).

Para fazer uma`StartCallAnalyticsJob` 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 o`Media` parâmetro.

Você deve incluir os seguintes parâmetros em sua`StartCallAnalyticsJob` 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](https://docs.aws.amazon.com/general/latest/gr/transcribe.html).
+  `CallAnalyticsJobName`: um nome personalizado que você cria para seu trabalho de transcrição que é exclusivo dentro do seuConta da AWS.
+  `DataAccessRoleArn`: o nome de recurso da Amazon (ARN) de um perfil do IAM que tem permissões para acessar o bucket do Amazon S3 que contém seus arquivos de entrada.
+  `Media`(`MediaFileUri`ou`RedactedMediaFileUri`): a localização do seu arquivo de mídia no Amazon S3.

**nota**  
Com o Call Analytics, você pode editar o áudio contido em seu arquivo de mídia incluindo`RedactedMediaFileUri`, em vez de`MediaFileUri`, especificar a localização do áudio de entrada. Se você optar por redigir seu áudio, poderá encontrar sua mídia editada no local especificado no`RedactedMediaFileUri` campo de sua resposta.

## Sintaxe da solicitação
<a name="API_StartCallAnalyticsJob_RequestSyntax"></a>

```
{
   "CallAnalyticsJobName": "string",
   "ChannelDefinitions": [ 
      { 
         "ChannelId": number,
         "ParticipantRole": "string"
      }
   ],
   "DataAccessRoleArn": "string",
   "Media": { 
      "MediaFileUri": "string",
      "RedactedMediaFileUri": "string"
   },
   "OutputEncryptionKMSKeyId": "string",
   "OutputLocation": "string",
   "Settings": { 
      "ContentRedaction": { 
         "PiiEntityTypes": [ "string" ],
         "RedactionOutput": "string",
         "RedactionType": "string"
      },
      "LanguageIdSettings": { 
         "string" : { 
            "LanguageModelName": "string",
            "VocabularyFilterName": "string",
            "VocabularyName": "string"
         }
      },
      "LanguageModelName": "string",
      "LanguageOptions": [ "string" ],
      "VocabularyFilterMethod": "string",
      "VocabularyFilterName": "string",
      "VocabularyName": "string"
   }
}
```

## Parâmetros de solicitação
<a name="API_StartCallAnalyticsJob_RequestParameters"></a>

Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

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

 ** [CallAnalyticsJobName](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-CallAnalyticsJobName"></a>
Um nome exclusivo, escolhido por você, para seu trabalho de Call Analytics.  
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á um`ConflictException` 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

 ** [ChannelDefinitions](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-ChannelDefinitions"></a>
Permite especificar qual alto-falante está em qual canal. Por exemplo, se seu agente for o primeiro participante a falar, você configuraria`ChannelId` para`0` (para indicar o primeiro canal) e`ParticipantRole` para`AGENT` (para indicar que é o agente falando).  
Tipo: matriz de objetos [ChannelDefinition](API_ChannelDefinition.md)  
Membros da matriz: número fixo de 2 itens.  
Obrigatório: não

 ** [DataAccessRoleArn](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-DataAccessRoleArn"></a>
O nome de recurso da Amazon (ARN) de um perfil do IAM que tem permissões para acessar o bucket do Amazon S3 que contém seus arquivos de entrada. Se a função especificada não tiver as permissões apropriadas para acessar o local especificado do Amazon S3, sua solicitação falhará.  
Os ARNs da função IAM têm o formato`arn:partition:iam::account:role/role-name-with-path`. Por exemplo: `arn:aws:iam::111122223333:role/Admin`.  
Para obter mais informações, consulte [ARNs do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).  
Tipo: String  
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2048.  
Padrão: `^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$`   
Obrigatório: não

 ** [Media](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-Media"></a>
Descreve a localização do arquivo de mídia no Amazon S3 que você deseja usar em sua solicitação de Call Analytics.  
Tipo: objeto [Media](API_Media.md)  
Obrigatório: Sim

 ** [OutputEncryptionKMSKeyId](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-OutputEncryptionKMSKeyId"></a>
A chave do KMS que você deseja usar para criptografar sua saída do Call Analytics.  
Se estiver usando uma chave localizada na **atual**Conta 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`.

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

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

1. 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`.

1. 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 (SSE-KMS).  
Se você especificar uma chave KMS para criptografar sua saída, também deverá especificar um local de saída usando o`OutputLocation` parâmetro.  
Observe que a função que faz a[StartCallAnalyticsJob](#API_StartCallAnalyticsJob) 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

 ** [OutputLocation](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-OutputLocation"></a>
O local do Amazon S3 em que você deseja que a saída da transcrição do Call Analytics. Você pode usar qualquer um dos seguintes formatos para especificar o local de saída:  

1. s3://DOC-EXAMPLE-BUCKET

1. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

1. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
A menos que você especifique um nome de arquivo (opção 3), o nome do seu arquivo de saída tem um valor padrão que corresponde ao nome que você especificou para o trabalho de transcrição usando o`CallAnalyticsJobName` parâmetro.  
Você pode especificar uma chave KMS para criptografar sua saída usando o`OutputEncryptionKMSKeyId` parâmetro. Se você não especificar uma chave do KMS, o Amazon Transcribe usa a chave do Amazon S3 para a chave do Amazon S3.  
Se você não especificar`OutputLocation`, 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 tamanho: tamanho mínimo 1. Tamanho máximo de 2000.  
Padrão: `(s3://|http(s*)://).+`   
Obrigatório: não

 ** [Settings](#API_StartCallAnalyticsJob_RequestSyntax) **   <a name="transcribe-StartCallAnalyticsJob-request-Settings"></a>
Especifique configurações opcionais adicionais em sua[StartCallAnalyticsJob](#API_StartCallAnalyticsJob) solicitação, incluindo redação de conteúdo; permite que você aplique modelos de linguagem personalizados, filtros de vocabulário e vocabulários personalizados ao seu trabalho de Análise de Chamadas.  
Tipo: objeto [CallAnalyticsJobSettings](API_CallAnalyticsJobSettings.md)  
Obrigatório: não

## Sintaxe da resposta
<a name="API_StartCallAnalyticsJob_ResponseSyntax"></a>

```
{
   "CallAnalyticsJob": { 
      "CallAnalyticsJobName": "string",
      "CallAnalyticsJobStatus": "string",
      "ChannelDefinitions": [ 
         { 
            "ChannelId": number,
            "ParticipantRole": "string"
         }
      ],
      "CompletionTime": number,
      "CreationTime": number,
      "DataAccessRoleArn": "string",
      "FailureReason": "string",
      "IdentifiedLanguageScore": number,
      "LanguageCode": "string",
      "Media": { 
         "MediaFileUri": "string",
         "RedactedMediaFileUri": "string"
      },
      "MediaFormat": "string",
      "MediaSampleRateHertz": number,
      "Settings": { 
         "ContentRedaction": { 
            "PiiEntityTypes": [ "string" ],
            "RedactionOutput": "string",
            "RedactionType": "string"
         },
         "LanguageIdSettings": { 
            "string" : { 
               "LanguageModelName": "string",
               "VocabularyFilterName": "string",
               "VocabularyName": "string"
            }
         },
         "LanguageModelName": "string",
         "LanguageOptions": [ "string" ],
         "VocabularyFilterMethod": "string",
         "VocabularyFilterName": "string",
         "VocabularyName": "string"
      },
      "StartTime": number,
      "Transcript": { 
         "RedactedTranscriptFileUri": "string",
         "TranscriptFileUri": "string"
      }
   }
}
```

## Elementos de resposta
<a name="API_StartCallAnalyticsJob_ResponseElements"></a>

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.

 ** [CallAnalyticsJob](#API_StartCallAnalyticsJob_ResponseSyntax) **   <a name="transcribe-StartCallAnalyticsJob-response-CallAnalyticsJob"></a>
Fornece informações detalhadas sobre o trabalho atual do Call Analytics, incluindo o status do trabalho e, se aplicável, o motivo da falha.  
Tipo: objeto [CallAnalyticsJob](API_CallAnalyticsJob.md)

## Erros
<a name="API_StartCallAnalyticsJob_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte[Erros comuns](CommonErrors.md).

 ** 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 (como`IN 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 umaConta da AWS.  
Código de status HTTP: 400

 ** InternalFailureException **   
Ocorreu um erro interno. Verifique a mensagem de erro, corrija o problema e tente 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
<a name="API_StartCallAnalyticsJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+  [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWSSDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/StartCallAnalyticsJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transcribe-2017-10-26/StartCallAnalyticsJob) 