---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# EncoderStore -- Global

# EncoderStore -- Global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

A API EncoderStore fornece métodos para armazenar e recuperar codificadores.

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

## EncoderStore - add(Object mlEncoder) {#ariaid-title2}

Adiciona um novo codificador objeto de solução ao armazenamento e retorna um nome exclusivo.
Nota:  
Os valores de rótulo não precisam ser exclusivos. Por exemplo, se você executar este método com o mesmo rótulo 10 vezes, este método adicionará 10 objetos diferentes com nomes exclusivos ao armazenamento.
{#EncoderStore-add_O__table_vwy_1fr_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| mlEncoder | [Codificador](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#EncoderAPI "A API Encoder fornece um objeto programável usado em armazenamentos Inteligência preditiva. Este objeto converte dados de entrada em vetores de números, com base em objetivos e configurações específicas do codificador. Os codificadores podem ser usados independentemente para executar codificações ou podem ser configurados como parte de soluções para codificar colunas de texto.") | [Codificador ()](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#Encoder-Encoder_O "Cria um codificador.") objeto a ser adicionado ao armazenamento. |
[Tabela 1. Parâmetros]

{#EncoderStore-add_O__table_vwy_1fr_llb} {#EncoderStore-add_O__table_wwy_1fr_llb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Nome da solução gerada pelo sistema. |
[Tabela 2. Retorna]

{#EncoderStore-add_O__table_wwy_1fr_llb}  
O exemplo a seguir mostra como adicionar um codificador ao armazenamento. Usar [codificador - submitTrainingJob()](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#Encoder-submitTrainingJob "Envia um trabalho de treinamento.") para executar o trabalho de treinamento depois de adicioná-lo ao armazenamento.

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

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

    });

    // Create a solution 
    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);

## EncoderStore - deleteObject(String name) {#ariaid-title3}

Remove um objeto de codificador especificado do armazenamento.
{#EncoderStore-deleteObject_S__table_rmj_lfr_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome do [codificador ()](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#Encoder-Encoder_O "Cria um codificador.") objeto a ser excluído. |
[Tabela 3. Parâmetros]

{#EncoderStore-deleteObject_S__table_rmj_lfr_llb} {#EncoderStore-deleteObject_S__table_smj_lfr_llb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 4. Retorna]

{#EncoderStore-deleteObject_S__table_smj_lfr_llb}  
O exemplo a seguir mostra como excluir um codificador do armazenamento.

    sn_ml.EncoderStore.deleteObject("ml_sn_global_global_encoder");

## EncoderStore - get(nome da cadeia de caracteres) {#ariaid-title4}

Obtém um objeto de codificador de um armazenamento.
{#EncoderStore-get_S__table_zvw_v2r_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome de um codificador em um armazenamento. |
[Tabela 5. Parâmetros]

{#EncoderStore-get_S__table_zvw_v2r_llb} {#EncoderStore-get_S__table_aww_v2r_llb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | [Codificador](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#EncoderAPI "A API Encoder fornece um objeto programável usado em armazenamentos Inteligência preditiva. Este objeto converte dados de entrada em vetores de números, com base em objetivos e configurações específicas do codificador. Os codificadores podem ser usados independentemente para executar codificações ou podem ser configurados como parte de soluções para codificar colunas de texto.") objeto. Retorna um erro se o objeto não existir. |
[Tabela 6. Retorna]

{#EncoderStore-get_S__table_aww_v2r_llb}  
O exemplo a seguir mostra como obter um objeto de codificador do armazenamento usando o método get() e exibir seu status de treinamento usando os métodos [Codificador - getActiveVersion()](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#Encoder-getActiveVersion "Obtém o ativo Objeto EncoderVersion.") e [EncoderVersion - getStatus()](https://servicenow-prod.fluidtopics.net/d0bTgpbJJ2xwZZlaSpCyVA#EncoderV-getStatus_B "Obtém o status de conclusão do treinamento.").

    // Get status
    var myEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

Saída:

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

## EncoderStore - getAllNames(Opções de objeto) {#ariaid-title5}

Obtém os nomes de todos os registros de definição do codificador no armazenamento.
{#EncoderStore-getAllNames__id_bfn_kwh_wnb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| opções | Objeto | Opções para restringir resultados nas propriedades especificadas. { "label": "String", "domainName": "String", "scope": "String" }; |
| opções.rótulo | Cadeia de caracteres | Opcional. Rótulo do seu objeto de solução. |
| opções.domainName | Cadeia de caracteres | Opcional. Nome do domínio do objeto de solução. Consultar [Domain Separation e Inteligência preditiva](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). |
| opções.escopo | Cadeia de caracteres | Opcional. Nome de um [escopo da aplicação](https://www.servicenow.com/docs/access?context=c_ApplicationScope&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US) para o objeto de solução. |
[Tabela 7. Parâmetros]

{#EncoderStore-getAllNames__id_bfn_kwh_wnb} {#EncoderStore-getAllNames__table_aww_v2r_llb__entry__2}

| Tipo | Descrição |
|-|-|
| Matriz | Lista de cadeias de caracteres que representam nomes de objeto do codificador no armazenamento. |
[Tabela 8. Retorna]

{#EncoderStore-getAllNames__table_aww_v2r_llb}  
No exemplo a seguir, o método getAllNames() retorna uma lista de todos os nomes no armazenamento.

    gs.print(JSON.stringify(JSON.parse(sn_ml.EncoderStore.getAllNames()), null, 2));

Saída:

    [
      "ml_x_snc_global_global_classification_word_corpus",
      "ml_x_snc_global_global_predictability_estimate",
      "GloVe",
      "ml_x_snc_global_global_encoder",
      "ml_x_snc_global_global_predictability_estimate_1"
    ]

No exemplo a seguir, o método getAllNames() retorna somente nomes associados a valores definidos no parâmetro options.

    var options = {
      'label' : 'my encoder definition',
      'domainName' : 'global',
      'scope' : 'global'
    };
    var solNames = sn_ml.EncoderStore.getAllNames(options);
    gs.print(JSON.stringify(JSON.parse(solNames), null, 2));

Saída:

    [
      "ml_x_snc_global_global_my_encoder_definition"
    ]

## EncoderStore - update (nome da cadeia de caracteres, objeto mlEncoder) {#ariaid-title6}

Atualiza um objeto de codificador em um armazenamento.
{#EncoderStore-update_S_O__table_v5p_wxr_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome do codificador a ser atualizado. |
| mlEncoder | [Codificador](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#EncoderAPI "A API Encoder fornece um objeto programável usado em armazenamentos Inteligência preditiva. Este objeto converte dados de entrada em vetores de números, com base em objetivos e configurações específicas do codificador. Os codificadores podem ser usados independentemente para executar codificações ou podem ser configurados como parte de soluções para codificar colunas de texto.") | [Codificador ()](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#Encoder-Encoder_O "Cria um codificador.") propriedades do objeto a serem atualizadas. |
[Tabela 9. Parâmetros]

{#EncoderStore-update_S_O__table_v5p_wxr_llb} {#EncoderStore-update_S_O__table_w5p_wxr_llb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 10. Retorna]

{#EncoderStore-update_S_O__table_w5p_wxr_llb}  
O exemplo a seguir mostra como atualizar um objeto codificador no armazenamento.

    var encoderUpdate = new sn_ml.Encoder({
      'label': 'my encoder definition',
      'dataset' : myData,
      'predictedFieldName' : 'assignment_group',
      'inputFieldNames': ['short_description']
    });

    sn_ml.EncoderStore.update('ml_sn_global_global_incident_service', encoderUpdate);