SimilaritySolutionVersion - Global

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

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

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

    Esta API usada é usada para trabalhar com versões de solução baseadas em API SimilaritySolution objetos no SimilaritySolution store .

    O sistema cria uma versão de solução sempre que você treina uma definição de solução. A maioria das versões é criada durante o treinamento programado da solução.

    Os métodos nesta API podem ser acessados usando o seguinte SimilaritySolution métodos:

    SimilaritySolutionVersion - getProperties()

    Obtém propriedades do objeto de solução e o número da versão.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    Objeto Conjunto de dados e. SimilaritySolution detalhes da versão. Os resultados variam de acordo com a configuração da propriedade do objeto.
    {
  "domainName": "String",
  "encoder": {Object},  
  "isActive": "String",
  "label": "String",
  "lookupDatasetProperties": {Object},
  "name": "String",
  "predictedFieldName": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "testDatasetProperties": {Object},
  "trainingFrequency": "String",
  "updateFrequency": "String",
  "versionNumber": "String"
}
    <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>.encoder Objeto do codificador atribuído a esta solução. Consulte Encoder - Encoder (configuração de objeto).

    Tipo de dados: Objeto.
    <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>.label Identifica a tarefa de previsão. 
    {
  "label": "my first prediction"
}

    Tipo de dados: Cadeia de caracteres.
    <Object>.LookupDatasetProperties Detalhes do DatasetDefinition() objeto usado como o conjunto de pesquisa. 
    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Tipo de dados: Objeto.
    <Object>.LookupDatasetProperties.tablename Nome da tabela do conjunto de dados. Por exemplo, "Tablename" : "Incidente" .

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

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

    Tipo de dados: Matriz.
    <Object>.LookupDatasetProperties.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>.LookupDatasetProperties.fieldDetails. <object>.type Tipo de campo de aprendizado de máquina.

    Tipo de dados: Cadeia de caracteres.
    <Object>.LookupDatasetProperties.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>.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>.ProcessingLanguage Linguagem de processamento no formato de código de idioma ISO 639-1 de duas letras.

    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>.palavras irrelevantes Opcional. Lista predefinida de cadeias de caracteres que o sistema gera automaticamente com base em languageconfiguração de propriedade. Para obter detalhes, consulte Crie uma lista de palavras irrelevantes personalizada .

    Tipo de dados: Matriz.
    <Object>.TestDatasetProperties Detalhes do DatasetDefinition() objeto usado para recuperar semelhanças entre os resultados pesquisados neste modelo e os resultados encontrados em lookupDataset. 
    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Tipo de dados: Objeto.
    <Object>.TestDatasetProperties.tablename Nome da tabela do conjunto de dados. Por exemplo, "Tablename" : "Incidente" .

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

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

    Tipo de dados: Matriz.
    <Object>.TestDatasetProperties.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>.TestDatasetProperties.fieldDetails. <object>.type Tipo de campo de aprendizado de máquina.

    Tipo de dados: Cadeia de caracteres.
    <Object>.TestDatasetProperties.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>.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.
    <Object>.UpdateFrequency A frequência na qual o modelo da definição da solução deve ser recriado.
    Valores possíveis:
    • _not_update
    • every_1_day
    • every_1_hour
    • every_6_hours
    • every_12_hours
    • every_1_minute
    • every_15_minutes
    • every_30_minutes
    Padrão: Do_not_update

    Datatype: Cadeia de caracteres
    <Object>.VersionNumber Número da versão do SimilaritySolution objeto.

    Tipo de dados: Cadeia de caracteres.

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

    // Get properties
var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

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

    Saída:

    *** Script: {
  "domainName": "global",
  "encoderProperties": {
    "datasetsProperties": [],
    "name": "wordCorpusA"
  },
  "isActive": "true",
  "label": "similarity",
  "lookupDatasetProperties": {
    "encodedQuery": "",
    "fieldNames": [
      "short_description"
    ],
    "tableName": "incident"
  },
  "name": "ml_x_snc_global_global_similarity",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "testDatasetProperties": {
    "fieldNames": [
      "short_description"
    ],
    "tableName": "incident"
  },
  "versionNumber": "3"
}

    SimilaritySolutionVersion - getStatus(boolian includeDetails)

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

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    IncludeDetalhes 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 4. Retornos
    Tipo Descrição
    Objeto Objeto JavaScript que contém informações de status de treinamento para. SimilaritySolution objeto.
    {
  "state": "String",
  "percentComplete": "Number as a String",
  "hasJobEnded": "Boolean value as a String",
  "details": {Object}
}
    <Object>.state Estado de conclusão do treinamento. Se o trabalho de treinamento atingir um estado de terminal, o trabalho não deixará esse estado. Se o estado for terminal, o hasJobEndeda propriedade está definida como verdadeiro .
    Valores possíveis:
    • buscando_files_for_training
    • preparing_data
    • tente novamente
    • solution_cancelled (terminal)
    • solution_complete (terminal)
    • solution_error (terminal)
    • solution_incomplete
    • training_request_received
    • training_request_timed_out (terminal)
    • training_solution
    • uploading_solution
    • waiting_for_training

    Tipo de dados: Cadeia de caracteres
    <Object>.HasJobEnded Sinalizador que indica se o treinamento está concluído.
    Valores válidos:
    • Verdadeiro: O treinamento foi concluído.
    • Falso: O treinamento está incompleto.

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

    Tipo de dados: Número como uma cadeia de caracteres

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

    Tipo de dados: Objeto

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

    // Get status
var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.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 solutionName = 'ml_x_snc_global_global_similarity_solution';
var mlSolution = sn_ml.SimilaritySolutionStore.get(solutionName);
var trainingStatus = JSON.parse(mlSolution.getLatestVersion().getStatus());

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

    Saída:

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

    SimilaritySolutionVersion - getVersionNumber()

    Obtém o número da versão de um objeto de solução.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. 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 mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

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

    Saída:

    Version number: 1

    SimilaritySolutionVersion - Previsão (entrada de objeto, opções de objeto)

    Obtém os dados de entrada para uma previsão.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    entrada Objeto GlideRecord Ou matriz de objetos JSON que contém nomes de campos e valores como pares de chave-valor.
    opções Objeto Valores opcionais para filtrar resultados de previsão.
    {
  "apply_threshold": Boolean,
  "top_n": Number
}
    options.apply_threshold Booliano Sinalizador que indica se o valor limite da solução deve ser verificado e aplicado ao conjunto de resultados.
    Valores válidos:
    • Verdadeiro: Retorna resultados nos quais a confiança é maior que o limite.
    • Falso: Retorna todos os resultados.

    Padrão: Verdadeiro
    opções.top_n Número Se fornecido, retorna os principais resultados, até o número especificado de previsões.
    Tabela 8. Retornos
    Tipo Descrição
    Objeto Objeto JSON que contém os resultados de previsão classificados por sys_id ou record_number. 
    {
    <identifier>: [Array]
}
    <Object>.<identifier> Lista de objetos com detalhes para cada resultado de previsão.

    Tipo de dados: Matriz de objetos

    <identifier>: [
  {
    "confidence": Number,
    "predictedSysId": "String",
    "predictedValue": "String", 
    "threshold": Number
  }
]
    <Object>.<identifier>. <object>.confidence Valor da confiança associada à previsão. Por exemplo, 53,84.

    Tipo de dados: Número
    <Object>.<identifier>. <object>.PredictedSysId O sys_id do valor previsto. Os resultados podem ser de qualquer tabela na qual as informações estão sendo previstas.

    Tipo de dados: Cadeia de caracteres
    <Object>.<identifier>. <object>.PredictedValue Valor que representa o resultado da previsão.

    Tipo de dados: Cadeia de caracteres
    <Object>.<identifier>. <object>.threshold Valor do limite configurado associado à previsão.

    Tipo de dados: Número

    O exemplo a seguir mostra como exibir resultados de previsão para um previsão() Método que usa um GlideRecord por sys_id para entrada e inclui parâmetros opcionais para restringir aos três principais resultados e excluir o valor de limite.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

// single GlideRecord input
var input = new GlideRecord("incident");
input.get("<sys_id>");

// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;

var results = mlSolution.getVersion(1).predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));
    {
        "<sys_id/now_GR>": [
    {
      "confidence": 62.10782320780268,
      "threshold": 20.36,
      "predictedValue": "Clone Issues",
      "predictedSysId": ""
    },
    {
      "confidence": 6.945237375770391,
      "threshold": 16.63,
      "predictedValue": "Instance Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 5.321061076300759,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    }
  ]
}

    O exemplo a seguir mostra como exibir resultados de previsão para um previsão() método que usa uma matriz de nomes de campos como pares de chave-valor para entrada e inclui parâmetros opcionais para restringir aos três principais resultados e excluir o valor limite.

    var mlSolution = sn_ml.SimilaritySolutionStore.get("ml_incident_categorization");
// key-value pairs input
var input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];
// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;
var results = mlSolution.predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));
    {
  "1": [
    {
      "confidence": 37.5023032262591,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 24.439964862166583,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 11.736320486031047,
      "threshold": 100,
      "predictedValue": "Security",
      "predictedSysId": ""
    }
  ],
  "2": [
    {
      "confidence": 99,
      "threshold": 17.77,
      "predictedValue": "Email",
      "predictedSysId": ""
    },
    {
      "confidence": 3.182137005157543,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 2.8773826570713514,
      "threshold": -1,
      "predictedValue": "Email (I/f)",
      "predictedSysId": ""
    }
  ]
}