--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # EncoderVersion :グローバル # EncoderVersion :グローバル {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：15分 EncoderVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトを提供します。 この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要で、 `sn_ml` 名前空間内で提供されます。 この API は、[エンコーダー ストア](https://servicenow-prod.fluidtopics.net/YbxbByv15Wzq~p3nlkuRog#EncoderStoreAPI "EncoderStore API は、エンコーダーを格納および取得するためのメソッドを提供します。")内の[エンコーダー API](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#EncoderAPI "エンコーダー API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトを提供します。このオブジェクトは、エンコーダー固有の目標と構成に基づいて、入力データを数値のベクトルに変換します。エンコーダーは、エンコーディングを実行するために個別に使用することも、テキスト列をエンコードするソリューションの一部として構成することもできます。") オブジェクトに基づくエンコーダー バージョンを操作するために使用されます。 バージョンのソリューションをアクティブ化 エンコーダー トレーニング完了時に最新バージョンのソリューションをアクティブ化し、一度にアクティブにできるのは 1 つのバージョンのみです。ただし、予測に使用する、以前にトレーニングしたバージョンをアクティブ化することはできます。{#EncoderVersionAPI__mlv-version-activation-e1} この API のメソッドには、次の エンコーダー メソッドを使用してアクセスできます。 * [getActiveVersion()](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#Encoder-getActiveVersion "アクティブを取得します EncoderVersion オブジェクト。") * [getAllVersions()](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#Encoder-getAllVersions "のすべてのバージョンを取得します エンコーダー。") * [getLatestVersion()](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#Encoder-getLatestVersion "の最新バージョンを取得します エンコーダー。") * [getVersion()](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#Encoder-getVersion_S "エンコーダーを取得します 指定されたバージョン番号で。") {#EncoderVersionAPI__ul_ycl_fzf_tlb} ## EncoderVersion:getProperties() {#ariaid-title2} エンコーダーオブジェクトのプロパティ およびバージョン番号を取得します。 {#EncoderV-getProperties__table_d2m_zwz_4lb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 1. パラメーター] {#EncoderV-getProperties__table_d2m_zwz_4lb} {#EncoderV-getProperties__table_e2m_zwz_4lb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | データセットのコンテンツと [エンコーダー](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#Encoder-Encoder_O "エンコーダーを作成します。") の詳細。結果は、オブジェクトプロパティの設定によって異なります。 { "algorithmConfig" : {Object}, "datasetsProperties": [Array], "domainName": "String", "isActive": "String", "label": "String", "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "versionNumber": "Number" } | | \.algorithmConfig | オプション。 アルゴリズム構成プロパティを含む JavaScript オブジェクト。 'algorithmConfig' : { "algorithm": "String" } データタイプ:オブジェクト。 | | \.algorithmConfig.algorithm | このエンコーダーをトレーニングするためのアルゴリズムの名前。 可能な値： * paravec:段落ベクトル語の埋め込み。 * tf-idf:用語頻度逆ドキュメント頻度 (TF-IDF) ベースのテキスト。 {#EncoderV-getProperties__ul_encoder_alg_vals} データタイプ:文字列。 | | \.datasetsProperties | エンコーダーに関連付けられている [DatasetDefinition()](https://servicenow-prod.fluidtopics.net/_Y4D37G2Ep8vLiDiwFGIhA#DDef-DatasetDefinition_O "DatasetDefinition クラスのインスタンスを作成し、テーブル名、フィールド、およびクエリでデータセットを定義できるようにします。") プロパティのリスト。 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ:アレイ。 | | \.datasetsProperties.tableName | データセットのテーブルの名前。たとえば、「 `tableName」:「インシデント」`です。 データタイプ:文字列。 | | \.datasetsProperties.fieldNames | 指定されたテーブルのフィールド名を文字列としてリストします。例:"`fieldNames" : ["short_description", "priority"]。` データタイプ:アレイ。 | | \.datasetsProperties.fieldNames.fieldDetails | フィールドのプロパティを指定する JavaScript オブジェクトのリスト。 [ { "name": "String", "type": "String" } ] データタイプ:アレイ。 | | \.datasetsProperties.fieldNames.fieldDetails.\.名前 | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ:文字列。 | | \.datasetsProperties.fieldDetails.\。タイプ | 機械学習フィールドタイプ。 データタイプ:文字列。 | | \.datasetsProperties.fieldDetails.encodedQuery | 標準の Glide 形式でエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列」](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US)を参照してください。 データタイプ:文字列。 | | \.domainName | このデータセットに関連付けられたドメイン名。「 [ドメインセパレーション」および 予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=australia&pubname=australia-intelligent-experiences&ft:locale=en-US)を参照してください。 データタイプ:文字列。 | | \.isActive | このバージョンがアクティブかどうかを示すフラグ。 有効な値： * true:バージョンはアクティブです。 * false:バージョンはアクティブではありません。 {#EncoderV-getProperties__ul_i5m_lp1_dmb} データタイプ：文字列 | | \.label | 予測タスクを識別します。 { "label": "my first prediction" } データタイプ:文字列。 | | \.name | システムによって割り当てられた名前。 データタイプ:文字列。 | | \.predictedFieldName | 予測可能性のためにトレーニングするフィールドを識別します。 データタイプ:文字列。 | | \.processingLanguage | 2 文字の ISO 639-1 言語コード形式の処理言語。 データタイプ:文字列。 | | \.scope | オブジェクトスコープ。現時点で有効な値は `グローバル`値のみです。 データタイプ：文字列 | | \.stopwords | オプション。languageプロパティ設定に基づいてシステムが自動的に生成する文字列のプリセットリスト。詳細については、「 [カスタムストップワードリストの作成](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=australia&pubname=australia-intelligent-experiences&ft:locale=en-US)」を参照してください。 データタイプ:アレイ。 | | \.trainingFrequency | モデルを再トレーニングする頻度。 可能な値： * every_30_days * every_60_days * every_90_days * every_120_days * every_180_days * run_once {#EncoderV-getProperties__ul_pmw_523_plb}デフォルト:run_once データタイプ:文字列。 | | \.versionNumber | のバージョン番号 Encoder オブジェクト。 データタイプ:文字列。 | [表 : 2. 返される内容] {#EncoderV-getProperties__table_e2m_zwz_4lb} 次の例では、ストア内のアクティブなオブジェクトバージョンのプロパティを取得します。 // 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(アレイ入力) {#ariaid-title3} 各入力センテンスのベクトルを返します。 {#EncoderV-getSentenceVectors_A__table_rtq_hdb_rlb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | input | アレイ | ベクトルを受け取る文としての文字列の配列。 | [表 : 3. パラメーター] {#EncoderV-getSentenceVectors_A__table_rtq_hdb_rlb} {#EncoderV-getSentenceVectors_A__table_stq_hdb_rlb__entry__2} | タイプ | 説明 | |-|-| | 文字列 | 文ベクトルの配列。 | [表 : 4. 返される内容] {#EncoderV-getSentenceVectors_A__table_stq_hdb_rlb} 次の例は、1 つの文のベクトルを返す方法を示しています。 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(アレイ入力、オブジェクトオプション) {#ariaid-title4} 各入力単語に類似する単語を類似度の降順で返します。 {#EncoderV-getSimilarWords_A_O__table_mxj_kdb_rlb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | input | アレイ | 類似の単語を検索するための単語のアレイ。 | | オプション | オブジェクト | マップして結果を絞り込みます。 { "topN":"String" } | | options.topN | 文字列 | 指定した場合、指定された数までの上位結果を返します 言葉の。たとえば、最も類似している上位 10 個の単語を返すには `、「10」 ` を使用します。 | [表 : 5. パラメーター] {#EncoderV-getSimilarWords_A_O__table_mxj_kdb_rlb} {#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb__entry__2} | タイプ | 説明 | |-|-| | アレイ | 対応する位置に入力単語の類似した単語を含む要素のリスト。これらの類似した単語は `、[単語、類似性スコア]` 形式のペアのアレイによって表されます。 | [表 : 6. 返される内容] {#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb} 次の例は、 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) {#ariaid-title5} トレーニング完了ステータスを取得します。 {#EncoderV-getStatus_B__table_xfh_vbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | includeDetails | ブーリアン | ステータスを details にするかどうかを示すフラグ。 有効な値： * true:追加の詳細を返します。 * false:追加の詳細を返しません。 {#EncoderV-getStatus_B__ul_n33_ckw_plb} デフォルト値：False | [表 : 7. パラメーター] {#EncoderV-getStatus_B__table_xfh_vbw_plb} {#EncoderV-getStatus_B__table_yfh_vbw_plb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | のトレーニングステータス情報を含む JavaScript オブジェクト[Encoder](https://servicenow-prod.fluidtopics.net/3wkxwjgt1W9OU2MIP~fozA#EncoderAPI "エンコーダー API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトを提供します。このオブジェクトは、エンコーダー固有の目標と構成に基づいて、入力データを数値のベクトルに変換します。エンコーダーは、エンコーディングを実行するために個別に使用することも、テキスト列をエンコードするソリューションの一部として構成することもできます。") オブジェクト。 { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} } | | \.state | トレーニング完了ステータス。トレーニングジョブがターミナルステータスに達しても、ジョブはそのステータスを終了しません。ステータスが \[ターミナル\] の場合、 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 {#EncoderV-getStatus_B__ul_a5q_gh4_vlb} データタイプ：文字列 | | \.hasJobEnded | トレーニングが完了したかどうかを示すフラグ。 有効な値： * true:トレーニングが完了しました。 * false:トレーニングが不完全です。 {#EncoderV-getStatus_B__ul_icy_zjx_rlb} データタイプ:文字列としてのブール値 | | \.percentComplete | トレーニング完了率。完了率が 100 未満の場合、ジョブはターミナル状態である可能性があります。たとえば、トレーニングがタイムアウトした場合などです。 データタイプ:文字列としての数値 範囲:0〜100 | | \.details | 追加のトレーニング詳細のリストを含むオブジェクト。 データタイプ: オブジェクト | [表 : 8. 返される内容] {#EncoderV-getStatus_B__table_yfh_vbw_plb} 次の例は、トレーニングが完了した正常な結果を示しています。 // 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() {#ariaid-title6} のバージョン番号を取得します ソリューションオブジェクト。 {#EncoderV-getVersionNumber__table_jsz_sbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 9. パラメーター] {#EncoderV-getVersionNumber__table_jsz_sbw_plb} {#EncoderV-getVersionNumber__table_ksz_sbw_plb__entry__2} | タイプ | 説明 | |-|-| | 文字列 | バージョン番号。 | [表 : 10. 返される内容] {#EncoderV-getVersionNumber__table_ksz_sbw_plb} 次の例は、バージョン番号を取得する方法を示しています。 // 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(アレイ入力) {#ariaid-title7} 各入力単語のベクトルを返します。 {#EncoderV-getWordVectors_A__table_jtt_mdb_rlb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | input | アレイ | ベクトルを受け取る単語としての文字列のリスト。 | [表 : 11. パラメーター] {#EncoderV-getWordVectors_A__table_jtt_mdb_rlb} {#EncoderV-getWordVectors_A__table_ktt_mdb_rlb__entry__2} | タイプ | 説明 | |-|-| | アレイ | 指定された各単語のベクトルのリスト。 | [表 : 12. 返される内容] {#EncoderV-getWordVectors_A__table_ktt_mdb_rlb} 次の例は、「 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]]