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

CreateCallAnalyticsCategory

Cria uma nova categoria de análise de chamadas.

Todas as categorias são aplicadas automaticamente às suas transcrições do Call Analytics. Observe que, para aplicar categorias às suas transcrições, você deve criá-las antes de enviar sua solicitação de transcrição, pois as categorias não podem ser aplicadas retroativamente.

Ao criar uma nova categoria, você pode usar oInputType parâmetro para rotular a categoria como uma categoriaPOST_CALL ou umaREAL_TIME categoria. POST_CALLas categorias só podem ser aplicadas às transcrições pós-chamada e asREAL_TIME categorias só podem ser aplicadas às transcrições em tempo real. Se você não incluirInputType, sua categoria será criada como umaPOST_CALL categoria por padrão.

As categorias de análise de chamadas são compostas por regras. Para cada categoria, você deve criar entre 1 e 20 regras. As regras podem incluir os seguintes parâmetros:InterruptionFilterNonTalkTimeFilterSentimentFilter,,TranscriptFilter e.

Para atualizar uma categoria existente, consulteUpdateCallAnalyticsCategory.

Para saber mais sobre as categorias de análise de chamadas, consulte Criação de categorias para transcrições pós-chamada e Criação de categorias para transcrições em tempo real.

Sintaxe da solicitação

{
   "CategoryName": "string",
   "InputType": "string",
   "Rules": [ 
      { 
         "InterruptionFilter": { 
            "AbsoluteTimeRange": { 
               "EndTime": number,
               "First": number,
               "Last": number,
               "StartTime": number
            },
            "Negate": boolean,
            "ParticipantRole": "string",
            "RelativeTimeRange": { 
               "EndPercentage": number,
               "First": number,
               "Last": number,
               "StartPercentage": number
            },
            "Threshold": number
         },
         "NonTalkTimeFilter": { 
            "AbsoluteTimeRange": { 
               "EndTime": number,
               "First": number,
               "Last": number,
               "StartTime": number
            },
            "Negate": boolean,
            "RelativeTimeRange": { 
               "EndPercentage": number,
               "First": number,
               "Last": number,
               "StartPercentage": number
            },
            "Threshold": number
         },
         "SentimentFilter": { 
            "AbsoluteTimeRange": { 
               "EndTime": number,
               "First": number,
               "Last": number,
               "StartTime": number
            },
            "Negate": boolean,
            "ParticipantRole": "string",
            "RelativeTimeRange": { 
               "EndPercentage": number,
               "First": number,
               "Last": number,
               "StartPercentage": number
            },
            "Sentiments": [ "string" ]
         },
         "TranscriptFilter": { 
            "AbsoluteTimeRange": { 
               "EndTime": number,
               "First": number,
               "Last": number,
               "StartTime": number
            },
            "Negate": boolean,
            "ParticipantRole": "string",
            "RelativeTimeRange": { 
               "EndPercentage": number,
               "First": number,
               "Last": number,
               "StartPercentage": number
            },
            "Targets": [ "string" ],
            "TranscriptFilterType": "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.

CategoryName

Um nome exclusivo, escolhido por você, para sua categoria Call Analytics. É útil usar um sistema de nomenclatura detalhado que fará sentido para você no future. Por exemplo, é melhor usarsentiment-positive-last30seconds para uma categoria em vez de um nome genérico comotest-category.

Os nomes de categoria diferenciam maiúsculas de minúsculas

Tipo: String

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

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

Obrigatório: Sim

InputType

Escolha se você deseja criar uma categoria em tempo real ou pós-chamada para sua transcrição do Call Analytics.

A especificaçãoPOST_CALL atribui sua categoria às transcrições pós-chamada; categorias com esse tipo de entrada não podem ser aplicadas às transcrições de streaming (em tempo real).

A especificaçãoREAL_TIME atribui sua categoria às transcrições de streaming; categorias com esse tipo de entrada não podem ser aplicadas às transcrições pós-chamada.

Se você não incluirInputType, sua categoria será criada como uma categoria pós-chamada por padrão.

Tipo: String

Valores válidos: REAL_TIME | POST_CALL

Obrigatório: não

Rules

As regras definem uma categoria de análise de chamadas. Ao criar uma nova categoria, você deve criar entre 1 e 20 regras para essa categoria. Para cada regra, você especifica um filtro que você deseja aplicar aos atributos de uma chamada. Por exemplo, você pode escolher um filtro de sentimento que detecte se o sentimento de um cliente foi positivo durante os últimos 30 segundos da ligação.

Tipo: matriz de objetos Rule

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

Obrigatório: Sim

Sintaxe da resposta

{
   "CategoryProperties": { 
      "CategoryName": "string",
      "CreateTime": number,
      "InputType": "string",
      "LastUpdateTime": number,
      "Rules": [ 
         { 
            "InterruptionFilter": { 
               "AbsoluteTimeRange": { 
                  "EndTime": number,
                  "First": number,
                  "Last": number,
                  "StartTime": number
               },
               "Negate": boolean,
               "ParticipantRole": "string",
               "RelativeTimeRange": { 
                  "EndPercentage": number,
                  "First": number,
                  "Last": number,
                  "StartPercentage": number
               },
               "Threshold": number
            },
            "NonTalkTimeFilter": { 
               "AbsoluteTimeRange": { 
                  "EndTime": number,
                  "First": number,
                  "Last": number,
                  "StartTime": number
               },
               "Negate": boolean,
               "RelativeTimeRange": { 
                  "EndPercentage": number,
                  "First": number,
                  "Last": number,
                  "StartPercentage": number
               },
               "Threshold": number
            },
            "SentimentFilter": { 
               "AbsoluteTimeRange": { 
                  "EndTime": number,
                  "First": number,
                  "Last": number,
                  "StartTime": number
               },
               "Negate": boolean,
               "ParticipantRole": "string",
               "RelativeTimeRange": { 
                  "EndPercentage": number,
                  "First": number,
                  "Last": number,
                  "StartPercentage": number
               },
               "Sentiments": [ "string" ]
            },
            "TranscriptFilter": { 
               "AbsoluteTimeRange": { 
                  "EndTime": number,
                  "First": number,
                  "Last": number,
                  "StartTime": number
               },
               "Negate": boolean,
               "ParticipantRole": "string",
               "RelativeTimeRange": { 
                  "EndPercentage": number,
                  "First": number,
                  "Last": number,
                  "StartPercentage": number
               },
               "Targets": [ "string" ],
               "TranscriptFilterType": "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.

CategoryProperties

Fornece as propriedades da sua nova categoria, incluindo as regras associadas.

Tipo: objeto CategoryProperties

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 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 a 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: