SimilaritySolution - 전역

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 07월 31일
  • 소요 시간: 19분
  • SimilaritySolution API는 상점에서 사용되는 예측 인텔리전스 스크립트 가능한 객체입니다.

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

    솔루션 설정-교육 플로우는 다음과 같습니다.
    1. 인코더 API를 사용하여 인코더를 빌드합니다.
    2. 생성자를 사용하여 유사성 솔루션 객체를 만듭니다.
    3. SimilaritySolutionStore - add() 메서드를 사용하여 유사성 솔루션 저장소에 솔루션 객체를 추가합니다.
    4. submitTrainingJob() 메서드를 사용하여 솔루션을 교육합니다. 이렇게 하면 SimilaritySolutionVersion API를 사용하여 관리할 수 있는 객체의 버전이 생성됩니다.
    5. SimilaritySolutionVersion – predict() 메서드를 사용하여 예측을 가져옵니다.
    주:
    이 API는 Vancouver 패치 7 핫픽스 2b 및 Washington DC 패치 7 릴리스 전에 모든 권한으로 실행됩니다. 이후 릴리스에서는 ACL을 사용하여 액세스 권한을 부여합니다. 자세한 내용은 다음 문서를 참조하십시오 Query ACLs.

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

    SimilaritySolution - SimilaritySolution(객체 구성)

    유사성 솔루션을 작성합니다.

    표 1. 매개변수
    이름 유형 설명
    구성 객체 의 구성 속성을 포함하는 JavaScript 객체 용액.
    {  
      "domainName": "String",
      "encoder": {Object},
      "label": "String",
      "lookupDataset": {Object},
      "minRowCount": "String",
      "processingLanguage": "String",
      "stopwords": [Array],
      "testDataset": {Object},
      "trainingFrequency": "String",
      "updateFrequency": "String"
    }
    config.domainName 문자열 옵션입니다. 이 데이터 세트와 연결된 도메인 이름입니다. 도메인 분리 및 예측 인텔리전스를 참조하십시오.

    기본값: 현재 도메인(예: "global").

    config.encoder 객체 이 솔루션에 할당할 학습된 인코더 객체입니다. 인코더 - 인코더(객체 구성) 문서를 참조하십시오.
    config.label 문자열 예측 작업을 식별합니다.
    config.lookupDataset 객체 조회 세트로 사용할 DatasetDefinition 의 이름입니다.
    config.minRowCount 문자열 옵션입니다. 교육을 위해 데이터 세트에 필요한 최소 레코드 수입니다.

    기본값: 10000

    config.processingLanguage 문자열 옵션입니다. 두 글자 ISO 639-1 언어 코드 형식의 처리 언어입니다.

    기본값: "en"

    config.stopwords 배열 옵션입니다. 속성 설정에 따라 language 시스템이 자동으로 생성하는 문자열의 사전 설정 목록입니다. 자세한 내용은 사용자 지정 중지 단어 목록 만들기를 참조하세요.

    기본값: 영어 스톱 워드

    config.testDataset 객체 결과와의 lookupDataset 유사성을 스캔할 DatasetDefinition의 이름입니다.
    config.trainingFrequency 문자열 옵션입니다. 모델을 재교육하는 빈도입니다.
    가능한 값:
    • every_30_days
    • every_60_days
    • every_90_days
    • every_120_days
    • every_180_days
    • run_once
    기본값: run_once
    config.updateFrequency 솔루션 정의에 대한 모델을 재구축해야 하는 빈도입니다.
    가능한 값:
    • do_not_update
    • every_1_day
    • every_1_hour
    • every_6_hours
    • every_12_hours
    • every_1_minute
    • every_15_minutes
    • every_30_minutes
    기본값: do_not_update

    다음 예제에서는 개체를 만들고 SimilaritySolution 스토어.

    var incidentData = new sn_ml.DatasetDefinition({
            'tableName' : 'incident',
            'fieldNames' : ['category', 'short_description']        
        });
        var kbData = new sn_ml.DatasetDefinition({
            'tableName' : 'kb_knowledge',
            'fieldNames' : ['short_description'],
            'encodedQuery' : 'active=true'
        });
        var encoder = sn_ml.EncoderStore.get('GloVe');
        var mySolution = new sn_ml.SimilaritySolution({
            'label': "similarity solution",
            'lookupDataset' : kbData,
            'testDataset' : incidentData,        
            'encoder' : encoder        
        });
        
        // add solution
        var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);

    유사성 솔루션 - cancelTrainingJob()

    대한 작업을 취소합니다 솔루션 객체 교육을 위해 제출된

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

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

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity');
    
    mySolution.cancelTrainingJob();

    SimilaritySolution - getActiveVersion()

    활성 항목을 가져옵니다. SimilaritySolutionVersion 객체입니다.

    표 4. 매개변수
    이름 유형 설명
    없음
    표 5. 반환
    유형 설명
    객체 Active SimilaritySolutionVersion 객체입니다.

    방법을 보여 줍니다 SimilaritySolution 저장소에서 활성 버전을 가져오고 학습 상태를 반환하는

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_similarity');
    
    gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus()), null, 2));

    출력:

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

    SimilaritySolution - getAllVersions()

    의 모든 버전을 가져옵니다.SimilaritySolution 개체입니다.

    표 6. 매개변수
    이름 유형 설명
    없음
    표 7. 반환
    유형 설명
    배열 솔루션 객체의 기존 버전입니다. 참고 항목 SimilaritySolutionVersion API를 사용합니다.

    다음 예는 모든 SimilaritySolution 버전 객체를 가져오고 getVersionNumber()getStatus() 솔루션 버전 메소드를 호출하는 방법을 보여줍니다.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_Similarity');
    
    var mlSolutionVersions = mlSolution.getAllVersions();
    
    for (i = 0; i < mlSolutionVersions.length; i++) {
    gs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\n");
    

    출력:

    Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}
    
    Version 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}
    
    Version 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}

    SimilaritySolution - getLatestVersion()

    의 최신 버전을 가져옵니다. 해결책.

    표 8. 매개변수
    이름 유형 설명
    없음
    표 9. 반환
    유형 설명
    객체 SimilaritySolutionVersion 최신 버전에 해당하는 객체 A SimilaritySolution입니다.

    다음 예제에서는 최신 버전의 솔루션을 가져오고 학습 상태를 반환하는 방법을 보여 줍니다 .

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_Similarity');
    
    gs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus()), null, 2));

    출력:

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

    SimilaritySolution - getName()

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

    표 10. 매개변수
    이름 유형 설명
    없음
    표 11. 반환
    유형 설명
    문자열 솔루션 객체의 이름입니다.

    방법을 보여 줍니다 SimilaritySolution 데이터 집합 정보를 업데이트하고 개체 이름을 인쇄하는

    // Update solution
    var myIncidentData = new sn_ml.DatasetDefinition({
       'tableName' : 'incident',
       'fieldNames' : ['category', 'short_description', 'priority'],
       'encodedQuery' : 'activeANYTHING'
    });
    
    var eligibleFields = JSON.parse(myIncidentData.getEligibleFields('Similarity'));
    
    var mySimilarity = new sn_ml.SimilaritySolution({
       'label': "my Similarity solution",
       'dataset' : myIncidentData,
       'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
       'predictedFieldName': 'category'
    });
    
    // update solution
    sn_ml.SimilaritySolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', mySimilarity);
    
    // print solution name
    gs.print('Solution Name: '+mySimilarity.getName());

    출력:

    Solution Name: ml_x_snc_global_global_my_solution_definition_4

    SimilaritySolution - getProperties()

    솔루션 객체 속성 가져오기.

    표 12. 매개변수
    이름 유형 설명
    없음
    표 13. 반환
    유형 설명
    객체 Dataset의 내용 및 SimilaritySolution() 개체 세부 정보는 SimilaritySolutionStore에 있습니다.
    {
      "domainName": "String",
      "encoder": {Object},
      "label": "String",
      "lookupDatasetProperties": {Object},
      "name": "String",
      "processingLanguage": "String",
      "scope": "String",
      "stopwords": [Array],
      "testDatasetProperties": {Object},
      "trainingFrequency": "String",
      "updateFrequency": "String"
    }
    <Object>.domainName 이 데이터 세트와 연결된 도메인 이름입니다. 도메인 분리 및 예측 인텔리전스를 참조하십시오.

    데이터 형식: 문자열.

    <Object>.인코더 이 솔루션에 할당된 인코더 개체입니다. 인코더 - 인코더(객체 구성) 문서를 참조하십시오.

    데이터 형식: 개체.

    <Object>.레이블 예측 작업을 식별합니다.
    {
      "label": "my first prediction"
    }

    데이터 형식: 문자열.

    <Object>.lookupDatasetProperties DatasetDefinition() 조회 세트로 사용되는 객체입니다. 에 대한 세부 정보
    {
      "encodedQuery": "String",
      "fieldDetails": [Array],
      "fieldNames": [Array],
      "tableName": "String"
    }

    데이터 형식: 개체.

    <Object>.lookupDatasetProperties.tableName 데이터 세트의 테이블 이름입니다. 예: "tableName" : "Incident".

    데이터 형식: 문자열.

    <Object>.lookupDatasetProperties.fieldNames 문자열로 지정된 테이블의 필드 이름 목록입니다. 예: "fieldNames" : ["short_description", "priority"].

    데이터 형식: 배열.

    <Object>.lookupDatasetProperties.fieldNames.fieldDetails 필드 속성을 지정하는 JavaScript 객체의 목록입니다.
    [
      {
        "name": "String",
        "type": "String"
      }
    ]

    데이터 형식: 배열.

    <Object>.lookupDatasetProperties.fieldNames.fieldDetails.<object>. 이름 이 데이터 세트를 제한할 정보의 유형을 정의하는 필드의 이름입니다.

    데이터 형식: 문자열.

    <Object>.lookupDatasetProperties.fieldDetails.<object>. 형 머신 러닝 필드 유형입니다.

    데이터 형식: 문자열.

    <Object>.lookupDatasetProperties.fieldDetails.encodedQuery 표준 Glide 형식으로 인코딩된 쿼리 문자열입니다. 인코딩된 쿼리 문자열을 참조하세요.

    데이터 형식: 문자열.

    <Object>.이름 시스템에서 할당한 이름입니다.

    데이터 형식: 문자열.

    <Object>.processingLanguage 두 글자 ISO 639-1 언어 코드 형식의 처리 언어입니다.

    데이터 형식: 문자열.

    <Object>.범위 객체 범위입니다. 현재 유일하게 유효한 값은 전역입니다.

    데이터 유형: 문자열

    <Object>.stopwords 옵션입니다. 속성 설정에 따라 language 시스템이 자동으로 생성하는 문자열의 사전 설정 목록입니다. 자세한 내용은 사용자 지정 중지 단어 목록 만들기를 참조하세요.

    데이터 형식: 배열.

    <Object>.testDatasetProperties DatasetDefinition() 이 모델에서 검색된 결과와 에서 찾은 lookupDataset결과 간의 유사성을 검색하는 데 사용되는 객체입니다. 에 대한 세부 정보
    {
      "encodedQuery": "String",
      "fieldDetails": [Array],
      "fieldNames": [Array],
      "tableName": "String"
    }

    데이터 형식: 개체.

    <Object>.testDatasetProperties.tableName 데이터 세트의 테이블 이름입니다. 예: "tableName" : "Incident".

    데이터 형식: 문자열.

    <Object>.testDatasetProperties.fieldNames 문자열로 지정된 테이블의 필드 이름 목록입니다. 예: "fieldNames" : ["short_description", "priority"].

    데이터 형식: 배열.

    <Object>.testDatasetProperties.fieldNames.fieldDetails 필드 속성을 지정하는 JavaScript 객체의 목록입니다.
    [
      {
        "name": "String",
        "type": "String"
      }
    ]

    데이터 형식: 배열.

    <Object>.testDatasetProperties.fieldNames.fieldDetails.<object>. 이름 이 데이터 세트를 제한할 정보의 유형을 정의하는 필드의 이름입니다.

    데이터 형식: 문자열.

    <Object>.testDatasetProperties.fieldDetails.<object>. 형 머신 러닝 필드 유형입니다.

    데이터 형식: 문자열.

    <Object>.testDatasetProperties.fieldDetails.encodedQuery 표준 Glide 형식으로 인코딩된 쿼리 문자열입니다. 인코딩된 쿼리 문자열을 참조하세요.

    데이터 형식: 문자열.

    <Object>.trainingFrequency 모델을 재교육하는 빈도입니다.
    가능한 값:
    • every_30_days
    • every_60_days
    • every_90_days
    • every_120_days
    • every_180_days
    • run_once
    기본값: run_once

    데이터 형식: 문자열.

    <Object>.updateFrequency 솔루션 정의에 대한 모델을 재구축해야 하는 빈도입니다.
    가능한 값:
    • do_not_update
    • every_1_day
    • every_1_hour
    • every_6_hours
    • every_12_hours
    • every_1_minute
    • every_15_minutes
    • every_30_minutes
    기본값: do_not_update

    데이터 유형: 문자열

    다음 예제에서는저장소에 있는 솔루션 개체의 속성을 가져옵니다.

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity_solution');
    
    gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));
    출력:
    *** Script: {
      "domainName": "global",
      "encoderProperties": {
        "datasetsProperties": [],
        "name": "wordCorpusA"
      },
      "label": "similarity",
      "lookupDatasetProperties": {
        "tableName": "incident",
        "fieldNames": [
          "short_description"
        ]
      },
      "name": "ml_x_snc_global_global_similarity",
      "processingLanguage": "en",
      "scope": "global",
      "stopwords": [
        "Default English Stopwords"
      ],
      "testDatasetProperties": {
        "tableName": "incident",
        "fieldNames": [
          "short_description"
        ]
      },
      "trainingFrequency": "every_30_days",
      "updateFrequency": "do_not_update"
    }

    SimilaritySolution - getVersion(문자열 버전)

    솔루션 가져오기 제공된 버전 번호로.

    표 14. 매개변수
    이름 유형 설명
    버전 문자열 솔루션의 기존 버전 번호입니다.
    표 15. 반환
    유형 설명
    객체 SimilaritySolutionVersion API 메서드를 호출할 수 있는 지정된 버전의 SimilaritySolution() 객체입니다.

    다음 예제에서는 버전 번호로 솔루션의 학습 상태를 가져오는 방법을 보여 줍니다.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_similarity');
    
    gs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));

    출력:

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

    SimilaritySolution - setActiveVersion(문자열 버전)

    스토어에서 지정된 버전의 솔루션을 활성화합니다.

    표 16. 매개변수
    이름 유형 설명
    버전 문자열 활성화할 SimilaritySolution() 객체 버전의 이름입니다.

    이 버전을 활성화하면 다른 버전은 비활성화됩니다.

    표 17. 반환
    유형 설명
    없음

    다음 예는 저장소에서 솔루션 버전을활성화하는 방법을 보여줍니다.

    sn_ml.SimilaritySolution.setActiveVersion("ml_incident_categorization");

    유사성 솔루션 - submitTrainingJob()

    교육 작업을 제출합니다.

    주:
    이 메서드를 실행하기 전에 먼저 SimilaritySolutionStore - add() 메서드를 사용하여 저장소에 솔루션을 추가해야 합니다.
    표 18. 매개변수
    이름 유형 설명
    없음
    표 19. 반환
    유형 설명
    객체 SimilaritySolutionVersion 개체에 해당합니다 SimilaritySolution 학습 중인
    // Create a dataset 
    var incidentData = new sn_ml.DatasetDefinition({
        'tableName' : 'incident',
        'fieldNames' : ['category', 'short_description']
    });
    
    var kbData = new sn_ml.DatasetDefinition({
        'tableName' : 'kb_knowledge',
        'fieldNames' : ['short_description'],
        'encodedQuery' : 'active=true'
    });
    
    // Create a solution 
    var encoder = sn_ml.EncoderStore.get('GloVe');
    var mySolution = new sn_ml.SimilaritySolution({
        'label': "similarity solution",
        'lookupDataset' : kbData,
        'testDataset' : incidentData,
        'encoder' : encoder,
    });
    
    // Add solution
    var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);
    
    
    // Train the solution - this is a long running job 
    var mySimilarityVersion = mySolution.submitTrainingJob();