PredictabilityEstimateVersion - Global

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 5 min. de leitura

    • A API PredictabilityEstimateVersion é um objeto programável usado em armazenamentos Inteligência preditiva.

    Este A API requer o plug-in Inteligência preditiva (com.glide.platform_ml) e é fornecida no namespace sn_ml.

    Use esta API ao trabalhar com versões de estimativa de previsibilidade com base em objetos da API PredictabilityEstimate no armazenamento PredictabilityEstimate.

    O sistema ativa a versão mais recente da estimativa de previsibilidade ao concluir o treinamento e permite que apenas uma versão esteja ativa por vez. No entanto, você pode ativar qualquer versão treinada anteriormente que deseja usar para fazer previsões.

    Os métodos nesta API podem ser acessados usando os seguintes métodos PredictabiltyEstimate :

    PredictabilityEstimateVersion - getProperties()

    Obtém as propriedades do objeto de estimativa de previsibilidade e número da versão.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    Objeto Conteúdos dos detalhes da versão do Dataset e PredictabilityEstimate. Os resultados variam de acordo com a configuração da propriedade do objeto.
    {
  "datasetProperties": {Object},
  "domainName": "String", 
  "inputFieldNames": [Array],
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "scope": "String",
  "trainingFrequency": "String",
  "versionNumber": "Number"
}
    <Object>.datasetProperties

    Lista as propriedades do objeto DatasetDefinition() associado à estimativa de previsibilidade.

    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Tipo de dados: objeto.
    <Object>.datasetProperties.tableName Nome da tabela para o conjunto de dados. Por exemplo, "tableName" : "Incidente".

    Tipo de dados: cadeia de caracteres.
    <Object>.datasetProperties.fieldNomes Lista de nomes de campo da tabela especificada como cadeias de caracteres. Por exemplo, "fieldNames" : ["short_description", "priority"].

    Tipo de dados: matriz.
    <Object>.datasetProperties.fieldNames.fieldDetails Lista de objetos JavaScript que especificam propriedades de campo. 
    [
  {
    "name": "String",
    "type": "String"
  }
]

    Tipo de dados: matriz.
    <Object>.datasetProperties.fieldNames.fieldDetails.<object>.nome Nome do campo que define o tipo de informação ao qual este conjunto de dados será restrito.

    Tipo de dados: cadeia de caracteres.
    <Object>.datasetProperties.fieldDetails.<object>.type Tipo de campo de aprendizado de máquina.

    Tipo de dados: cadeia de caracteres.
    <Object>.datasetProperties.fieldDetails.encodedQuery Cadeia de caracteres de consulta codificada no formato Glide padrão. Consulte Cadeias de caracteres de consulta codificadas.

    Tipo de dados: cadeia de caracteres.
    <Object>.domainName Nome do domínio associado a este conjunto de dados. Consulte Separação de domínios e Inteligência preditiva.

    Tipo de dados: cadeia de caracteres.
    <Object>.inputFieldNames Lista de campos de entrada de candidatos como cadeias de caracteres a serem consideradas para estimativa.

    Tipo de dados: cadeia de caracteres.
    <Object>.isActive Sinalizador que indica se esta versão está ativa.
    Valores válidos:
    • verdadeiro: a versão está ativa.
    • falso: a versão não está ativa.

    Tipo de dados: cadeia de caracteres
    <Object>.rótulo Identifica a tarefa de previsão. 
    {
  "label": "my first prediction"
}

    Tipo de dados: cadeia de caracteres.
    <Object>.nome Nome atribuído pelo sistema.

    Tipo de dados: cadeia de caracteres.
    <Object>.predictedFieldName Identifica um campo a ser treinado para previsibilidade.

    Tipo de dados: cadeia de caracteres.
    <Object>.escopo Escopo do objeto. Atualmente, o único valor válido é global.

    Tipo de dados: cadeia de caracteres
    <Object>.trainingFrequency A frequência para retreinar o modelo.
    Valores possíveis:
    • a cada_30_dias
    • a cada_60_dias
    • a cada_90_dias
    • a cada_120_dias
    • a cada_180_dias
    • run_once
    Padrão: run_once

    Tipo de dados: cadeia de caracteres.
    <Object>.versionNumber Objeto Número da versão do PredictabilityEstimate.

    Tipo de dados: cadeia de caracteres.

    O exemplo a seguir obtém propriedades da versão do objeto ativo no armazenamento.

    // Get properties
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getProperties()), null, 2));

    Saída:

    "datasetProperties": {
    "encodedQuery": "activeANYTHING^EQ",
    "fieldNames": [
      "short_description",
      "category"
    ],
    "tableName": "incident"
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "isActive": "true",
  "label": "Incident Categorization_Trainer",
  "name": "ml_incident_categorization",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

    PredictabilityEstimateVersion - getResults()

    Retorna resultados JSON contendo campos de entrada sugeridos para um campo de saída.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Objeto Resultados de objeto JSON que contêm opções de campo de entrada sugeridas para um campo de saída.
    <Object>.<output field name> Nome do campo de saída, por exemplo, categoria, que contém campos de entrada sugeridos.
    {
  "<output field name>": {
    "nominalInputFields": [Array],
    "textInputFields": [Array]
  }
}

    Tipo de dados: objeto
    <Object>.<output field name>.nominalInputFields Detalhes do campo de entrada nominal.
    "nominalInputFields": [
      {
        "fieldName": "String",
        "modelImprovement": "String"     
      }
    ]

    Tipo de dados: matriz.
    <Object>.<output field name>.nominalInputFields.fieldName Nome do campo de entrada nominal.

    Tipo de dados: cadeia de caracteres.
    <Object>.<output field name>.nominalInputFields.modelImprovement Pontuação como uma indicação relativa da probabilidade deste campo melhorar os resultados.

    Tipo de dados: número como uma cadeia de caracteres.
    <Object>.textInputFields Detalhes do campo de entrada de texto.
    
    "textInputFields": [
      {
        "fieldName": "String",
        "density": "String"
      }
    ]

    Tipo de dados: matriz.
    <Object>.textInputFields.fieldName Nome do campo de entrada de texto.

    Tipo de dados: cadeia de caracteres.
    <Object>.textInputFields.densidade Valor entre 0 e 1,0 que representa a frequência em que o campo não está vazio. Um valor de 1.0 significa que o campo não está vazio em todas as linhas e um valor de 0 indica que o campo está vazio em todas as linhas.

    Tipo de dados: número como uma cadeia de caracteres.

    O exemplo a seguir mostra como obter resultados para uma versão selecionada de uma estimativa de previsibilidade na loja.

    // Get results
var estimateName = "ml_x_snc_global_global_predictability_estimate;"
var mlEstimate = sn_ml.PredictabilityEstimateStore.get(estimateName);

var results = mlEstimate.getActiveVersion().getResults();

gs.print(JSON.stringify(JSON.parse(results), null, 2));

    Saída:

    {
  "category": {
    "nominalInputFields": [
      {
        "fieldName": "number",
        "modelImprovement": "0.167052396325189"
      },
      {
        "fieldName": "task_effective_number",
        "modelImprovement": "0.167052396325189"
      }
    ],
    "textInputFields": [
      {
        "fieldName": "short_description",
        "density": "1.0"
      }
    ]
  }
}

    PredictabilityEstimateVersion - getStatus(Boolean includeDetails)

    Obtém o status de conclusão do treinamento.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    includeDetails Booliano Sinalizador que indica se o status deve ser retornado details.
    Valores válidos:
    • verdadeiro: retorna detalhes adicionais.
    • falso: não retorna detalhes adicionais.

    Padrão: falso
    Tabela 6. Retornos
    Tipo Descrição
    Objeto Objeto JavaScript que contém informações de status de treinamento para um objeto PredictabilityEstimate.
    {
  "state": "String",
  "percentComplete": "Number as a String",
  "hasJobEnded": "Boolean value as a String",
  "details": {Object}
}
    <Object>.estado Estado de conclusão do treinamento. Se o trabalho de treinamento atingir um estado terminal, o trabalho não sairá desse estado. Se o estado for terminal, a propriedade hasJobEnded será definida como verdadeira.
    Valores possíveis:
    • buscando_arquivos_para_treinamento
    • preparação_dados
    • tentar novamente
    • solution_cancelled (terminal)
    • solution_complete (terminal)
    • solution_error (terminal)
    • solução_incompleta
    • treinamento_request_recebido
    • treinamento_request_timed_out (terminal)
    • solução_treinamento
    • carregando_solução
    • aguardando_treinamento

    Tipo de dados: cadeia de caracteres
    <Object>.hasJobEnded Sinalizador que indica se o treinamento foi concluído.
    Valores válidos:
    • verdadeiro: o treinamento está concluído.
    • falso: o treinamento está incompleto.

    Tipo de dados: valor booliano como cadeia de caracteres
    <Object>.percentConcluído Percentual de treinamento concluído. Se a porcentagem de conclusão for inferior a 100, o trabalho poderá estar em um estado terminal. Por exemplo, se o treinamento expirar.

    Tipo de dados: número como cadeia de caracteres

    Intervalo: 0 a 100
    <Object>.detalhes Objeto que contém uma lista de detalhes de treinamento adicionais.

    Tipo de dados: objeto

    O exemplo a seguir mostra um resultado bem-sucedido com o treinamento concluído.

    // Get status
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getStatus(true), null, 2)));

    Saída:

    {
 "state":"solution_complete",
 "percentComplete":"100",
 "hasJobEnded":"true",
 "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);
}

    O exemplo a seguir mostra um resultado malsucedido com o treinamento concluído.

    // Get status
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_my_estimate_definition');
var trainingStatus = mlEstimate.getLatestVersion().getStatus();

gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));

    Saída:

    {
  "state": "solution_complete",
  "percentComplete": "100",
  "hasJobEnded": "true"
}

    PredictabilityEstimateVersion - getVersionNumber()

    Obtém o número da versão de um objeto de estimativa de previsibilidade.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres Número da versão.

    O exemplo a seguir mostra como obter um número de versão.

    // Get version number
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

gs.print("Version number: "+JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getVersionNumber()), null, 2));

    Saída:

    Version number: 1