EncoderVersion - 전역

Xanadu API 참조

Release

xanadu

ft:locale

ko-KR

ft:publication_title

Xanadu API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

EncoderVersion - 전역

릴리스 버전: Xanadu

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

읽기14분

EncoderVersion API는 저장소에서 예측 인텔리전스 사용되는 스크립팅 가능한 개체를 제공합니다.

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

이 API는 인코더 저장소의 인코더 API 개체를 기반으로 하는 인코더 버전으로 작업하는 데 사용됩니다.

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

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

EncoderVersion - getProperties()

인코더 개체 속성을 및 버전 번호가져옵니다.

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

표 2. 반환
유형	설명
객체	데이터 세트 및 인코더 세부 정보의 내용입니다. 결과는 개체 속성 설정에 따라 달라집니다. `{ "algorithmConfig" : {Object}, "datasetsProperties": [Array], "domainName": "String", "isActive": "String", "label": "String", "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "versionNumber": "Number" }`
<Object>.algorithmConfig	옵션입니다. 알고리즘 구성 속성을 포함하는 JavaScript 객체입니다. `'algorithmConfig' : { "algorithm": "String" }` 데이터 형식: 개체.
<Object>.algorithmConfig.algorithm	이 인코더를 학습하기 위한 알고리즘의 이름입니다. 가능한 값: paravec: 단락 벡터 단어 임베딩입니다. tf-idf: TF-IDF(Term Frequency–Inverse Document Frequency) 기반 텍스트입니다. 데이터 형식: 문자열.
<Object>.datasetsProperties	인코더와 연결된 DatasetDefinition() 속성 목록입니다. `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }` 데이터 형식: 배열.
<Object>.datasetsProperties.tableName	데이터 세트의 테이블 이름입니다. 예를 들어 `"tableName" : "Incident"`입니다. 데이터 형식: 문자열.
<Object>.datasetsProperties.fieldNames	지정된 테이블의 필드 이름을 문자열로 나열한 목록입니다. 예를 들어 `"fieldNames" : ["short_description", "priority"]입니다`. 데이터 형식: 배열.
<Object>.datasetsProperties.fieldNames.fieldDetails	필드 속성을 지정하는 JavaScript 객체의 목록입니다. `[ { "name": "String", "type": "String" } ]` 데이터 형식: 배열.
<Object>.datasetsProperties.fieldNames.fieldDetails.<object>입니다. 이름	이 데이터 세트를 제한할 정보의 유형을 정의하는 필드의 이름입니다. 데이터 형식: 문자열.
<Object>.datasetsProperties.fieldDetails.<object>입니다. 형	머신 러닝 필드 유형입니다. 데이터 형식: 문자열.
<Object>.datasetsProperties.fieldDetails.encodedQuery	표준 Glide 형식으로 인코딩된 쿼리 문자열입니다. 인코딩된 쿼리 문자열을 참조하세요. 데이터 형식: 문자열.
<Object>.domainName	이 데이터 세트와 연결된 도메인 이름입니다. 도메인 분리 및 예측 인텔리전스를 참조하십시오. 데이터 형식: 문자열.
<Object>.isActive	이 버전이 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 버전이 활성 상태입니다. false: 버전이 활성화되지 않았습니다. 데이터 유형: 문자열
<Object>.레이블	예측 작업을 식별합니다. `{ "label": "my first prediction" }` 데이터 형식: 문자열.
<Object>.이름	시스템에서 할당한 이름입니다. 데이터 형식: 문자열.
<Object>.predictedFieldName	예측 가능성을 교육할 필드를 식별합니다. 데이터 형식: 문자열.
<Object>.processingLanguage	두 글자 ISO 639-1 언어 코드 형식의 처리 언어. 데이터 형식: 문자열.
<Object>.범위	개체 범위입니다. 현재 유일하게 유효한 값은 `global`입니다. 데이터 유형: 문자열
<Object>.stopwords	옵션입니다. 속성 설정에 따라 시스템이 자동으로 생성하는 사전 설정 문자열 목록입니다 language . 자세한 내용은 사용자 지정 스톱 워드 목록 만들기를 참조하세요. 데이터 형식: 배열.
<Object>.training빈도	모델을 재교육하는 빈도입니다. 가능한 값: every_30_days every_60_days every_90_days every_120_days every_180_days run_once 기본값: run_once 데이터 형식: 문자열.
<Object>.versionNumber	의 버전 번호 Encoder 객체입니다. 데이터 형식: 문자열.

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

// Get properties
var mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

출력:

*** Script: {
  "datasetsProperties": [
    {
      "tableName": "incident",
      "fieldNames": [
        "assignment_group",
        "short_description",
        "description"
      ],
      "encodedQuery": "activeANYTHING"
    }
  ],
  "domainName": "global",
  "isActive": "true",
  "label": "my encoder definition",
  "name": "ml_x_snc_global_global_my_encoder_definition",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

EncoderVersion - getSentenceVectors(배열 입력)

각 입력 문장에 대한 벡터를 반환합니다.

표 3. 매개변수
이름	유형	설명
입력	배열	벡터를 수신할 문장으로서의 문자열 배열입니다.

표 4. 반환
유형	설명
문자열	문장 벡터로 구성된 배열입니다.

다음 예제에서는 단일 문장에 대한 벡터를 반환하는 방법을 보여 줍니다.

var myEncoderName = 'GloVe';

var myEncoder = sn_ml.EncoderStore.get(myEncoderName);

var input = ["I like to code."];

var vectors = myEncoder.getActiveVersion().getSentenceVectors(input);

gs.print(vectors);

출력:

*** Script: [-0.16243751347064972,0.30614474415779114,0.08489049971103668,
-0.48100000619888306,-0.170997753739357,0.08779674768447876,-0.07848624140024185,-0.15123701095581055,
-0.07843250036239624,-1.9505999088287354,0.3007825016975403,-0.07804800570011139,-0.04779449850320816,
0.04803549498319626,0.09848674386739731,0.2427891194820404,-0.41138750314712524,0.10880374908447266,
 … ,
0.21227750182151794,0.18478751182556152,-0.3113832473754883,-0.16560424864292145,0.09052124619483948]

EncoderVersion - getSimilarWords(배열 입력, 개체 옵션)

유사성의 내림차순 순위 정렬로 각 입력 단어와 유사한 단어를 반환합니다.

표 5. 매개변수
이름	유형	설명
입력	배열	비슷한 단어를 찾을 단어의 배열입니다.
옵션	객체	결과를 구체화하기 위한 맵입니다. `{ "topN":"String" }`
옵션.topN	문자열	제공된 경우 지정된 숫자까지 상위 결과를 반환합니다. 단어의. 예를 들어 `"10"` 을 사용하여 가장 유사한 상위 10개 단어를 반환합니다.

표 6. 반환
유형	설명
배열	해당 위치에 입력 단어에 대한 유사한 단어를 포함하는 요소의 목록입니다. 이러한 유사한 단어는 `[단어, 유사성 점수]` 형식의 쌍 배열로 표시됩니다.

다음 예제에서는 GloVe 인코더를 사용하여 유사한 단어를 가져오는 방법을 보여 줍니다.

var myEncoderName = 'GloVe';
var myEncoder = sn_ml.EncoderStore.get(myEncoderName);
var input =  ["apple"];
var options = {"topN":"5"};
gs.print(myEncoder.getActiveVersion().getSimilarWords(input, options));

출력:

*** Script: [[["iphone",0.5987],["macintosh",0.5836],["ipod",0.5761],["microsoft",0.5664],["ipad",0.5628]]]

EncoderVersion - getStatus(부울 includeDetails)

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

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

표 8. 반환
유형	설명
객체	다음에 대한 교육 상태 정보를 포함하는 JavaScript 객체Encoder 개체입니다. `{ "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 mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

출력:

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

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

// Get status
var encoderName = 'ml_x_snc_global_global_encoder';
var mlEncoder = sn_ml.EncoderStore.get(encoderName);
var trainingStatus = mlEncoder.getLatestVersion().getStatus();

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

출력:

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

EncoderVersion - getVersionNumber()

다음의 버전 번호를 가져옵니다. 솔루션 개체입니다.

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

표 10. 반환
유형	설명
문자열	버전 번호입니다.

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

// Get version number
var mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

출력:

Version number: 1

EncoderVersion - getWordVectors(배열 입력)

각 입력 단어에 대한 벡터를 반환합니다.

표 11. 매개변수
이름	유형	설명
입력	배열	벡터를 받을 단어로서의 문자열 목록입니다.

표 12. 반환
유형	설명
배열	제공된 각 단어의 벡터 목록입니다.

다음 예제에서는 hello라는 단어에서 벡터를 가져오는 방법을 보여 줍니다.

var myEncoderName = 'GloVe';
var myEncoder = sn_ml.EncoderStore.get(myEncoderName);
var input =  ["hello"];

gs.print(myEncoder.getActiveVersion().getWordVectors(input));

출력:

*** Script: [[-0.337119996547699,-0.2169100046157837,-0.006636499892920256,
-0.41624999046325684,-1.2554999589920044,-0.0284659992903471,-0.7219499945640564,
-0.5288699865341187,0.0072085000574588776,0.3199700117111206,0.02942500077188015,
-0.013236000202596188,0.4351100027561188,0.2571600079536438,0.3899500072002411,
 … ,
0.3384299874305725,0.4055800139904022,0.18073000013828278,0.6424999833106995]]