StartCallAnalyticsJob

Transcribe el audio de una llamada de servicio al cliente y aplica cualquier parámetro de solicitud adicional que elija incluir en su solicitud.

Además de muchas funciones de transcripción estándar, Call Analytics le proporciona las características de las llamadas, el resumen de las llamadas, las opiniones de los oradores y la redacción opcional de la transcripción del texto y el archivo de audio. También puede aplicar categorías personalizadas para marcar condiciones especificadas. Para obtener más información sobre estas funciones e información, consulte Analizar el audio del centro de llamadas con Call Analytics.

Si quieres aplicar categorías a tu trabajo de Call Analytics, debes crearlas antes de enviar tu solicitud de trabajo. Las categorías no se pueden aplicar retroactivamente a un trabajo. Para crear una nueva categoría, utilice laCreateCallAnalyticsCategory operación. Para obtener más información sobre las categorías de análisis de llamadas, consulte Creación de categorías para transcripciones posteriores a la llamada y Creación de categorías para transcripciones en tiempo real.

Para realizar unaStartCallAnalyticsJob solicitud, primero debe cargar el archivo multimedia en un bucket de Amazon S3; a continuación, puede especificar la ubicación del archivo en Amazon S3 mediante elMedia parámetro.

Debe incluir los siguientes parámetros en suStartCallAnalyticsJob solicitud:

• region: ElRegión de AWS lugar donde realiza su solicitud. Para obtener una lista de lasRegiones de AWS opciones compatibles con Amazon Transcribe, consulte los puntos de conexión y cuotas de Amazon Transcribe.

• CallAnalyticsJobName: un nombre personalizado que creas para tu trabajo de transcripción y que es único dentro de tuCuenta de AWS.

• DataAccessRoleArn: Nombre de recurso de Amazon (ARN) de un rol de IAM que tiene permisos para acceder al bucket de Amazon S3 que contiene los archivos de entrada.

• Media(MediaFileUrioRedactedMediaFileUri): la ubicación de Amazon S3 de su archivo multimedia.

nota

Con Call Analytics, puede editar el audio contenido en su archivo multimedia incluyendoRedactedMediaFileUri, en lugar deMediaFileUri, especificar la ubicación del audio de entrada. Si eliges censurar el audio, puedes encontrar el contenido multimedia redactado en la ubicación especificada en elRedactedMediaFileUri campo de tu respuesta.

Sintaxis de la solicitud

{
   "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 solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

CallAnalyticsJobName

Un nombre único, elegido por usted, para su trabajo de Call Analytics.

Este nombre distingue entre mayúsculas y minúsculas, no puede contener espacios y debe ser único dentro de unCuenta de AWS. Si intenta crear un trabajo nuevo con el mismo nombre que un trabajo existente,ConflictException aparece un error.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 200 caracteres.

Patrón: ^[0-9a-zA-Z._-]+

Obligatorio: sí

ChannelDefinitions

Permite especificar qué altavoz está en cada canal. Por ejemplo, si tu agente es el primer participante en hablar, debes configurar en0 (ChannelIdpara indicar el primer canal) y enAGENT (ParticipantRolepara indicar que es el agente el que habla).

Tipo: Matriz de objetos ChannelDefinition

Miembros de la matriz: número fijo de 2 elementos.

Obligatorio: no

DataAccessRoleArn

Nombre de recurso de Amazon (ARN) de un rol de IAM que tiene permisos para acceder al bucket de Amazon S3 que contiene los archivos de entrada. Si el rol que especificas no tiene los permisos adecuados para acceder a la ubicación de Amazon S3 especificada, se producirá un error en tu solicitud.

Los ARN del rol de IAM tienen el formatoarn:partition:iam::account:role/role-name-with-path. Por ejemplo: arn:aws:iam::111122223333:role/Admin.

Para obtener más información, consulte ARN de IAM.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.

Patrón: ^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}$

Obligatorio: no

Media

Describe la ubicación de Amazon S3 del archivo multimedia que desea usar en su solicitud de Call Analytics.

Tipo: objeto Media

Obligatorio: sí

OutputEncryptionKMSKeyId

La clave KMS que desea utilizar para cifrar la salida de Call Analytics.

Si utiliza una clave ubicada en la actualCuenta de AWS, puede especificar su clave de KMS de una de las cuatro maneras siguientes:

1. Utilice el identificador de clave de KMS propiamente dicho. Por ejemplo, 1234abcd-12ab-34cd-56ef-1234567890ab.

2. Utilice un alias para el ID de la clave KMS. Por ejemplo, alias/ExampleAlias.

3. El nombre de recurso de Amazon (ARN) como ID de la clave de Amazon (ARN) como ID de la clave de Amazon (ARN) Por ejemplo, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

4. Para el ARN de la clave KMS. Por ejemplo, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Si usa una clave ubicada en una ubicación Cuenta de AWSdiferente a la actualCuenta de AWS, puede especificar su clave de KMS de dos maneras:

1. Utilice el ARN para el ID de clave de KMS. Por ejemplo, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

2. Para el ARN de la clave KMS. Por ejemplo, arn:aws:kms:region:account-ID:alias/ExampleAlias.

Si no se especifica una clave de cifrado, la salida se cifrará con la clave de Amazon S3 SSE-SSE-SSE-SSE-SSE-SSE-SSE-S3).

Si especifica una clave de KMS para cifrar la salida, también debe especificar una ubicación de salida mediante elOutputLocation parámetro.

Tenga en cuenta que el rol que realiza laStartCallAnalyticsJob solicitud debe tener permiso para utilizar la clave KMS especificada.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$

Obligatorio: no

OutputLocation

Ubicación de Amazon S3 donde desea almacenar el resultado de la transcripción de Call Analytics. Puede utilizar cualquiera de los siguientes formatos para especificar la ubicación de salida:

1. s3://DOC-EXAMPLE-BUCKET

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

3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

A menos que especifique un nombre de archivo (opción 3), el nombre del archivo de salida tiene un valor predeterminado que coincide con el nombre que especificó para el trabajo de transcripción mediante elCallAnalyticsJobName parámetro.

Puede especificar una clave de KMS para cifrar la salida mediante elOutputEncryptionKMSKeyId parámetro. Si no se especifica una clave KMS, Amazon Transcribe utiliza la clave de Amazon S3 para el cifrado del lado del servidor.

Si no lo especificasOutputLocation, la transcripción se coloca en un bucket de Amazon S3 gestionado por el servicio y se te proporciona un URI para acceder a la transcripción.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima de 2000 caracteres.

Patrón: (s3://|http(s*)://).+

Obligatorio: no

Settings

Especifique ajustes opcionales adicionales en suStartCallAnalyticsJob solicitud, incluida la redacción del contenido; le permite aplicar modelos de idioma personalizados, filtros de vocabulario y vocabularios personalizados a su trabajo de Call Analytics.

Tipo: objeto CallAnalyticsJobSettings

Obligatorio: no

Sintaxis de la respuesta

{
   "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 respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CallAnalyticsJob

Proporciona información detallada sobre el trabajo actual de Call Analytics, incluido el estado del trabajo y, si corresponde, el motivo del error.

Tipo: objeto CallAnalyticsJob

Errores

Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.

BadRequestException

Tu solicitud no ha superado una o más pruebas de validación. Esto puede ocurrir cuando la entidad que intentas eliminar no existe o si se encuentra en un estado no terminal (por ejemploIN PROGRESS). Para obtener más información información, consulte el campo de mensaje de excepción para obtener más información, consulte

Código de estado HTTP: 400

ConflictException

Ya existe un recurso con este nombre. Los nombres de recurso deben ser únicos dentro de unCuenta de AWS.

Código de estado HTTP: 400

InternalFailureException

Error interno del motor. Compruebe el mensaje de error, corrija el problema y vuelva a intentar realizar la solicitud de error, corrija el problema y vuelva a realizar la solicitud.

Código de estado HTTP: 500

LimitExceededException

Has enviado demasiadas solicitudes o tu archivo de entrada es demasiado largo. Espere antes de volver a intentar la solicitud o utilice un archivo más pequeño y vuelva a intentarlo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:

• AWS Command Line Interface

• SDK de AWS para .NET

• AWS SDK para C++

• AWS SDK para Go

• AWS SDK para Java V2

• AWSSDK para JavaScript

• SDK de AWS para PHP V3

• SDK de AWS para Python

• SDK de AWS para Ruby V3