---
sourceDocument: Habilitar IA do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/intelligent-experiences

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Habilitar IA do Xanadu

ft:clusterId :

    - platai

bundleId :

    - platai

workflow :

    - Platform


---

# Como usar APIs de aprendizado de máquina

# Como usar APIs de aprendizado de máquina {#ariaid-title1}

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

Use ServiceNow APIs de aprendizado de máquina (ML) para treinar modelos de aprendizado de máquina e executar inferências.
As APIs de ML permitem soluções de treinamento e o gerenciamento de versões da solução. Você pode obter e definir versões ativas, monitorar o status de treinamento e muito mais. A API de ML também fornece codificadores, que permitem o uso de frequência de documento de frequência inversa (TF-IDF) como um corpus de palavras. As estimativas de previsibilidade permitem avaliar o valor preditivo das colunas da tabela.  
Nota:  
Inteligência preditiva Execução de APIs com privilégios totais. Para restringir o acesso do usuário, inclua um mecanismo de controle de acesso no script.

## Visão geral da classe da API de ML {#ariaid-title2}

Esta seção descreve resumidamente as classes para treinamento de soluções de ML e execução de inferências com soluções treinadas.

Conjuntos de dados

:   Um conjunto de dados é um conjunto de registros, incluindo um nome de tabela, colunas e critérios de seleção de linha a serem usados como entrada para algoritmos de treinamento de ML. Os conjuntos de dados não contêm os dados reais.

    Para obter mais informações, consulte [DatasetDefinition](https://www.servicenow.com/docs/access?context=DatasetDefinitionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US).

Objetos de ML -- Soluções, codificadores e estimativas

:   Os objetos de ML definem uma configuração de treinamento específica a ser aplicada em um conjunto de dados. Algumas operações são comuns em objetos de ML. Os objetos de solução incluem classificação, clustering, regressão e semelhança.

    Codificadores são objetos de processamento de texto 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 os 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.

    Os objetos PredictabilityEstimate estimam quais campos em um conjunto de dados são previsíveis e os recursos nos quais essa previsibilidade se baseia.  
    Para obter mais informações, consulte:

    * [Solução de classificação](https://www.servicenow.com/docs/access?context=ClassificationSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [ClusteringSolution](https://www.servicenow.com/docs/access?context=ClusteringSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [Codificador](https://www.servicenow.com/docs/access?context=EncoderAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [PrevisibilidadeEstimativa](https://www.servicenow.com/docs/access?context=PredictabilityEstimateAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [SoluçãoDeRegressão](https://www.servicenow.com/docs/access?context=RegressionSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [SemelhançaSolução](https://www.servicenow.com/docs/access?context=SimilaritySolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    {#ml-api-overview__ul_tsm_t4x_gmb}

Lojas

:   Os objetos de ML são mantidos em um armazenamento específico para cada tipo de objeto. Cada classe de armazenamento inclui métodos para operações de adição, obtenção, atualização e exclusão.

    Para obter mais informações, consulte:

    * [ClassificationSolutionStore](https://www.servicenow.com/docs/access?context=ClassificationSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [ClusteringSolutionStore](https://www.servicenow.com/docs/access?context=ClusteringSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [EncoderStore](https://www.servicenow.com/docs/access?context=EncoderStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [PrevisibilidadeEstimateStore](https://www.servicenow.com/docs/access?context=PredictabilityEstimateStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [RegressionSolutionStore](https://www.servicenow.com/docs/access?context=RegressionSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [SimilaritySolutionStore](https://www.servicenow.com/docs/access?context=SimilaritySolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    {#ml-api-overview__ul_dvb_54x_gmb}

Versões

:   Cada objeto treinado resulta em uma nova versão na qual você pode executar tarefas. Use a API de versão para obter qualquer versão de solução e executar tarefas nela.

    Para obter mais informações, consulte:

    * [ClassificationSolutionVersion](https://www.servicenow.com/docs/access?context=ClassificationSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [ClusteringSolutionVersion](https://www.servicenow.com/docs/access?context=ClusteringSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [EncoderVersion](https://www.servicenow.com/docs/access?context=EncoderVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [PrevisibilidadeEstimateVersion](https://www.servicenow.com/docs/access?context=PredictabilityEstimateVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [RegressionSolutionVersion](https://www.servicenow.com/docs/access?context=RegressionSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [SimilaritySolutionVersion](https://www.servicenow.com/docs/access?context=SimilaritySolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    {#ml-api-overview__ul_c4h_54x_gmb}

### Reunindo tudo: fluxos da API de ML {#ml-api-overview__section_okc_y4j_gmb}

Você pode usar o seguinte fluxo para configurar e treinar soluções, codificadores e estimativas de previsibilidade:Figura 1. Fluxo de API de ML -- Treinamento de solução, codificador e estimativa  
Nota:  
As definições do codificador são compatíveis com várias definições de conjunto de dados, mas têm o mesmo fluxo de treinamento.  
Para treinar uma solução com um codificador, crie o codificador primeiro e, em seguida, inclua o codificador na configuração da solução.Figura 2. Fluxo de API de ML -- Treinamento de API de solução com codificador

Requisitos do codificador de objeto de ML:

* Necessário em soluções de API de semelhança.
* Necessário em soluções de API de cluster, a menos que esteja usando o algoritmo de distância Levenshtein, caso em que os codificadores são opcionais.
* Opcional para soluções de classificação e regressão.
* Indisponível para estimativas de previsibilidade.
{#ml-api-overview__ul_azy_z3j_gmb}

## Introdução ao treinamento da solução de API de ML {#ariaid-title3}

Siga este detalhamento de exemplo para saber como configurar e treinar uma solução.

Configurar e treinar uma solução
:

    1. Defina um conjunto de dados usando a API [DatasetDefinition](https://www.servicenow.com/docs/access?context=DatasetDefinitionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US).  

           var myData = new sn_ml.DatasetDefinition({

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

           });

    2. Use o construtor para definir a solução, incluindo o conjunto de dados na configuração.  

           var mySolution = new sn_ml.ClassificationSolution({

             'label': "my solution definition",
             'dataset' : myData,
             'predictedFieldName' : 'assignment_group',
             'inputFieldNames':['short_description']

           });

       * [ClassificationSolution()](https://www.servicenow.com/docs/access?context=ClassificationSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [ClusteringSolution()](https://www.servicenow.com/docs/access?context=ClusteringSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [Codificador ()](https://www.servicenow.com/docs/access?context=EncoderAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [PrevisibilidadeEstimate()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [RegressionSolution()](https://www.servicenow.com/docs/access?context=RegressionSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [SimilaritySolution()](https://www.servicenow.com/docs/access?context=SimilaritySolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       {#ml-api-demo-train__ul_y2y_d3j_gmb}
    3. Adicione a definição de solução ao armazenamento usando o método add().  

           var my_unique_name = sn_ml.ClassificationSolutionStore.add(mySolution);

       * [ClassificationSolutionStore - add()](https://www.servicenow.com/docs/access?context=ClassificationSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [ClusteringSolutionStore -- add()](https://www.servicenow.com/docs/access?context=ClusteringSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [EncoderStore -- add()](https://www.servicenow.com/docs/access?context=EncoderStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [PredictabilityEstimateStore - add()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [RegressionSolutionStore -- add()](https://www.servicenow.com/docs/access?context=RegressionSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [SimilaritySolutionStore - add()](https://www.servicenow.com/docs/access?context=SimilaritySolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       {#ml-api-demo-train__ul_z2y_d3j_gmb}
    4. Treine a solução usando o método submitTrainingJob(). Depois que o treinamento for concluído, você poderá gerenciar a solução treinada usando uma API de versão de solução. Uma solução pode ser treinada novamente várias vezes. Cada treinamento resulta em uma nova "versão" de solução na qual você pode executar inferências.  

           var myClassifierVersion = mySolution.submitTrainingJob();

       * [ClassificationSolution - submitTrainingJob()](https://www.servicenow.com/docs/access?context=ClassificationSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [ClusteringSolutionVersion -- submitTrainingJob()](https://www.servicenow.com/docs/access?context=ClusteringSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [Codificador - submitTrainingJob()](https://www.servicenow.com/docs/access?context=EncoderAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [PredictabilityEstimate - submitTrainingJob()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [RegressionSolution - submitTrainingJob()](https://www.servicenow.com/docs/access?context=RegressionSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [SimilaritySolution - submitTrainingJob()](https://www.servicenow.com/docs/access?context=SimilaritySolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       {#ml-api-demo-train__ul_afy_d3j_gmb}
    {#ml-api-demo-train__ol_if1_wgs_gmb}

Exibir todas as soluções de classificação em uma loja
:   Você pode usar o método store getAllNames() para ver uma lista de todas as soluções que foram adicionadas ao armazenamento.  

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


    Na saída, o sistema nomeou a solução `como ml_x_snc_global_global_my_solution_definition`. Use este nome em exemplos subsequentes para obter informações da versão.

        *** Script: [
          "ml_incident_assignment",
          "ml_x_snc_global_global_my_solution_definition",
          "ml_incident_categorization"
        ]


    * [ClassificationSolutionStore - getAllNames()](https://www.servicenow.com/docs/access?context=ClassificationSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [ClusteringSolutionStore -- getAllNames()](https://www.servicenow.com/docs/access?context=ClusteringSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [EncoderStore -- getAllNames()](https://www.servicenow.com/docs/access?context=EncoderStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [PredictabilityEstimateStore -- getAllNames()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [RegressionSolutionStore -- getAllNames()](https://www.servicenow.com/docs/access?context=RegressionSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    * [SimilaritySolutionStore -- getAllNames()](https://www.servicenow.com/docs/access?context=SimilaritySolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
    {#ml-api-demo-train__ul_kxd_bjq_3mb}

## Introdução às versões da solução de API de ML {#ariaid-title4}

Siga estes exemplos de detalhamentos para saber como gerenciar versões de soluções treinadas.

Verificar status de treinamento

:   Obtenha a solução de classificação na loja, escolha uma versão e verifique o status de treinamento. Os métodos usados para verificar o status de treinamento são aplicáveis a todos os tipos de objeto de ML.

    1. Obtenha a solução do armazenamento de soluções de classificação usando o método get().  

           // Get the solution created in the previous example from the classification solution store
           var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_my_solution_definition');

       * [ClassificationSolutionStore - get()](https://www.servicenow.com/docs/access?context=ClassificationSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [ClusteringSolutionStore -- get()](https://www.servicenow.com/docs/access?context=ClusteringSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [EncoderStore -- get()](https://www.servicenow.com/docs/access?context=EncoderStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [PredictabilityEstimateStore - get()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [RegressionSolutionStore - get()](https://www.servicenow.com/docs/access?context=RegressionSolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [SimilaritySolutionStore - get()](https://www.servicenow.com/docs/access?context=SimilaritySolutionStoreAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       {#ml-api-demo-use__ul_qq2_g3q_3mb}
    2. Acesse a versão mais recente da solução usando o método de solução getLatestVersion() e obtenha seu status de treinamento usando o método de versão getStatus().  

           // Access the latest version of the solution and print its training status
           gs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus(), null, 2)));

       Saída quando o treinamento é concluído:  

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

       {#ml-api-demo-use__table_t1d_wzq_3mb__entry__2}

       | getLatestVersion() | getStatus() |
       |-|-|
       | [ClassificationSolution - getLatestVersion()](https://www.servicenow.com/docs/access?context=ClassificationSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | [ClassificationSolutionVersion - getStatus()](https://www.servicenow.com/docs/access?context=ClassificationSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) |
       | [ClusteringSolution -- getLatestVersion()](https://www.servicenow.com/docs/access?context=ClusteringSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | [ClusteringSolutionVersion -- getStatus()](https://www.servicenow.com/docs/access?context=ClusteringSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) |
       | [Codificador - getLatestVersion()](https://www.servicenow.com/docs/access?context=EncoderAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | [EncoderVersion -- getStatus()](https://www.servicenow.com/docs/access?context=EncoderVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) |
       | [PredictabilityEstimate - getLatestVersion()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | [PredictabilityEstimateVersion - getStatus()](https://www.servicenow.com/docs/access?context=PredictabilityEstimateVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) |
       | [RegressionSolution - getLatestVersion()](https://www.servicenow.com/docs/access?context=RegressionSolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | [RegressionSolutionVersion - getStatus()](https://www.servicenow.com/docs/access?context=RegressionSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) |
       | [SimilaritySolution - getLatestVersion()](https://www.servicenow.com/docs/access?context=SimilaritySolutionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) | [SimilaritySolutionVersion - getStatus()](https://www.servicenow.com/docs/access?context=SimilaritySolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) |
       [ ]

       {#ml-api-demo-use__table_t1d_wzq_3mb}
    {#ml-api-demo-use__ol_nrp_5fl_gmb}

Obter previsões usando uma versão de solução
:   Depois que a solução tiver sido treinada, obtenha a versão treinada e execute uma previsão nela. Obtenha a solução que você criou na loja. Em seguida, escolha a versão treinada e preveja a versão treinada.  
    Nota:  
    Não é possível fazer previsões sobre codificadores e estimativas de previsibilidade.

    1. Obtenha a solução do armazenamento de soluções de classificação usando o método get().  

           // Get the solution created in the first example from the classification solution store
           var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_my_solution_definition');

    2. Use o método get() da API [GlideRecord](https://www.servicenow.com/docs/access?context=c_GlideRecordAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US) para fornecer um registro da tabela Incidente \[incidente\].  

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

    3. Opcional. Configure o parâmetro ClassificationSolutionVersion -- prever() método options para retornar os três principais resultados e retornar todos os resultados.  

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

    4. Declarar uma variável chamada `resultados` e atribuí-la ao trabalho de previsão. Para executar o trabalho de previsão, obtenha a versão da solução mais recente usando o método ClassificationSolution -- getLatestVersion() e chame o método ClassificationSolutionVersion -- prever() nela.  

           var results = mlSolution.getLatestVersion().predict(input, options);

       * [ClassificationSolutionVersion - prever ()](https://www.servicenow.com/docs/access?context=ClassificationSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [ClusteringSolutionVersion -- prever ()](https://www.servicenow.com/docs/access?context=ClusteringSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [RegressionSolutionVersion - prever ()](https://www.servicenow.com/docs/access?context=RegressionSolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       * [SimilaritySolutionVersion - prever ()](https://www.servicenow.com/docs/access?context=SimilaritySolutionVersionAPI&version=xanadu&pubname=xanadu-api-reference&ft:locale=en-US)
       {#ml-api-demo-use__ul_knz_5lq_3mb}
    5. Imprima a saída dos resultados previstos.  

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

       Exemplo de saída de resultados previstos:

           *** Script: {
             "<sys_id>": [
               {
                 "confidence": 99,
                 "threshold": 24.75,
                 "predictedValue": "Email",
                 "predictedSysId": ""
               },
               {
                 "confidence": 5.88210244009169,
                 "threshold": 100,
                 "predictedValue": "Email (I/f)",
                 "predictedSysId": ""
               },
               {
                 "confidence": 2.3461203499840932,
                 "threshold": 14.81,
                 "predictedValue": "Authentication",
                 "predictedSysId": ""
               }
             ]
           }

    {#ml-api-demo-use__ol_njr_2fk_gmb}

