PredicabilityEstimate - Global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 7 min. de leitura

    • . PredicabilityEstimate A API é um objeto programável usado em Inteligência preditiva armazenamentos. Este objeto fornece estimativa de como os campos previsíveis de um conjunto de dados podem ser e quais recursos podem ser úteis para prever esses campos.

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

    O fluxo de configuração para treinamento da estimativa de previsão é o seguinte:
    1. Crie um conjunto de dados usando DatasetDefinition API.
    2. Use construtor para criar um objeto de estimativa de previsão.
    3. Adicione o objeto de estimativa de previsão ao armazenamento de estimativa de previsão usando PredictabilityEstimateStore - add() método.
    4. Treine a estimativa de previsão usando SubmitTrainingJob() método. Cria uma versão do objeto que você pode gerenciar usando PredictabilityEstimateVersion API.
    5. Obtenha valores preditivos estimados usando PredictabilityEstimateVersion – getResults() método.
    Nota:
    Esta API é executada com privilégios totais antes de Vancouver Patch 7 Hotfix 2b e. Washington DC Versões do patch 7. Com versões posteriores, conceda acesso usando ACLs. Para obter mais informações, consulte Query ACLs.

    Para obter diretrizes de uso, consulte Usando APIs DE ML .

    PredictabilityEstimate - PredictabilityEstimate (configuração de objeto)

    Cria uma estimativa de previsão.

    Para obter novas estimativas de previsão no mesmo conjunto de dados, use este construtor para criar um novo objeto PredictabilityEstimate com um nome exclusivo.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    config Objeto Objeto JavaScript que contém propriedades de configuração do estimativa de previsão.
    {
  "dataset": {Object},
  "domainName": "String",
  "inputFieldNames": [Array],
  "label": "String",
  "minRowCount": "String",
  "predictedFieldName": "String",
  "trainingFrequency": "String"
}
    config.dataset Objeto DatasetDefinition nome.
    Config.domainname Cadeia de caracteres Opcional. Nome de domínio associado a este conjunto de dados. Consulte Domain Separation e. Inteligência preditiva.

    Domínio atual, por exemplo, "global" .
    config.inputFieldNames Matriz Lista de campos de entrada de candidatos como cadeias de caracteres a serem consideradas para estimativa.
    config.label Cadeia de caracteres Identifica a tarefa de previsão.
    Config.minRow Count Cadeia de caracteres Opcional. Número mínimo de registros necessários no conjunto de dados para treinamento.

    Padrão: 10000
    PredictedFieldName Cadeia de caracteres Identifica um campo a ser treinado para previsão.
    Config.TrainingFrequency Cadeia de caracteres Opcional. A frequência para treinar novamente o modelo.
    Valores possíveis:
    • every_30_days
    • every_60_days
    • every_90_days
    • every_120_days
    • every_180_days
    • run_once
    Padrão: Run_once

    O exemplo a seguir mostra como criar um trabalho de estimativa e adicioná-lo à loja PredictabilityEstimate.

    var myIncidentData = new sn_ml.DatasetDefinition({
  'tableName' : 'incident',
  'encodedQuery' : 'activeANYTHING'
});

var myEstimate = new sn_ml.PredictabilityEstimate({
  'label': "predictability estimate",
  'dataset' : myIncidentData,
  'inputFieldNames':['short_description'], 
  'predictedFieldName': 'category'
});

var myEstimateName = sn_ml.PredictabilityEstimateStore.add(myEstimate);

    PredictabilityEstimate - cancelTrainingJob()

    Cancela um trabalho para um objeto de estimativa de previsão enviado para treinamento.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 3. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como cancelar um trabalho de treinamento existente.

    var myEstimate = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

myEstimate.cancelTrainingJob();

    PredictabilityEstimate - getActiveVersion()

    Ativa PredictabilityEstimateVersion objeto.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 5. Retorna
    Tipo Descrição
    Objeto Ativo PredictabilityEstimateVersion objeto.

    O exemplo a seguir mostra como obter um ativo PredicabilityEstimate da loja e retorna seu status de treinamento. 

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

    Saída:

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

    PredictabilityEstimate - getAllVersions()

    Obtém todas as versões de uma estimativa de previsão.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 7. Retorna
    Tipo Descrição
    Matriz Versões existentes de um objeto de solução. Consulte também PredictabilityEstimateVersion API.

    O exemplo a seguir mostra como obter tudo PredicabilityEstimate objetos de versão e chamam o. GetVersionNumber() e. GetStatus() métodos de versão de estimativa neles.

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

var mlEstimateVersions = mlEstimate.getAllVersions();

for (i = 0; i < mlEstimateVersions.length; i++) {
gs.print("Version " + mlEstimateVersions[i].getVersionNumber() + " Status: " + mlEstimateVersions[i].getStatus() +"\n");
};

    Saída:

    Version 3 Status: {"state":"predictability_estimate_complete","percentComplete":"100","hasJobEnded":"true"}

Version 2 Status: {"state":"predictability_estimate_complete","percentComplete":"100","hasJobEnded":"true"}

Version 1 Status: {"state":"predictability_estimate_cancelled","percentComplete":"0","hasJobEnded":"true"}

    PredictabilityEstimate - getLatestVersion()

    Obtém a versão mais recente de uma estimativa de previsão.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 9. Retorna
    Tipo Descrição
    Objeto PredictabilityEstimateVersion objeto correspondente à versão mais recente de. PredictabilityEstimate() .

    O exemplo a seguir mostra como obter a versão mais recente de uma estimativa de previsão e retorna seu status de treinamento.

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

    Saída:

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

    PredictabilityEstimate - getName()

    Obtém o nome do objeto a ser usado para interação com o armazenamento.

    Tabela 10. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 11. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome do objeto de estimativa.

    O exemplo a seguir mostra como atualizar PredicabilityEstimate informações do conjunto de dados e imprima o nome do objeto. 

    // Update estimate
var myIncidentData = new sn_ml.DatasetDefinition({
   'tableName' : 'incident',
   'fieldNames' : ['category', 'short_description', 'priority'],
   'encodedQuery' : 'activeANYTHING'
});

var myEstimate = new sn_ml.PredictabilityEstimate({
   'label': "my estimate",
   'dataset' : myIncidentData,
   'inputFieldNames':['short_description'],
   'predictedFieldName': 'category'
});

// update estimate
sn_ml.PredictabilityEstimateStore.update('ml_x_snc_global_global_my_definition_4', myEstimate);

// print estimate name
gs.print('Estimate Name: '+myEstimate.getName());

    Saída:

    Estimate Name: ml_x_snc_global_global_my_definition_4

    PredictabilityEstimate - getProperties()

    Obtém propriedades do objeto de estimativa de previsão.

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 13. Retorna
    Tipo Descrição
    Objeto Conjunto de dados e. PredictabilityEstimate() detalhes do objeto no PredictabilityEstimateStore .
    {
  "datasetProperties": {Object},
  "domainName": "String",
  "inputFieldNames": [Array],
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "scope": "String",
  "trainingFrequency": "String"
}
    <Object>.DatasetProperties

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

    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}
    <Object>.DatasetProperties.tablename Nome da tabela do conjunto de dados. Por exemplo, "Tablename" : "Incidente" .

    Tipo de dados: Cadeia de caracteres.
    <Object>.DatasetProperties.fieldnames Lista de nomes de campos da tabela especificada como cadeias de caracteres. Por exemplo, "Fieldnames" : ["short_description", "prioridade"] .

    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>.name Nome do campo que define o tipo de informação ao qual restringir este conjunto de dados.

    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 de domínio associado a este conjunto de dados. Consulte Domain Separation 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>.label Identifica a tarefa de previsão. 
    {
  "label": "my first prediction"
}

    Tipo de dados: Cadeia de caracteres.
    <Object>.name Nome atribuído pelo sistema.

    Tipo de dados: Cadeia de caracteres.
    <Object>.PredictedFieldName Identifica um campo a ser treinado para previsão.

    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 treinar novamente o modelo.
    Valores possíveis:
    • every_30_days
    • every_60_days
    • every_90_days
    • every_120_days
    • every_180_days
    • run_once
    Padrão: Run_once

    Tipo de dados: Cadeia de caracteres.

    O exemplo a seguir obtém propriedades de um objeto de estimativa de previsão na loja. 

    var mySolution = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));
    Saída:
    *** Script: {
  "datasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "category",
      "short_description",
      "priority",
      "assignment_group.name"
    ],
    "fieldDetails": [
      {
        "name": "category",
        "type": "nominal"
      },
      {
        "name": "short_description",
        "type": "text"
      }
    ]
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "label": "my estimate definition",
  "name": "ml_x_snc_global_global_my_definition_26",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

    PredictabilityEstimate - getVersion (versão da cadeia de caracteres)

    Obtém uma estimativa de previsão pelo número de versão fornecido.

    Tabela 14. Parâmetros
    Nome Tipo Descrição
    versão Cadeia de caracteres Número da versão existente de uma estimativa de previsão.
    Tabela 15. Retornos
    Tipo Descrição
    Objeto Versão especificada do PredictabilityEstimate() objeto no qual você pode chamar PredictabilityEstimateVersion Métodos de API.

    O exemplo a seguir mostra como obter o status de treinamento de uma estimativa de previsão por número de versão.

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

gs.print(JSON.stringify(JSON.parse(mlEstimate.getVersion('1').getStatus()), null, 2));

    Saída:

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

    PredictabilityEstimate - setActiveVersion(versão da cadeia de caracteres)

    Ativa uma versão especificada de uma estimativa de previsão na loja.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    versão Cadeia de caracteres Nome do PredictabilityEstimate() versão do objeto a ser ativada.

    Ativar esta versão desativa qualquer outra versão.
    Tabela 17. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como ativar uma estimativa de previsão versão na loja. 

    sn_ml.PredictabilityEstimate.setActiveVersion("ml_x_snc_global_global_my_estimate_definition");

    PredictabilityEstimate - submitTrainingJob()

    Envia um trabalho de treinamento.

    Nota:
    Antes de executar este método, você deve primeiro adicionar uma estimativa de previsão ao armazenamento usando PredictabilityEstimateStore - add() método.
    Tabela 18. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 19. Retorna
    Tipo Descrição
    Objeto PredictabilityEstimateVersion objeto correspondente ao PredicabilityEstimate sendo treinado.

    O exemplo a seguir mostra como criar um conjunto de dados e aplicá-lo uma estimativa de previsão, adicione-a. para uma loja e envie o trabalho de treinamento. 

    // Create a dataset 
var myData = new sn_ml.DatasetDefinition({

  'tableName' : 'incident',
  'fieldNames' : ['assignment_group', 'short_description', 'description'],
  'encodedQuery' : 'activeANYTHING'

});

// Create an estimate 
var myEstimate = new sn_ml.PredictabilityEstimate({

  'label': "my estimate definition",
  'dataset' : myData,
  'predictedFieldName' : 'assignment_group',
  'inputFieldNames':['short_description']

});

// Add the estimate to the store to later be able to retrieve it.
var my_unique_name = sn_ml.PredictabilityEstimateStore.add(myEstimate);

// Train the estimate - this is a long running job 
var myEstimateVersion = myEstimate.submitTrainingJob();