PredictabilityEstimateVersion - 전역

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기12분

    • PredictabilityEstimateVersion API는 저장소에서 예측 인텔리전스 사용되는 스크립팅 가능한 개체입니다.

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

    PredictabilityEstimate 저장소의 PredictabilityEstimate API 개체를 기반으로 예측 가능성 예측 버전으로 작업할 때 이 API를 사용합니다.

    교육이 완료되면 시스템이 최신 버전의 예측 가능성 예상치 활성화하며, 한 번에 하나의 버전만 활성화할 수 있습니다. 그러나 예측을 수행하는 데 사용하려는 이전에 학습된 버전을 활성화할 수 있습니다.

    이 API의 메서드는 다음 PredictabiltyEstimate 메서드를 사용하여 액세스할 수 있습니다.

    PredictabilityEstimateVersion - getProperties()

    예측 가능성 추정 객체 속성을 및 버전 번호가져옵니다.

    표 1. 매개변수
    이름 유형 설명
    없음
    표 2. 반환
    유형 설명
    객체 Dataset 및 PredictabilityEstimate 버전 세부 정보의 내용입니다. 결과는 개체 속성 설정에 따라 달라집니다.
    {
  "datasetProperties": {Object},
  "domainName": "String", 
  "inputFieldNames": [Array],
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "scope": "String",
  "trainingFrequency": "String",
  "versionNumber": "Number"
}
    <Object>.dataset속성

    예측 가능성 예측과 연결된 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 이 데이터 세트와 연결된 도메인 이름입니다. 도메인 분리 및 예측 인텔리전스를 참조하십시오.

    데이터 형식: 문자열.
    <Object>.input필드 이름 추정에 고려할 문자열로 된 후보 입력 필드 목록입니다.

    데이터 형식: 문자열.
    <Object>.isActive 이 버전이 활성 상태인지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 버전이 활성 상태입니다.
    • false: 버전이 활성화되지 않았습니다.

    데이터 유형: 문자열
    <Object>.레이블 예측 작업을 식별합니다. 
    {
  "label": "my first prediction"
}

    데이터 형식: 문자열.
    <Object>.이름 시스템에서 할당한 이름입니다.

    데이터 형식: 문자열.
    <Object>.predictedFieldName 예측 가능성을 교육할 필드를 식별합니다.

    데이터 형식: 문자열.
    <Object>.범위 개체 범위입니다. 현재 유일하게 유효한 값은 global입니다.

    데이터 유형: 문자열
    <Object>.training빈도 모델을 재교육하는 빈도입니다.
    가능한 값:
    • every_30_days
    • every_60_days
    • every_90_days
    • every_120_days
    • every_180_days
    • run_once
    기본값: run_once

    데이터 형식: 문자열.
    <Object>.versionNumber 의 버전 번호 PredictabilityEstimate 객체입니다.

    데이터 형식: 문자열.

    다음 예제에서는 저장소에 있는 활성 개체 버전의 속성을 가져옵니다.

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

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

    출력:

    "datasetProperties": {
    "encodedQuery": "activeANYTHING^EQ",
    "fieldNames": [
      "short_description",
      "category"
    ],
    "tableName": "incident"
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "isActive": "true",
  "label": "Incident Categorization_Trainer",
  "name": "ml_incident_categorization",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

    PredictabilityEstimateVersion - getResults()

    출력 필드에 대해 제안된 입력 필드가 포함된 JSON 결과를 반환합니다.

    표 3. 매개변수
    이름 유형 설명
    없음
    표 4. 반환
    유형 설명
    객체 출력 필드에 대해 제안된 입력 필드 옵션을 포함하는 JSON 객체 결과입니다.
    <Object>.<output field name> 출력 필드 이름(예: 범주)에는 제안된 입력 필드가 포함되어 있습니다.
    {
  "<output field name>": {
    "nominalInputFields": [Array],
    "textInputFields": [Array]
  }
}

    데이터 유형: 객체
    <Object>.<output field name>. 명목상 입력 필드 명목상 입력 필드 상세 정보입니다.
    "nominalInputFields": [
      {
        "fieldName": "String",
        "modelImprovement": "String"     
      }
    ]

    데이터 형식: 배열.
    <Object>.<output field name>. 명목상 입력 필드.필드 이름 명목상 입력 필드 이름입니다.

    데이터 형식: 문자열.
    <Object>.<output field name>. nominalInputFields.modelImprovement 이 필드가 결과를 개선할 수 있는 가능성을 상대적으로 나타내는 점수입니다.

    데이터 형식: 문자열로 된 숫자입니다.
    <Object>.text입력 필드 텍스트 입력 필드 상세 정보.
    
    "textInputFields": [
      {
        "fieldName": "String",
        "density": "String"
      }
    ]

    데이터 형식: 배열.
    <Object>.textInputFields.fieldName 텍스트 입력 필드 이름입니다.

    데이터 형식: 문자열.
    <Object>.textInputFields.density 필드가 비어 있지 않은 빈도를 나타내는 0에서 1.0 사이의 값입니다. 값이 1.0이면 필드가 모든 행에서 비어 있지 않음을 의미하고 값이 0이면 필드가 모든 행에서 비어 있음을 나타냅니다.

    데이터 형식: 문자열로 된 숫자입니다.

    다음 예제에서는 저장소에서 예측 가능성 예상치의 선택한 버전에 대한 결과를 가져오는 방법을 보여 줍니다.

    // Get results
var estimateName = "ml_x_snc_global_global_predictability_estimate;"
var mlEstimate = sn_ml.PredictabilityEstimateStore.get(estimateName);

var results = mlEstimate.getActiveVersion().getResults();

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

    출력:

    {
  "category": {
    "nominalInputFields": [
      {
        "fieldName": "number",
        "modelImprovement": "0.167052396325189"
      },
      {
        "fieldName": "task_effective_number",
        "modelImprovement": "0.167052396325189"
      }
    ],
    "textInputFields": [
      {
        "fieldName": "short_description",
        "density": "1.0"
      }
    ]
  }
}

    PredictabilityEstimateVersion - getStatus(부울 includeDetails)

    교육 완료 상태를 가져옵니다.

    표 5. 매개변수
    이름 유형 설명
    include상세 정보 부울 상태를 반환할지 여부를 나타내는 플래그입니다 details.
    유효한 값은 다음과 같습니다.
    • true: 추가 상세 정보를 반환합니다.
    • false: 추가 세부 정보를 반환하지 않습니다.

    기본값: False
    표 6. 반환
    유형 설명
    객체 다음에 대한 교육 상태 정보를 포함하는 JavaScript 객체PredictabilityEstimate 개체입니다.
    {
  "state": "String",
  "percentComplete": "Number as a String",
  "hasJobEnded": "Boolean value as a String",
  "details": {Object}
}
    <Object>.상태 교육 완료 상태입니다. 훈련 작업이 종료 상태에 도달하면 작업은 해당 상태를 벗어나지 않습니다. 상태가 terminal hasJobEnded 이면 속성이 true로 설정됩니다.
    가능한 값:
    • fetching_files_for_training
    • preparing_data
    • 재시도
    • solution_cancelled (터미널)
    • solution_complete (터미널)
    • solution_error (단말기)
    • solution_incomplete
    • training_request_received
    • training_request_timed_out (터미널)
    • training_solution
    • uploading_solution
    • waiting_for_training

    데이터 유형: 문자열
    <Object>.hasJobEnded 교육이 완료되었는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 교육이 완료되었습니다.
    • false: 교육이 완료되지 않았습니다.

    데이터 유형: 문자열로서의 부울 값
    <Object>.percent완료 교육 완료율입니다. 완료율이 100 미만이면 작업이 종료 상태일 수 있습니다. 예를 들어 교육 시간이 초과되는 경우입니다.

    데이터 형식: 문자열로서의 숫자

    범위: 0 - 100
    <Object>.세부 정보 추가 교육 상세 정보 목록이 포함된 객체입니다.

    데이터 유형: 객체

    다음 예제에서는 교육이 완료된 성공적인 결과를 보여 줍니다.

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

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

    출력:

    {
 "state":"solution_complete",
 "percentComplete":"100",
 "hasJobEnded":"true",
 "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);
}

    다음 예제에서는 학습이 완료된 실패한 결과를 보여 줍니다.

    // Get status
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_my_estimate_definition');
var trainingStatus = mlEstimate.getLatestVersion().getStatus();

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

    출력:

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

    PredictabilityEstimateVersion - getVersionNumber()

    다음의 버전 번호를 가져옵니다. 예측 가능성 추정 객체입니다.

    표 7. 매개변수
    이름 유형 설명
    없음
    표 8. 반환
    유형 설명
    문자열 버전 번호입니다.

    다음 예제에서는 버전 번호를 가져오는 방법을 보여 줍니다.

    // Get version number
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

gs.print("Version number: "+JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getVersionNumber()), null, 2));

    출력:

    Version number: 1