Codificador - Global

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

    • . Codificador A API fornece um objeto programável usado em Inteligência preditiva armazenamentos. Este objeto converte dados de entrada em vetores de números, com base em objetivos e configurações específicos do codificador. Codificadores podem ser usados independentemente para executar codificações ou podem ser configurados como parte de soluções para codificar colunas de texto.

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

    Codificadores são objetos de processamento de texto que são pré-treinados ou treinados com base nos conjuntos de dados de idioma fornecidos. Você pode treinar codificadores que determinam como o sistema interpreta e processa campos de texto. Para soluções DE ML que incluem texto, você pode treinar um codificador para especificar como processar texto e usar o codificador treinado em uma solução.

    Codificadores têm configuração e versões e podem ser treinados independentemente com sua própria frequência de retreinamento. Codificadores definidos por API são diferentes dos codificadores definidos pela IU, porque o retreinamento de codificadores definidos pela IU é controlado pelas soluções que os usam.

    O fluxo de configuração para treinamento do codificador é o seguinte:
    1. Crie um ou mais conjuntos de dados usando DatasetDefinition API.
    2. Use construtor para criar um objeto codificador.
    3. Adicione o objeto do codificador ao armazenamento do codificador usando EncoderStore - add() método.
    4. Treine o codificador usando SubmitTrainingJob() método. Cria uma versão do objeto que você pode gerenciar usando EncoderVersion API.
    Depois de treinar um codificador, você pode usá-lo em um objeto de solução:
    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 .

    Encoder - Encoder (configuração de objeto)

    Cria um codificador.

    Para obter um codificador para um ou mais conjuntos de dados, use este construtor para criar um novo objeto codificador com um nome exclusivo.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    config Objeto Objeto JavaScript que contém propriedades de configuração do codificador.
    {
  "algorithmConfig": {Object},
  "datasets": [Array],
  "domainName": "String",
  "label": "String",
  "minRowCount": "String",
  "processingLanguage": "String",
  "stopwords": [Array],
  "trainingFrequency": "String"
}
    Config.algorithmConfig Objeto Opcional. Objeto JavaScript que contém propriedades de configuração do algoritmo. 
    'algorithmConfig' : {
  "algorithm": "String"
}
    Config.algorithmConfig.algorithm Cadeia de caracteres Nome do algoritmo para treinar este codificador.
    Valores possíveis:
    • paravecIncorporação de palavra vetorial de parágrafo.
    • tf-idfTexto baseado em Frequência do termo - Frequência invertida do documento (TF-IDF).
    config.datasets Matriz Lista de DatasetDefinition nomes de objetos.
    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.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
    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.TrainingFrequency Cadeia de caracteres 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 codificador e adicioná-lo ao armazenamento do codificador.

    var myPrbData = new sn_ml.DatasetDefinition({
    'tableName' : 'problem',
    'fieldNames' : ['short_description'],
    'encodedQuery' : 'activeANYTHING'
});

var myIncidentData = new sn_ml.DatasetDefinition({
    'tableName' : 'incident',
    'fieldNames' : ['short_description', 'description'],
    'encodedQuery' : 'activeANYTHING'
});

var myEncoder = new sn_ml.Encoder({
    'label': "encoder",
    'datasets' : [myPrbData, myIncidentData],
    'algorithmConfig' : {
        'algorithm' : 'tf-idf'
    }
});
var myEncoderName = sn_ml.EncoderStore.add(myEncoder);

    Cancelador - cancelTrainingJob()

    Cancela um trabalho para um objeto codificador 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 myEncoder = sn_ml.EncoderStore.get('ml_sn_global_global_encoder');

myEncoder.cancelTrainingJob();

    Codificador - getActiveVersion()

    Ativa Objeto EncoderVersion.

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

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

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

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

    Saída:

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

    Codificador - getAllVersions()

    Obtém todas as versões de um codificador.

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

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

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

var mlEncoderVersions = mlEncoder.getAllVersions();

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

    Saída:

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

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

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

    Codificador - getLatestVersion()

    Obtém a versão mais recente de um codificador.

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

    O exemplo a seguir mostra como obter a versão mais recente de um codificador e retorna seu status de treinamento.

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

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

    Saída:

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

    Codificador - 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 do codificador.

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

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

var eligibleFields = JSON.parse(myIncidentData.getEligibleFields(encoder));

var myEncoder = new sn_ml.Encoder({
   'label': "my encoder",
   'datasets' : [myIncidentData],
   'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
   'predictedFieldName': 'category'
});

// update encoder
sn_ml.EncoderStore.update('ml_x_snc_global_global_my_definition_4', myEncoder);

// print encoder name
gs.print('Encoder Name: '+myEncoder.getName());

    Saída:

    Encoder Name: ml_x_snc_global_global_my_definition_4

    Codificador - 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. Codificador () detalhes do objeto no EncoderStore .
    {
  "algorithmConfig" : {Object},
  "datasetsProperties": [Array],
  "domainName": "String",
  "label": "String",
  "name": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "trainingFrequency": "String"
}
    <Object>.AlgorithmConfig.algorithm Nome do algoritmo para treinar este codificador.
    Valores possíveis:
    • paravecIncorporação de palavra vetorial de parágrafo.
    • tf-idfTexto baseado em Frequência do termo - Frequência invertida do documento (TF-IDF).

    Tipo de dados: Cadeia de caracteres.
    <Object>.AlgorithmConfig Opcional. Objeto JavaScript que contém propriedades de configuração do algoritmo. 
    'algorithmConfig' : {
  "algorithm": "String"
}

    Tipo de dados: Objeto.
    <Object>.DatasetsPropriedades

    Lista de DatasetDefinition() propriedades associadas ao codificador.

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

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

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

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

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

    Tipo de dados: Cadeia de caracteres.
    <Object>.DatasetsProperties.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>.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>.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>.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 codificador na loja. 

    var myEncoder = sn_ml.EncoderStore.get('ml_sn_global_global_encoder');

gs.print(JSON.stringify(JSON.parse(myEncoder.getProperties()), null, 2));
    Saída:
    *** Script: {
  "datasetsProperties": [
    {
      "tableName": "incident",
      "fieldNames": [
        "assignment_group",
        "short_description",
        "description"
      ],
      "encodedQuery": "activeANYTHING"
    }
  ],
  "domainName": "global",
  "label": "my encoder definition",
  "name": "ml_x_snc_global_global_my_encoder_definition",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

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

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

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

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

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

    Saída:

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

    SetActiveVersion (versão da cadeia de caracteres)

    Ativa uma versão especificada de um codificador no armazenamento.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    versão Cadeia de caracteres Nome do Codificador () 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 um codificador versão na loja. 

    sn_ml.Encoder.setActiveVersion("ml_incident_categorization");

    SubmitTrainingJob()

    Envia um trabalho de treinamento.

    Nota:
    Antes de executar este método, você deve primeiro adicionar um codificador ao armazenamento usando EncoderStore - add() método.
    Tabela 18. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 19. Retorna
    Tipo Descrição
    Objeto EncoderVersion objeto correspondente ao Codificador sendo treinado.

    O exemplo a seguir mostra como criar um conjunto de dados e aplicá-lo um codificador, adicione-o. 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 encoder 
var myEncoder = new sn_ml.Encoder({

  'label': "my encoder definition",
  'datasets' : [myData],
  'predictedFieldName' : 'assignment_group',
  'inputFieldNames':['short_description']

});

// Add the encoder to the store to later be able to retrieve it.
var my_unique_name = sn_ml.EncoderStore.add(myEncoder);

// Train the encoder - this is a long running job 
var myEncoderVersion = myEncoder.submitTrainingJob();