--- 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 --- # RegressionSolutionVersion - Global # RegressionSolutionVersion - Global {#ariaid-title1} * Versão de lançamento: Xanadu * * Atualizado 1 de ago. de 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 min. de leitura A API RegressionSolutionVersion é um objeto programável usado em armazenamentos Inteligência preditiva. Este A API requer o plug-in Inteligência preditiva (com.glide.platform_ml) e é fornecida no namespace `sn_ml`. Use esta API ao trabalhar com versões de solução baseadas em objetos da [API RegressionSolution](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSolutionAPI "A API RegressionSolution é um objeto programável usado em armazenamentos Inteligência preditiva.") no [armazenamento RegressionSolution](https://servicenow-prod.fluidtopics.net/z0RQHQ_HdbMWRwcqpzKQsw#RegressionSolutionStoreAPI "Habilita o armazenamento e a recuperação de soluções."). O sistema cria uma versão de solução sempre que você treina uma definição de solução. A maioria das versões é criada durante o treinamento programado da solução. Os métodos nesta API podem ser acessados usando os seguintes métodos RegressionSolution : * [getActiveVersion()](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSol-getActiveVersion "Objeto Obtém o ativo RegressionSolutionVersion.") * [getAllVersions()](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSol-getAllVersions "Obtém todas as versões de um objeto RegressionSolution.") * [getLatestVersion()](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSol-getLatestVersion "Obtém a versão mais recente de uma solução.") * [getVersion()](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSol-getVersion_S "Obtém uma solução pelo número de versão fornecido.") {#RegressionSolutionVersionAPI__ul_ycl_fzf_tlb} ## RegressionSolutionVersion - getProperties() {#ariaid-title2} Obtém propriedades do objeto de solução e número da versão. {#RegressionVersion-getProperties__table_d2m_zwz_4lb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | Nenhum | | | [Tabela 1. Parâmetros] {#RegressionVersion-getProperties__table_d2m_zwz_4lb} {#RegressionVersion-getProperties__table_e2m_zwz_4lb__entry__2} | Tipo | Descrição | |-|-| | Objeto | Conteúdos dos detalhes da versão do Dataset e [RegressionSolution](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSol-RegressionSolution_O "Cria uma solução de regressão."). Os resultados variam de acordo com a configuração da propriedade do objeto. { "datasetProperties": {Object}, "domainName": "String", "encoder": {Object}, "inputFieldNames": [Array], "isActive": Boolean, "label": "String", "name": "String", "predictedFieldName": "String", "predictedInterval": [Array], "processingLanguage": "String", "scope": "String", "stopwords": [Array], "versionNumber": "Number" } | | \.datasetProperties | Lista as propriedades do objeto [DatasetDefinition()](https://servicenow-prod.fluidtopics.net/o4nUJYO4X4WKz2l8yyx5lw#DDef-DatasetDefinition_O "Cria uma instância da classe DatasetDefinition, permitindo que você defina um conjunto de dados por nome de tabela, campos e consulta.") associado à solução. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } | | \.datasetProperties.tableName | Nome da tabela para o conjunto de dados. Por exemplo, `"tableName" : "Incidente"`. Tipo de dados: cadeia de caracteres. | | \.datasetProperties.fieldNomes | Lista de nomes de campo da tabela especificada como cadeias de caracteres. Por exemplo, `"fieldNames" : ["short_description", "priority"]`. Tipo de dados: matriz. | | \.datasetProperties.fieldNames.fieldDetails | Lista de objetos JavaScript que especificam propriedades de campo. [ { "name": "String", "type": "String" } ] Tipo de dados: matriz. | | \.datasetProperties.fieldNames.fieldDetails.\.nome | Nome do campo que define o tipo de informação ao qual este conjunto de dados será restrito. Tipo de dados: cadeia de caracteres. | | \.datasetProperties.fieldDetails.\.type | Tipo de campo de aprendizado de máquina. Tipo de dados: cadeia de caracteres. | | \.datasetProperties.fieldDetails.encodedQuery | Cadeia de caracteres de consulta codificada no formato Glide padrão. Consulte Cadeias de [caracteres de consulta codificadas](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). Tipo de dados: cadeia de caracteres. | | \.domainName | Nome do domínio associado a este conjunto de dados. Consulte [Separação de domínios 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). Tipo de dados: cadeia de caracteres. | | \.codificador | Objeto de codificador atribuído a esta solução. Consulte [Codificador - Codificador (configuração de objeto)](https://servicenow-prod.fluidtopics.net/DHEI1a5CyrgJeY0rkmQ1yw#Encoder-Encoder_O "Cria um codificador."). Tipo de dados: objeto. | | \.inputFieldNames | Lista de nomes de campos de entrada como cadeias de caracteres. O modelo usa esses campos usados para fazer previsões. Tipo de dados: cadeia de caracteres. | | \.isActive | Sinalizador que indica se esta versão está ativa. Valores válidos: * verdadeiro: a versão está ativa. * falso: a versão não está ativa. {#RegressionVersion-getProperties__ul_i5m_lp1_dmb} Tipo de dados: cadeia de caracteres | | \.rótulo | Identifica a tarefa de previsão. { "label": "my first prediction" } Tipo de dados: cadeia de caracteres. | | \.nome | Nome atribuído pelo sistema. Tipo de dados: cadeia de caracteres. | | \.predictedFieldName | Identifica um campo a ser treinado para previsibilidade. Tipo de dados: cadeia de caracteres. | | \.predictedInterval | Intervalo de valores que especifica o nível de confiança da previsão. Tipo de dados: matriz | | \.processingLanguage | Idioma de processamento no formato de código de idioma ISO 639-1 de duas letras. Tipo de dados: cadeia de caracteres. | | \.escopo | Escopo do objeto. Atualmente, o único valor válido é `global`. Tipo de dados: cadeia de caracteres | | \.palavras irrelevantes | Opcional. Lista predefinida de cadeias de caracteres que o sistema gera automaticamente com base na configuração da propriedade language. Para obter detalhes, consulte [Criação de uma lista de palavras irrelevantes personalizada](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). Tipo de dados: matriz. | | \.versionNumber | Objeto Número da versão do RegressionSolution. | [Tabela 2. Retorna] {#RegressionVersion-getProperties__table_e2m_zwz_4lb} O exemplo a seguir obtém propriedades da versão do objeto ativo no armazenamento. // Get properties var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization'); gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2)); Saída: { "datasetProperties": { "encodedQuery": "", "fieldNames": [ "short_description", "sourcedc", "targetdc", "dbsize", "duration" ], "tableName": "cloudinfratext" }, "domainName": "global", "encoderProperties": { "datasetsProperties": [], "name": "wc_regression" }, "inputFieldNames": [ "short_description", "sourcedc", "targetdc", "dbsize" ], "isActive": "true", "label": "Regression Test for DB Restore", "name": "ml_x_snc_global_global_regression", "predictedFieldName": "duration", "processingLanguage": "en", "stopwords": [ "Default English Stopwords" ], "versionNumber": "1" } ## RegressionSolutionVersion - getStatus(Boolean includeDetails) {#ariaid-title3} Obtém o status de conclusão do treinamento. {#RegressionVersion-getStatus_B__table_xfh_vbw_plb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | includeDetails | Booliano | Sinalizador que indica se o status deve ser retornado details. Valores válidos: * verdadeiro: retorna detalhes adicionais. * falso: não retorna detalhes adicionais. {#RegressionVersion-getStatus_B__ul_n33_ckw_plb} Padrão: falso | [Tabela 3. Parâmetros] {#RegressionVersion-getStatus_B__table_xfh_vbw_plb} {#RegressionVersion-getStatus_B__table_yfh_vbw_plb__entry__2} | Tipo | Descrição | |-|-| | Objeto | Objeto JavaScript que contém informações de status de treinamento para um objeto [RegressionSolution](https://servicenow-prod.fluidtopics.net/fIHl7Kb~Ez8oih5Ywiil2Q#RegressionSolutionAPI "A API RegressionSolution é um objeto programável usado em armazenamentos Inteligência preditiva."). { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} } | | \.estado | Estado de conclusão do treinamento. Se o trabalho de treinamento atingir um estado terminal, o trabalho não sairá desse estado. Se o estado for terminal, a propriedade hasJobEnded será definida como `verdadeira`. Valores possíveis: * buscando_arquivos_para_treinamento * preparação_dados * tentar novamente * solution_cancelled (terminal) * solution_complete (terminal) * solution_error (terminal) * solução_incompleta * treinamento_request_recebido * treinamento_request_timed_out (terminal) * solução_treinamento * carregando_solução * aguardando_treinamento {#RegressionVersion-getStatus_B__ul_a5q_gh4_vlb} Tipo de dados: cadeia de caracteres | | \.hasJobEnded | Sinalizador que indica se o treinamento foi concluído. Valores válidos: * verdadeiro: o treinamento está concluído. * falso: o treinamento está incompleto. {#RegressionVersion-getStatus_B__ul_icy_zjx_rlb} Tipo de dados: valor booliano como cadeia de caracteres | | \.percentConcluído | Percentual de treinamento concluído. Se a porcentagem de conclusão for inferior a 100, o trabalho poderá estar em um estado terminal. Por exemplo, se o treinamento expirar. Tipo de dados: número como cadeia de caracteres Intervalo: 0 a 100 | | \.detalhes | Objeto que contém uma lista de detalhes de treinamento adicionais. Tipo de dados: objeto | [Tabela 4. Retorna] {#RegressionVersion-getStatus_B__table_yfh_vbw_plb} O exemplo a seguir mostra um resultado bem-sucedido com o treinamento concluído. // Get status var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization'); gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2))); Saída: { "state":"solution_complete", "percentComplete":"100", "hasJobEnded":"true", "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true); } O exemplo a seguir mostra um resultado malsucedido com o treinamento concluído. // Get status var solutionName = 'ml_x_snc_global_global_regression_solution'; var mlSolution = sn_ml.RegressionSolutionStore.get(solutionName); var trainingStatus = mlSolution.getLatestVersion().getStatus(); gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2)); Saída: { "state":"solution_error", "percentComplete":"100", "hasJobEnded":"true" } ## RegressionSolutionVersion - getVersionNumber() {#ariaid-title4} Obtém o número da versão de um objeto de solução. {#RegressionVersion-getVersionNumber__table_jsz_sbw_plb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | Nenhum | | | [Tabela 5. Parâmetros] {#RegressionVersion-getVersionNumber__table_jsz_sbw_plb} {#RegressionVersion-getVersionNumber__table_ksz_sbw_plb__entry__2} | Tipo | Descrição | |-|-| | Cadeia de caracteres | Número da versão. | [Tabela 6. Retorna] {#RegressionVersion-getVersionNumber__table_ksz_sbw_plb} O exemplo a seguir mostra como obter um número de versão. // Get version number var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization'); gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2)); Saída: Version number: 1 ## RegressionSolutionVersion - prever (entrada de objeto, opções de objeto) {#ariaid-title5} Obtém os dados de entrada para uma previsão. {#RegressionVersion-predict_O_O__table_wwz_pbw_plb__entry__3} | Nome | Tipo | Descrição | |-|-|-| | entrada | Objeto | [GlideRecord](https://servicenow-prod.fluidtopics.net/MVDQAzAUPvxIFzjBauTu9Q#c_GlideRecordAPI "A API GlideRecord é usada para operações de banco de dados.") ou matriz de objetos JSON que contém nomes e valores de campo como pares de chave-valor. | | opções | Objeto | Valores opcionais para filtrar resultados de previsão. { "apply_threshold": Boolean, "top_n": Number } | | opções.apply_threshold | Booliano | Sinalizador que indica se o valor de limite da solução deve ser verificado e aplicado ao conjunto de resultados. Valores válidos: * verdadeiro: retorna resultados em que a confiança é maior que o limite. * falso: retorna todos os resultados. {#RegressionVersion-predict_O_O__ul_f4d_xyx_slb} Padrão: verdadeiro | | opções.top_n | Número | Se fornecido, retorna os principais resultados, até o número especificado de previsões. | [Tabela 7. Parâmetros] {#RegressionVersion-predict_O_O__table_wwz_pbw_plb} {#RegressionVersion-predict_O_O__table_xwz_pbw_plb__entry__2} | Tipo | Descrição | |-|-| | Objeto | Objeto JSON que contém os resultados da previsão classificados por sys_id ou record_number. { : [Array] } | | \.\ | Lista de objetos com detalhes para cada resultado de previsão. Tipo de dados: matriz de objetos : [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ] | | \.\ .\.confiança | Valor da confiança associada à previsão. Por exemplo, 53,84. Tipo de dados: número | | \.\ .\.predictedSysId | O sys_id do valor previsto. Os resultados podem ser de qualquer tabela na qual as informações estão sendo previstas. Tipo de dados: cadeia de caracteres | | \.\ .\.predictedValue | Valor que representa o resultado da previsão. Tipo de dados: cadeia de caracteres | | \.\ .\.threshold | Valor do limite configurado associado à previsão. Tipo de dados: número | [Tabela 8. Retorna] {#RegressionVersion-predict_O_O__table_xwz_pbw_plb} O exemplo a seguir mostra como exibir resultados de previsão para um método de previsão () que usa um GlideRecord por sys_id como entrada e inclui parâmetros opcionais para restringir aos três principais resultados e excluir o valor limite. var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization'); // single GlideRecord input var input = new GlideRecord("incident"); input.get(""); // configure optional parameters var options = {}; options.top_n = 3; options.apply_threshold = false; var results = mlSolution.getVersion(1).predict(input, options); // pretty print JSON results gs.print(JSON.stringify(JSON.parse(results), null, 2)); { "": [ { "confidence": 62.10782320780268, "threshold": 20.36, "predictedValue": "Clone Issues", "predictedSysId": "" }, { "confidence": 6.945237375770391, "threshold": 16.63, "predictedValue": "Instance Administration", "predictedSysId": "" }, { "confidence": 5.321061076300759, "threshold": 23.7, "predictedValue": "Administration", "predictedSysId": "" } ] } O exemplo a seguir mostra como exibir resultados de previsão para um método de previsão () que usa uma matriz de nomes de campo como pares de chave-valor para entrada e inclui parâmetros opcionais para restringir aos três principais resultados e excluir o valor limite. var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization'); // key-value pairs input var input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}]; // configure optional parameters var options = {}; options.top_n = 3; options.apply_threshold = false; var results = mlSolution.predict(input, options); // pretty print JSON results gs.print(JSON.stringify(JSON.parse(results), null, 2)); { "1": [ { "confidence": 37.5023032262591, "threshold": 10.72, "predictedValue": "Authentication", "predictedSysId": "" }, { "confidence": 24.439964862166583, "threshold": 23.7, "predictedValue": "Administration", "predictedSysId": "" }, { "confidence": 11.736320486031047, "threshold": 100, "predictedValue": "Security", "predictedSysId": "" } ], "2": [ { "confidence": 99, "threshold": 17.77, "predictedValue": "Email", "predictedSysId": "" }, { "confidence": 3.182137005157543, "threshold": 10.72, "predictedValue": "Authentication", "predictedSysId": "" }, { "confidence": 2.8773826570713514, "threshold": -1, "predictedValue": "Email (I/f)", "predictedSysId": "" } ] }