SimilaritySolution - Global

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

    • . SimilaritySolution 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.

    A configuração da solução para o fluxo de treinamento é a seguinte:
    1. Crie um codificador usando Codificador API.
    2. Use construtor para criar um objeto de solução de semelhança.
    3. Adicione o objeto de solução ao armazenamento de soluções de semelhança usando SimilaritySolutionStore - add() método.
    4. Treine a solução usando SubmitTrainingJob() método. Cria uma versão do objeto que você pode gerenciar usando SimilaritySolutionVersion API.
    5. Obtenha previsões usando SimilaritySolutionVersion – Predict() 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 .

    SimilaritySolution - SimilaritySolution (configuração de objeto)

    Cria uma solução de semelhança.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    config Objeto Objeto JavaScript que contém propriedades de configuração do solução.
    {  
  "domainName": "String",
  "encoder": {Object},
  "label": "String",
  "lookupDataset": {Object},
  "minRowCount": "String",
  "processingLanguage": "String",
  "stopwords": [Array],
  "testDataset": {Object},
  "trainingFrequency": "String",
  "updateFrequency": "String"
}
    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.encoder Objeto Objeto do codificador treinado para atribuir a esta solução. Consulte Encoder - Encoder (configuração de objeto).
    config.label Cadeia de caracteres Identifica a tarefa de previsão.
    Config.lookupDataset Objeto Nome do DatasetDefinition para usar como o conjunto de pesquisa.
    Config.minRow Count Cadeia de caracteres Opcional. Número mínimo de registros necessários no conjunto de dados para treinamento.

    Padrão: 10000
    config.processingLanguage Cadeia de caracteres Opcional. Linguagem de processamento no formato de código de idioma ISO 639-1 de duas letras.

    Padrão: "en"
    config.stopwords Matriz 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 .

    Padrão: Palavras irrelevantes em inglês
    Config.testDataset Objeto Nome do DatasetDefinition para verificar semelhanças com lookupDatasetresultados.
    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
    Config.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

    O exemplo a seguir mostra como criar um objeto e adicioná-lo ao SimilaritySolution store.

    var incidentData = new sn_ml.DatasetDefinition({
        'tableName' : 'incident',
        'fieldNames' : ['category', 'short_description']        
    });
    var kbData = new sn_ml.DatasetDefinition({
        'tableName' : 'kb_knowledge',
        'fieldNames' : ['short_description'],
        'encodedQuery' : 'active=true'
    });
    var encoder = sn_ml.EncoderStore.get('GloVe');
    var mySolution = new sn_ml.SimilaritySolution({
        'label': "similarity solution",
        'lookupDataset' : kbData,
        'testDataset' : incidentData,        
        'encoder' : encoder        
    });
    
    // add solution
    var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);

    SimilaritySolution - cancelTrainingJob()

    Cancela um trabalho para um objeto de soluçã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 mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity');

mySolution.cancelTrainingJob();

    SimilaritySolution - getActiveVersion()

    Ativa SimilaritySolutionVersion objeto.

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

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

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

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

    Saída:

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

    SimilaritySolution - getAllVersions()

    Obtém todas as versões de. SimilaritySolution objeto.

    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 SimilaritySolutionVersion API.

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

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

var mlSolutionVersions = mlSolution.getAllVersions();

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

    Saída:

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

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

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

    SimilaritySolution - getLatestVersion()

    Obtém a versão mais recente de uma solução.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 9. Retorna
    Tipo Descrição
    Objeto SimilaritySolutionVersion objeto correspondente à versão mais recente de. SimilaritySolution .

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

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

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

    Saída:

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

    SimilaritySolution - 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 solução.

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

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

var eligibleFields = JSON.parse(myIncidentData.getEligibleFields('Similarity'));

var mySimilarity = new sn_ml.SimilaritySolution({
   'label': "my Similarity solution",
   'dataset' : myIncidentData,
   'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
   'predictedFieldName': 'category'
});

// update solution
sn_ml.SimilaritySolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', mySimilarity);

// print solution name
gs.print('Solution Name: '+mySimilarity.getName());

    Saída:

    Solution Name: ml_x_snc_global_global_my_solution_definition_4

    SimilaritySolution - getProperties()

    Obtém propriedades do objeto de solução.

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 13. Retorna
    Tipo Descrição
    Objeto Conjunto de dados e. SimilaridadeSolução() detalhes do objeto no SimilaritySolutitionStore .
    {
  "domainName": "String",
  "encoder": {Object},
  "label": "String",
  "lookupDatasetProperties": {Object},
  "name": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "testDatasetProperties": {Object},
  "trainingFrequency": "String",
  "updateFrequency": "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>.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>.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

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

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity_solution');

gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));
    Saída:
    *** Script: {
  "domainName": "global",
  "encoderProperties": {
    "datasetsProperties": [],
    "name": "wordCorpusA"
  },
  "label": "similarity",
  "lookupDatasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "short_description"
    ]
  },
  "name": "ml_x_snc_global_global_similarity",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "testDatasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "short_description"
    ]
  },
  "trainingFrequency": "every_30_days",
  "updateFrequency": "do_not_update"
}

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

    Obtém uma soluçã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 solução.
    Tabela 15. Retornos
    Tipo Descrição
    Objeto Versão especificada do SimilaridadeSolução() objeto no qual você pode chamar SimilaritySolutionVersion Métodos de API.

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

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

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

    Saída:

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

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

    Ativa uma versão especificada de uma solução no armazenamento.

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

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

    O exemplo a seguir mostra como ativar uma solução versão na loja. 

    sn_ml.SimilaritySolution.setActiveVersion("ml_incident_categorization");

    SimilaritySolution - submitTrainingJob()

    Envia um trabalho de treinamento.

    Nota:
    Antes de executar este método, você deve primeiro adicionar uma solução ao armazenamento usando SimilaritySolutionStore - add() método.
    Tabela 18. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 19. Retorna
    Tipo Descrição
    Objeto SimilaritySolutionVersion objeto correspondente ao SimilaritySolution sendo treinado. 
    // Create a dataset 
var incidentData = new sn_ml.DatasetDefinition({
    'tableName' : 'incident',
    'fieldNames' : ['category', 'short_description']
});

var kbData = new sn_ml.DatasetDefinition({
    'tableName' : 'kb_knowledge',
    'fieldNames' : ['short_description'],
    'encodedQuery' : 'active=true'
});

// Create a solution 
var encoder = sn_ml.EncoderStore.get('GloVe');
var mySolution = new sn_ml.SimilaritySolution({
    'label': "similarity solution",
    'lookupDataset' : kbData,
    'testDataset' : incidentData,
    'encoder' : encoder,
});

// Add solution
var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);


// Train the solution - this is a long running job 
var mySimilarityVersion = mySolution.submitTrainingJob();