APIs de atributos calculados - Amazon Connect

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

APIs de atributos calculados

É possível usar as seguintes APIs de atributos calculados do Customer Profiles:

CreateCalculatedAttributeDefinition

CreateCalculatedAttributeDefinition

Crie um novo atributo calculado. Isso requer um tipo de objeto existente no domínio. Você pode definir os atributos que deseja extrair de um único objeto de origem e as operações matemáticas a serem aplicadas a eles de forma agregada, bem como o intervalo de tempo e a contagem de objetos.

Após a criação, novos dados de objetos ingeridos no Customer Profiles serão incluídos no atributo calculado, que pode ser recuperado para um perfil usando a API GetCalculatedAttributeForProfile. A definição de um atributo calculado o disponibiliza para todos os perfis em um domínio. Cada atributo calculado só pode referenciar um ObjectType e no máximo dois campos a partir desse campo ObjectType.

Solicitação

POST /domains/DomainName/calculated-attributes/CalculatedAttributeName
                            

{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE",
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
     },
     "Tags": {}
}

Resposta


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Corpo da solicitação

  • CalculatedAttributeName

    O nome exclusivo (por domínio) do atributo calculado.

    • Tipo: String

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

  • DisplayName

    O nome de exibição do atributo calculado.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Obrigatório: Não

  • Descrição

    A descrição do atributo calculado.

    • Tipo: String

    • Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.000.

    • Obrigatório: Não

  • AttributeDetails

    Detalhes dos atributos usados na definição e das operações matemáticas envolvidas entre os atributos. Consulte os seguintes componentes:

    • Atributos.

      Uma lista de itens de atributos especificados na expressão matemática.

      • AttributeItem

        Os detalhes de um item de atributo especificado na expressão matemática.

        • Nome

          • O nome de um atributo definido em um tipo de objeto de perfil.

          • Tipo: string

    • Expressão

      Expressão matemática executada em itens de atributos fornecidos na lista de atributos. Cada elemento na expressão deve seguir a estrutura de\ "{ObjectTypeName. AttributeName}\”.

      • Exemplo: {ObjA.AttributeA} - {ObjA.AttributeB}

      • Tipo: String

      • Só oferecemos suporte às seguintes operações matemáticas: + - * /

      • Você não poderá fazer modificações na expressão depois que uma definição de atributo calculado for criada

  • Condições

    Define os critérios e o limite calculados da agregação de atributos.

    • Tipo: objeto Conditions

      • Intervalo

      • ObjectCount

      • Limite

  • Intervalo

    O período de tempo relativo durante o qual os dados são incluídos na agregação.

    • Tipo: objeto Range

      • Valor: o período das unidades especificadas

      • Unidade: unidade de tempo

        • Valores válidos: dias

    • Obrigatório: Sim

    • Escopo inicial: máximo de 366 dias

  • ObjectCount

    O número de objetos de perfil usados para o atributo calculado.

    • Tipo: número

    • Alcance: de 1 a 100

    • Obrigatório: Não

  • Limite

    A lógica de comparação para gerar um atributo calculado verdadeiro/falso.

    • Tipo: objeto Threshold

      • Valor

        • O valor do limite.

        • Tipo: string

        • Obrigatório: Não

      • Operador

        • O operador do limite

        • Tipo: ENUM

        • Valores válidos:

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NOT_EQUAL_TO

    • Obrigatório: Não

  • Estatística

    A operação de agregação a ser executada para o atributo calculado.

    • Tipo: ENUM

    • Valores válidos:

      • FIRST_OCCURRENCE

      • LAST_OCCURRENCE

      • CONTAGEM

      • SUM

      • MINIMUM

      • MAXIMUM

      • AVERAGE

      • MAX_OCCURRENCE

UpdateCalculatedAttributeDefinition

UpdateCalculatedAttributeDefinition

Atualizar uma definição de atributo calculado. As atualizações estão limitadas ao nome de exibição, descrição, intervalo de tempo, contagem de objetos e limite. Essa API oferece suporte a atualizações parciais, portanto, somente os parâmetros que exigem atualização precisam ser incluídos.

Ao atualizar as condições, observe que aumentar o intervalo de datas de um atributo calculado não acionará a inclusão de dados históricos maiores que o intervalo de datas atual.

Solicitação

PUT /domains/DomainName/calculated-attributes/CalculatedAttributeName
                            

{
    "DisplayName": "string",
    "Description": "string",
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
   }
}

Resposta


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Corpo da solicitação

  • DisplayName

    O nome de exibição do atributo calculado.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

    • Obrigatório: Não

  • Descrição

    A descrição do atributo calculado.

    • Tipo: String

    • Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.000.

    • Obrigatório: Não

  • Condições

    Define os critérios e o limite calculados da agregação de atributos.

    • Tipo: objeto Conditions

      • Intervalo

      • ObjectCount

      • Limite

  • Intervalo

    O período de tempo relativo durante o qual os dados são incluídos na agregação.

    • Tipo: objeto Range

      • Valor: o período das unidades especificadas

      • Unidade: unidade de tempo

        • Valores válidos: dias

    • Obrigatório: Sim

    • Escopo inicial: máximo de 366 dias

  • ObjectCount

    O número de objetos de perfil usados para o atributo calculado.

    • Tipo: número

    • Alcance: de 1 a 100

    • Obrigatório: Não

  • Limite

    A lógica de comparação para gerar um atributo calculado verdadeiro/falso.

    • Tipo: objeto Threshold

      • Valor

        • O valor do limite.

        • Tipo: string

        • Obrigatório: Não

      • Operador

        • O operador do limite

        • Tipo: ENUM

        • Valores válidos:

          • GREATER_THAN

          • LESS_THAN

          • EQUAL_TO

          • NOT_EQUAL_TO

    • Obrigatório: Não

GetCalculatedAttributeDefinition

GetCalculatedAttributeDefinition

Recupere uma definição de atributo calculado.

Solicitação

GET /domains/DomainName/calculated-attributes/CalculatedAttributeName

Corpo da solicitação

The request does not have a request body.

Resposta


{
    "CalculatedAttributeName": "string",
    "DisplayName": "string",
    "Description": "string",
    "AttributeDetails": {
       "Attributes": [
           {
               "Name": "string"
           }
           ...
       ],
       "Expression": "string",
    },
    "Statistic": "AVERAGE" | "COUNT" | "SUM" | "FIRST_OCCURRENCE" | "LAST_OCCURRENCE" | "MINIMUM" | "MAXIMUM" | "MAX_OCCURRENCE"
    "Conditions": {
        "Range": {
             "Value": "number",
             "Units": "string"
        },
        "ObjectCount": "number",
        "Threshold": {
            "Value": "string",
            "Operator": "EQUAL_TO" | "GREATER_THAN" | "LESS_THAN" | "NOT_EQUAL_TO"
        }
    },
    "CreatedAt": number,
    "LastUpdatedAt": number,
    "Tags": {}
}

Parâmetros de solicitação de URI

  • DomainName

    O nome exclusivo do domínio.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

  • CalculatedAttributeName

    O nome exclusivo (por domínio) do atributo calculado.

    • Tipo: String

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

DeleteCalculatedAttributeDefinition

DeleteCalculatedAttributeDefinition

Exclua uma definição de atributo calculado existente. Observe que é possível excluir um atributo calculado padrão. No entanto, uma vez excluído, você não poderá desfazer essa ação e precisará recriá-la sozinho usando a API CreateCalculatedAttributeDefinition se quiser recuperá-la.

Solicitação

DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName

Corpo da solicitação

The request does not have a request body.

Resposta

The response does not have a response body.

Parâmetros de solicitação de URI

  • DomainName

    O nome exclusivo do domínio.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

  • CalculatedAttributeName

    O nome exclusivo (por domínio) do atributo calculado.

    • Tipo: String

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

ListCalculatedAttributeDefinitions

ListCalculatedAttributeDefinitions

Recupere todas as definições de atributos calculados para um domínio.

Solicitação

GET /domains/DomainName/calculated-attributes?max-results=MaxResults&next-token=NextToken

Corpo da solicitação

The request does not have a request body.

Resposta


{
    "Items": [
        {
            "CalculatedAttributeName": "string",
            "DisplayName": "string",
            "Description": "string",
            "CreatedAt": "timestamp",
            "LastUpdatedAt": "timestamp"
        },
        ...
    ],
    "NextToken": "string"
}

Parâmetros de solicitação de URI

  • DomainName

    O nome exclusivo do domínio.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

  • MaxResults

    O número máximo de objetos retornados por página.

    • Faixa válida: valor mínimo de 1. Valor máximo de 100

  • NextToken

    O token de paginação da chamada de ListCalculatedAttributeDefinition API anterior.

    • Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.024

GetCalculatedAttributeForProfile

GetCalculatedAttributeForProfile

Inicia o cálculo e recupera o resultado de um único atributo calculado para um único perfil.

Solicitação

GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName

Corpo da solicitação

The request does not have a request body.

Resposta


{
    "Name": "string",
    "DisplayName": "string",
    "Value": "string",
    "IsDataPatrial": "string"
}

Parâmetros de solicitação de URI

  • DomainName

    O nome exclusivo do domínio.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

  • CalculatedAttributeName

    O nome exclusivo (por domínio) do atributo calculado.

    • Tipo: String

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

ListCalculatedAttributesForProfile

ListCalculatedAttributesForProfile

Inicia o cálculo e recupera os resultados de um único atributo calculado para um único perfil.

Solicitação

GET /domains/DomainName/profile/ProfileId/calculated-attributes?max-results=MaxResults&next-token=NextToken

Corpo da solicitação

The request does not have a request body.

Resposta


{
    "Items": [
        {
            "CalculatedAttributeName": "string",
            "DisplayName": "string",
            "Value": "string",
            "IsDataPartial" : "string"
        },
        ...
    ],
    "NextToken": "string"
}

Parâmetros de solicitação de URI

  • DomainName

    O nome exclusivo do domínio.

    • Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.

    • Padrão: ^[a-zA-Z0-9_-]+$

    • Exigido: Sim

  • ProfileId

    • Padrão: [a-f0-9]{32}

    • Exigido: Sim

  • MaxResults

    O número máximo de objetos retornados por página.

    • Faixa válida: valor mínimo de 1. Valor máximo de 100

  • NextToken

    O token de paginação da chamada de ListCalculatedAttributeDefinition API anterior.

    • Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 1.024