PredictabilityEstimate - 전역

워싱턴 DC API 참조

Release

washingtondc

ft:locale

ko-KR

ft:publication_title

워싱턴 DC API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

PredictabilityEstimate - 전역

릴리스 버전: Washingtondc

업데이트 날짜 2024년 02월 01일

읽기17분

PredictabilityEstimate API는 저장소에서 사용되는 스크립팅 가능한 개체입니다예측 인텔리전스. 이 개체는 데이터 세트의 필드를 얼마나 예측 가능한지, 그리고 이러한 필드를 예측하는 데 유용할 수 있는 기능에 대한 추정치를 제공합니다.

이 API에는 예측 인텔리전스 플러그인(com.glide.platform_ml)이 필요하며 sn_ml 네임스페이스 내에서 제공됩니다.

예측 가능성 추정 설정-교육 흐름은 다음과 같습니다.

DatasetDefinition API를 사용하여 데이터 세트를 만듭니다.
생성자를 사용하여 예측 가능성 추정 개체를 만듭니다.
PredictabilityEstimateStore - add() 메서드를 사용하여 예측 가능성 추정 개체를 예측 가능성 추정 저장소에 추가합니다.
submitTrainingJob() 메서드를 사용하여 예측 가능성 추정치를 훈련시킵니다. 이렇게 하면 PredictabilityEstimateVersion API를 사용하여 관리할 수 있는 개체 버전이 생성됩니다.
PredictabilityEstimateVersion – getResults() 메서드를 사용하여 예상 예측 값을 가져옵니다.

주:

이 API는 전체 권한으로 실행됩니다 . 사용자 액세스를 제한하려면 스크립트에 접근 제어 메커니즘을 포함합니다.

사용 지침은 ML API 사용을 참조하세요.

PredictabilityEstimate - PredictabilityEstimate(config 객체)

예측 가능성 추정치를 생성합니다.

동일한 데이터 집합에 대한 새 예측 가능성 예상치를 얻으려면 이 생성자를 사용하여 고유한 이름의 새 PredictabilityEstimate 개체를 만듭니다.

표 1. 매개변수
이름	유형	설명
구성	객체	의 구성 속성을 포함하는 JavaScript 객체 예측 가능성 추정치. `{ "dataset": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "minRowCount": "String", "predictedFieldName": "String", "trainingFrequency": "String" }`
config.dataset	객체	DatasetDefinition 이름입니다.
config.domainName	문자열	옵션입니다. 이 데이터 세트와 연결된 도메인 이름입니다. Domain Separation 및 예측 인텔리전스을 참조하십시오. 기본값: 현재 도메인(예: `"global"`)
config.inputFieldNames	배열	예상에 고려할 후보 입력 필드 목록(문자열)입니다.
config.label	문자열	예측 작업을 식별합니다.
config.minRowCount	문자열	옵션입니다. 교육을 위해 데이터 세트에 필요한 최소 기록 수입니다. 기본값: 10000
config.predictedFieldName	문자열	예측 가능성을 위해 교육할 필드를 식별합니다.
config.trainingFrequency	문자열	옵션입니다. 모델을 재교육하는 빈도입니다. 가능한 값: every_30_days every_60_days every_90_days every_120_days every_180_days run_once 기본값: run_once

다음 예제에서는 예측 작업을 만들어 PredictabilityEstimate 저장소에 추가하는 방법을 보여 줍니다.

var myIncidentData = new sn_ml.DatasetDefinition({
  'tableName' : 'incident',
  'encodedQuery' : 'activeANYTHING'
});

var myEstimate = new sn_ml.PredictabilityEstimate({
  'label': "predictability estimate",
  'dataset' : myIncidentData,
  'inputFieldNames':['short_description'], 
  'predictedFieldName': 'category'
});

var myEstimateName = sn_ml.PredictabilityEstimateStore.add(myEstimate);

PredictabilityEstimate - cancelTrainingJob()

에 대한 작업을 취소 예측 가능성 추정 객체 교육을 위해 제출

표 2. 매개변수
이름	유형	설명
없음

표 3. 반환
유형	설명
없음

다음 예제에서는 기존 학습 작업을 취소하는 방법을 보여 줍니다.

var myEstimate = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

myEstimate.cancelTrainingJob();

PredictabilityEstimate - getActiveVersion()

활성 항목을 가져옵니다. PredictabilityEstimateVersion 개체입니다.

표 4. 매개변수
이름	유형	설명
없음

표 5. 반환
유형	설명
객체	활성 PredictabilityEstimateVersion 개체입니다.

하는 방법을 보여 줍니다 PredictabilityEstimate 스토어에서 활성 버전을 가져오고 학습 상태를 반환

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

출력:

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

PredictabilityEstimate - getAllVersions()

다음의 모든 버전을 가져옵니다. 예측 가능성 추정치입니다.

표 6. 매개변수
이름	유형	설명
없음

표 7. 반환
유형	설명
배열	솔루션 개체의 기존 버전입니다. 참고 항목 PredictabilityEstimateVersion Api.

다음 예제에서는 모든 PredictabilityEstimate 버전 객체를 가져오고 이 객체에 대해 getVersionNumber() 및 getStatus() 추정 버전 메서드를 호출하는 방법을 보여줍니다.

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

var mlEstimateVersions = mlEstimate.getAllVersions();

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

출력:

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

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

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

PredictabilityEstimate - getLatestVersion()

의 최신 버전을 가져옵니다. 예측 가능성 추정치입니다.

표 8. 매개변수
이름	유형	설명
없음

표 9. 반환
유형	설명
객체	PredictabilityEstimateVersion 의 최신 버전에 해당하는 객체 a PredictabilityEstimate()를 사용합니다.

다음 예제에서는 최신 버전의 솔루션을 가져오고 학습 상태를 반환하는 방법을 보여 줍니다 예측 가능성 추정 및 교육 상태 반환

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

출력:

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

PredictabilityEstimate - getName()

저장소와의 상호 작용에 사용할 객체의 이름을 가져옵니다.

표 10. 매개변수
이름	유형	설명
없음

표 11. 반환
유형	설명
문자열	예상 객체의 이름입니다.

다음 예제에서는 PredictabilityEstimate 데이터 집합 정보를 업데이트하고 개체의 이름을 인쇄하는 방법을 보여 줍니다.

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

var myEstimate = new sn_ml.PredictabilityEstimate({
   'label': "my estimate",
   'dataset' : myIncidentData,
   'inputFieldNames':['short_description'],
   'predictedFieldName': 'category'
});

// update estimate
sn_ml.PredictabilityEstimateStore.update('ml_x_snc_global_global_my_definition_4', myEstimate);

// print estimate name
gs.print('Estimate Name: '+myEstimate.getName());

출력:

Estimate Name: ml_x_snc_global_global_my_definition_4

PredictabilityEstimate - getProperties()

예측 가능성 추정 개체 속성을 가져옵니다.

표 12. 매개변수
이름	유형	설명
없음

표 13. 반환
유형	설명
객체	PredictabilityEstimateStore의 Dataset 및 PredictabilityEstimate() 개체 세부 정보의 내용입니다. `{ "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String" }`
<Object>.datasetProperties	예상치와 연결된 DatasetDefinition() 객체의 속성을 나열합니다. `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }`
<Object>.datasetProperties.tableName	데이터 세트의 테이블 이름입니다. 예: `"tableName" : "Incident"`. 데이터 유형: 문자열.
<Object>.datasetProperties.fieldNames	지정된 테이블의 필드 이름 목록(문자열)입니다. 예를 들어 `"fieldNames" : ["short_description", "priority"]입니다`. 데이터 유형: 배열.
<Object>.datasetProperties.fieldNames.fieldDetails	필드 속성을 지정하는 JavaScript 객체의 목록입니다. `[ { "name": "String", "type": "String" } ]` 데이터 유형: 배열.
<Object>.datasetProperties.fieldNames.fieldDetails.입니다.<object> 이름	이 데이터 세트를 제한할 정보 유형을 정의하는 필드의 이름입니다. 데이터 유형: 문자열.
<Object>.datasetProperties.fieldDetails.입니다.<object> 형식	머신 러닝 필드 유형입니다. 데이터 유형: 문자열.
<Object>.datasetProperties.fieldDetails.encodedQuery	표준 Glide 형식으로 인코딩된 쿼리 문자열입니다. 인코딩된 쿼리 문자열을 참조하세요. 데이터 유형: 문자열.
<Object>.Domainname	이 데이터 세트와 연결된 도메인 이름입니다. Domain Separation 및 예측 인텔리전스을 참조하십시오. 데이터 유형: 문자열.
<Object>.inputField이름	예상에 고려할 후보 입력 필드 목록(문자열)입니다. 데이터 유형: 문자열.
<Object>.레이블	예측 작업을 식별합니다. `{ "label": "my first prediction" }` 데이터 유형: 문자열.
<Object>.이름	시스템에서 할당한 이름입니다. 데이터 유형: 문자열.
<Object>.predictedFieldName	예측 가능성을 위해 교육할 필드를 식별합니다. 데이터 유형: 문자열.
<Object>.범위	개체 범위입니다. 현재 유일하게 유효한 값은 `global`입니다. 데이터 유형: 문자열
<Object>.trainingFrequency	모델을 재교육하는 빈도입니다. 가능한 값: every_30_days every_60_days every_90_days every_120_days every_180_days run_once 기본값: run_once 데이터 유형: 문자열.

다음 예제에서는 예측 가능성 추정 객체 저장소에 있는

var mySolution = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

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

출력:

*** Script: {
  "datasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "category",
      "short_description",
      "priority",
      "assignment_group.name"
    ],
    "fieldDetails": [
      {
        "name": "category",
        "type": "nominal"
      },
      {
        "name": "short_description",
        "type": "text"
      }
    ]
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "label": "my estimate definition",
  "name": "ml_x_snc_global_global_my_definition_26",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

PredictabilityEstimate - getVersion(버전 문자열)

예측 가능성 예상치를 가져옵니다. 제공된 버전 번호로.

표 14. 매개변수
이름	유형	설명
version	문자열	의 기존 버전 번호 예측 가능성 추정치입니다.

표 15. 반환
유형	설명
객체	PredictabilityEstimateVersion API 메서드를 호출할 수 있는 PredictabilityEstimate() 객체의 지정된 버전입니다.

의 교육 상태를 가져오는 방법을 보여 버전 번호별 예측 가능성 예상치입니다.

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

출력:

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

PredictabilityEstimate - setActiveVersion(version 문자열)

저장소에서 예측 가능성 예상치의 지정된 버전을 활성화합니다.

표 16. 매개변수
이름	유형	설명
version	문자열	활성화할 PredictabilityEstimate() 객체 버전의 이름입니다. 이 버전을 활성화하면 다른 버전은 비활성화됩니다.

표 17. 반환
유형	설명
없음

활성화하는 방법을 보여 예측 가능성 예상치 저장소에서 솔루션 버전을

sn_ml.PredictabilityEstimate.setActiveVersion("ml_x_snc_global_global_my_estimate_definition");

PredictabilityEstimate - submitTrainingJob()

교육 작업을 제출합니다.

주:

이 메서드를 실행하기 전에 먼저 PredictabilityEstimateStore - add() 메서드를 사용하여 저장소에 예측 가능성 추정치를 추가해야 합니다.

표 18. 매개변수
이름	유형	설명
없음

표 19. 반환
유형	설명
객체	PredictabilityEstimateVersion 개체에 해당하는 개체입니다 PredictabilityEstimate 학습 중인

다음 예제에서는 데이터 세트를 만들고, 솔루션에 적용 예측 가능성 예상치, 추가 저장소에 솔루션을 추가하고, 학습 작업을 제출하는 방법을 보여 줍니다.

// 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);

// Train the estimate - this is a long running job 
var myEstimateVersion = myEstimate.submitTrainingJob();