---
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


---

# PredictabilityEstimateStore - Global

# PredictabilityEstimateStore - 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

Habilita o armazenamento e a recuperação de estimativas de previsibilidade.

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

## PredictabilityEstimateStore - add(Object mlEstimate) {#ariaid-title2}

Adiciona uma nova estimativa de previsibilidade 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.
{#PredictbltyEstStore-add_O__table_vwy_1fr_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| mlEstimativa | [PrevisibilidadeEstimativa](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PredictabilityEstimateAPI "A API PredictabilityEstimate é um objeto programável usado em Inteligência preditiva armazenamentos. Este objeto fornece uma estimativa de como os campos de um conjunto de dados podem ser previsíveis e quais recursos podem ser úteis para prever esses campos.") | [PrevisibilidadeEstimate()](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PrdctbltE-PredictabilityEstimate_O "Cria uma estimativa de previsibilidade.") objeto a ser adicionado ao armazenamento. |
[Tabela 1. Parâmetros]

{#PredictbltyEstStore-add_O__table_vwy_1fr_llb} {#PredictbltyEstStore-add_O__table_wwy_1fr_llb__entry__2}

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

{#PredictbltyEstStore-add_O__table_wwy_1fr_llb}  
O exemplo a seguir mostra como adicionar uma estimativa de previsibilidade ao armazenamento. Usar [PredictabilityEstimate - submitTrainingJob()](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PrdctbltE-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 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);

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

Remove um objeto de estimativa de previsibilidade especificado do armazenamento.
{#PredictbltyEstStore-deleteObject_S__table_rmj_lfr_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome do [PredictabilityEstimate()](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PrdctbltE-PredictabilityEstimate_O "Cria uma estimativa de previsibilidade.") objeto a ser excluído. |
[Tabela 3. Parâmetros]

{#PredictbltyEstStore-deleteObject_S__table_rmj_lfr_llb} {#PredictbltyEstStore-deleteObject_S__table_smj_lfr_llb__entry__2}

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

{#PredictbltyEstStore-deleteObject_S__table_smj_lfr_llb}  
O exemplo a seguir mostra como excluir uma estimativa de previsibilidade do armazenamento.

    sn_ml.PredictabilityEstimateStore.deleteObject("ml_sn_global_global_estimate");

## PredictabilityEstimateStore - get(cadeia de caracteres name) {#ariaid-title4}

Obtém um objeto de estimativa de previsibilidade de um armazenamento.
{#PredictbltyEstStore-get_S__table_zvw_v2r_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome de uma estimativa de previsibilidade em uma loja. |
[Tabela 5. Parâmetros]

{#PredictbltyEstStore-get_S__table_zvw_v2r_llb} {#PredictbltyEstStore-get_S__table_aww_v2r_llb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | [PrevisibilidadeEstimativa](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PredictabilityEstimateAPI "A API PredictabilityEstimate é um objeto programável usado em Inteligência preditiva armazenamentos. Este objeto fornece uma estimativa de como os campos de um conjunto de dados podem ser previsíveis e quais recursos podem ser úteis para prever esses campos.") objeto. Retorna um erro se o objeto não existir. |
[Tabela 6. Retorna]

{#PredictbltyEstStore-get_S__table_aww_v2r_llb}  
O exemplo a seguir mostra como obter um objeto de estimativa de previsibilidade do armazenamento usando o método get() e exibir seu status de treinamento usando os métodos [PredictabilityEstimate - getActiveVersion()](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PrdctbltE-getActiveVersion "Objeto Obtém o ativo PredictabilityEstimateVersion.") e [PredictabilityEstimateVersion - getStatus()](https://servicenow-prod.fluidtopics.net/xINiSQTu0F6vSf1WbgNiPQ#PredictbltyEstV-getStatus_B "Obtém o status de conclusão do treinamento.").

    // Get status
    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

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

Saída:

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

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

Obtém os nomes de todos os registros de definição de estimativa de previsibilidade no armazenamento.
{#PredictbltyEstStore-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]

{#PredictbltyEstStore-getAllNames__id_bfn_kwh_wnb} {#PredictbltyEstStore-getAllNames__table_aww_v2r_llb__entry__2}

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

{#PredictbltyEstStore-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.PredictabilityEstimateStore.getAllNames()), null, 2));

Saída:

    [
      "ml_x_snc_global_global_predictability_estimate_1",
      "ml_x_snc_global_global_predictability_estimate",
      "ml_x_snc_global_global_predictability_estimate_2",
      "ml_x_snc_global_global_my_estimate_definition"
    ]

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

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

Saída:

    [
      "ml_x_snc_global_global_my_estimate_definition"
    ]

## PredictabilityEstimateStore - update(cadeia de caracteres name, objeto mlEstimate) {#ariaid-title6}

Atualiza um objeto de estimativa de previsibilidade em um armazenamento.
{#PredictbltyEstStore-update_S_O__table_v5p_wxr_llb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome da estimativa de previsibilidade a ser atualizada. |
| mlEstimativa | [PrevisibilidadeEstimativa](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PredictabilityEstimateAPI "A API PredictabilityEstimate é um objeto programável usado em Inteligência preditiva armazenamentos. Este objeto fornece uma estimativa de como os campos de um conjunto de dados podem ser previsíveis e quais recursos podem ser úteis para prever esses campos.") | [PrevisibilidadeEstimate()](https://servicenow-prod.fluidtopics.net/hMQ90sxmfpQmIk_X3QxaCQ#PrdctbltE-PredictabilityEstimate_O "Cria uma estimativa de previsibilidade.") propriedades do objeto a serem atualizadas. |
[Tabela 9. Parâmetros]

{#PredictbltyEstStore-update_S_O__table_v5p_wxr_llb} {#PredictbltyEstStore-update_S_O__table_w5p_wxr_llb__entry__2}

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

{#PredictbltyEstStore-update_S_O__table_w5p_wxr_llb}  
O exemplo a seguir mostra como atualizar um objeto de estimativa de previsibilidade no armazenamento.

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

    sn_ml.PredictabilityEstimateStore.update('ml_sn_global_global_incident_service', estimateUpdate);