AI 資産 API

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：161分

    • AI 資産 API は、システム、データセット、プロンプト、モデルなど、いくつかのタイプの AI 資産を取得、更新、作成するためのエンドポイントを提供します。

    AI 資産 API は、展開されたモデルおよび資産クラスアプリケーションの AI 資産レコードに対して実行できるアクションをサポートしています。アクセスするには、Asset Classes (sn_ent) プラグインが必要です。AI 資産 API によって提供されるエンドポイントを呼び出すには、asset ロールと model_manager ロールが必要です。
    注:
    AI 資産レコードに含まれるデータは、製品モデル、構成アイテムなどの複数のテーブルに分散している場合があります。ただし、この API を呼び出す際の複雑さを軽減するために、 AI 資産 API は資産、製品モデル、および構成アイテムテーブルにのみデータを挿入します。テーブルの更新に関する詳細は、各エンドポイントの下に記載されています。

    AI 資産 API:GET /sn_ent/asset/ai_dataset/{sys_id}

    指定された AI データセット資産のデータを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_dataset/{sys_id}

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI データセット資産 [alm_ai_dataset_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。指定されたsys_idでの資産のフェッチに失敗しました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    結果 新しく作成された AI データセット資産の詳細。

    データタイプ: オブジェクト

    "result": {
  "acceptable_usage": {Object},
  "base_datasets": [Array],
  "created": "String",
  "dataset_card": "String",
  "data_type": {Object},
  "description": "String",
  "documentation": "String",
  "display_name": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": "Development",
  "source": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
}
    result.acceptable_usage AI データセット資産レコードの許容可能な使用法。許容される使用法とは、通常、トレーニングまたは評価の目的で、データセットまたはモデルを使用する方法を指します。

    データタイプ: オブジェクト

    "acceptable_usage": {
  "label": "String" 
  "value": "String" 
}
    result.acceptable_usage.label 許容可能な使用値のラベルを表示します。

    データタイプ：文字列
    result.acceptable_usage.value 許容可能な使用法の数値。
    有効な値：
    • 1:トレーニング
    • 2:評価

    データタイプ：文字列
    result.base_datasets 指定されたデータセットをビルドするために必要な基本データセットのカンマ区切りリスト。AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブル内のベースデータセットの名前またはsys_idを受け入れます。

    データタイプ：アレイ

    "base_datasets": ["String", "String"]
    result.created AI データセット資産レコードが作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.data_type AI データセット資産レコードに存在するデータのタイプ。

    データタイプ: オブジェクト

    "data_type": {
  "label": "String",
  "value": "String"
}
    result.data_type.label データタイプ値の表示ラベル。

    データタイプ：文字列
    result.data_type.value データセット資産のデータタイプの値。

    データタイプ：文字列
    result.dataset_card データセットカード。dataset_cardは、AI データセットの内容、構造、およびコンテキストを記述するメタデータドキュメントです。適切な理解と使用を保証するために、データソース、機能、使用目的、既知の制限などの詳細を提供します。

    データタイプ：文字列
    result.description 関連付けられた AI データセット製品モデルレコードの説明。

    テーブル:AI データセット製品モデル [cmdb_ai_dataset_product_model]

    データタイプ：文字列
    result.display_name AI データセット資産レコードの表示名。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.documentation 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.managed_by AI データセット資産レコードを管理するユーザーの詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name AI データセット資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.managed_by.sys_id AI データセット資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.name 関連付けられた AI データセット製品モデルレコードの名前。

    テーブル:AI データセット製品モデル [cmdb_ai_dataset_product_model]

    データタイプ：文字列
    result.provider 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのプロバイダー。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name プロバイダーの名前。

    データタイプ：文字列
    result.provider.sys_id 関連付けられた AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.source AI データセット資産のソースに関する詳細。
    有効な値：
    • データセット資産のソースへのリンク。
    • データセット資産のソースの詳細 (プレーンテキスト)。たとえば、製品や Web サイトの名前などです。

    データタイプ：文字列

    デフォルト:空または null
    result.state AI データセット資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.sys_id AI データセット資産レコードのSys_id。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.updated AI データセット資産レコードが最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.version 関連付けられた AI データセット製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列

    cURL 要求

    次の例。

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/ cc419cb2331e92101c9aca989d5c7b4c" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user "username":"password"

    出力:

    { 
  "result": { 
    "sys_id": "9d60fb5f40d21210f877b00c113d1fea", 
    "display_name": "ServiceNow Closed Incidents v1", 
    "name": "Closed Incidents", 
    "description": "Incidents with resolution", 
    "documentation": "Sample Documentation", 
    "source": "incident table on servicenow instance", 
    "dataset_card": "Sample Dataset Card", 
    "state": "Development", 
    "version": "v1", 
    "data_type": { 
      "value": "2", 
      "label": "Image" 
    }, 
    "provider": { 
      "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
      "name": "ServiceNow" 
    }, 
    "managed_by": { 
      "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
      "name": "Abel Tuter" 
    }, 
    "acceptable_usage": { 
      "value": "1", 
      "label": "Training" 
    }, 
    "base_datasets": [], 
    "created": "2024-12-11 08:50:40", 
    "updated": "2024-12-11 08:50:40" 
  } 
}

    AI 資産 API:GET /sn_ent/asset/ai_model/{sys_id}

    指定された AI モデル資産のデータを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_model/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_model/{sys_id}

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI モデル資産 [alm_ai_model_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。指定されたsys_idでの資産のフェッチに失敗しました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター
    結果 モデル資産レコードの詳細。

    データタイプ: オブジェクト

    result: {
  "base_model": {Object},
  "context_window": "String",
  "created": "String",
  "deployment_guideline": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": "String",
  "managed_by": {Object},
  "model_size_in_mb": "String",
  "name": "String",
  "parameters_info": "String",
  "provider": {Object},
  "required_infrastructure": "String",
  "source": "String",
  "state": Number,
  "supported_languages": [Array],
  "sys_id": "String",
  "training_datasets": [Array],
  "training_procedure": "String",
  "updated": "String",
  "version": "String"
}
    result.base_model このモデルバージョンの派生元となった AI モデル。
    注:
    組織内で開発されたモデルにのみ適用されます。

    データタイプ: オブジェクト

    {
  "name": "String",
  "sys_id": "String"
 }
    Default (デフォルト)：
    result.base_model.name この AI モデルをモデル化する AI モデル資産の名前。

    データタイプ：文字列
    result.base_model.sys_id この AI モデルをモデル化する AI モデル資産のSys_id。

    データタイプ：文字列
    result.context_window モデルが処理できる入力シーケンスのサイズ (つまり、トークンの数)。

    データタイプ:数値で表される文字列
    result.created AI データセット資産レコードが作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.deployment_guideline 組織内で開発および展開されたモデルに適用される手順。

    データタイプ：文字列
    result.description AI モデル製品モデルを示す説明。

    テーブルで更新:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.result.display_name 資産レコードの表示名。

    データタイプ：文字列
    result.documentation AI プロンプト製品モデルレコードのドキュメント。

    テーブル:AI プロンプト製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.evaluation_datasets モデルの評価に使用される AI データセットデジタル資産の AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  "name": "String",
  "sys_id": "String"
]
    result.evaluation_metrics_report 評価結果への参照。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.managed_by AI モデル資産レコードを管理するユーザーの詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name AI データセット資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.managed_by.sys_id AI データセット資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.model_size_in_mb モデルのサイズ (MB)。主に、組織内で開発および展開されたモデルに適用されます。

    データタイプ：数値
    result.name 必須。AI モデル製品モデルの名前。

    テーブルで更新:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.provider 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのプロバイダー。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.sys_id 関連付けられた AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.provider.name プロバイダーの名前。

    データタイプ：文字列
    result.required_infrastructure モデル展開に必要なインフラストラクチャのドキュメント。たとえば、インフラストラクチャスタックや処理のニーズに関する詳細などです。主に、組織内に展開されたモデルに適用されます。

    データタイプ：文字列
    result.source モデルのソースに関する詳細。
    可能な値：
    • モデルのソースへのリンク。たとえば、Github へのリンク https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 などです。
    • プレーンテキストでのソースの詳細。例:Microsoft Azure

    データタイプ：文字列
    result.state AI モデル資産に適用するステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.supported_languages AI モデルでサポートされている言語。

    データタイプ：アレイ

    "supported_languages": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.supported_languages.name 言語レコードの名前。たとえば、「フランス語」、「英語」などです。

    テーブル:言語 [sys_language]

    データタイプ：文字列
    result.supported_languages.sys_id 言語レコードのSys_id。

    テーブル:言語 [sys_language]

    データタイプ：文字列
    result.sys_id AI モデル資産レコードのSys_id。

    テーブル:AI モデル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.version AI モデル製品モデルのバージョン。例:V2。

    データタイプ：文字列

    cURL 要求

    次の例。

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_model/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    出力:

    {
  "result": {
    "sys_id": "a438d170ff96da10c1fbffffffffffd5",
    "display_name": "ServiceNow Now LLM V6",
    "name": "Now LLM",
    "description": "enables text-to-text like question answering and summarization",
    "version": "V6",
    "provider": {
      "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
      "name": "ServiceNow"
    },
    "documentation": "Now LLM V5 Documentation",
    "parameters_info": "7B",
    "supported_languages": [
      {
        "sys_id": "914493a30f320010e96b0e4fef767e90",
        "name": "English"
      }
    ],
    "model_size_in_mb": "87",
    "deployment_guideline": "Deployed on ServiceNow infrastructure",
    "source": null,
    "training_procedure": "2",
    "context_window": "8000",
    "state": "Deployed",
    "required_infrastructure": "undefined",
    "base_model": {
      "sys_id": null,
      "name": ""
    },
    "evaluation_datasets": [
      {
        "sys_id": "45cb45baff06d610c1fbffffffffffa9",
        "name": "ServiceNow Open Incidents"
      }
    ],
    "training_datasets": [
      {
        "sys_id": "45cb45baff06d610c1fbffffffffffa9",
        "name": "ServiceNow Open Incidents"
      }
    ],
    "evaluation_metrics_report": "Testing results: See files attached to this record",
    "managed_by": {
      "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
      "name": "Abel Tuter"
    },
    "created": "2024-12-03 16:50:53",
    "updated": "2024-12-03 16:50:53"
  }
}

    AI 資産 API - GET /sn_ent/asset/ai_prompt/{sys_id}

    指定された AI プロンプト資産のデータを取得します。

    関連項目：

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_prompt/{sys_id}

    サポートされている要求パラメーター

    表 : 13. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI プロンプト資産 [alm_ai_prompt_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。指定されたsys_idでの資産のフェッチに失敗しました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    結果 AI プロンプト資産の詳細。
    result: {
  "ai_model": {Object},
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "managed_by": {Object},
  "name": "String",
  "prompt_info": "String",
  "provider": {Object},
  "state": Number,
  "sys_id": "String",
  "updated": "String",
  "version": "String"
}
    result.ai_model AI プロンプト資産レコードの AI モデル。

    データタイプ: オブジェクト

    "ai_model": {
  "name": "String",
  "sys_id": "String"
}
    result.ai_model.name AI モデルの名前。

    データタイプ：文字列
    result.ai_model.sys_id AI プロンプト製品モデルレコードのSys_id。

    テーブル:AI プロンプト製品モデル [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.created AI プロンプト資産レコードが作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.description AI プロンプト製品モデルレコードの説明。

    テーブル:AI プロンプト製品モデル [cmdb_ai_prompt_product_model]

    データタイプ：文字列
    result.display_name 関連付けられた AI プロンプト資産レコードの表示名。

    テーブル:AI プロンプト資産 [alm_ai_prompt_digital_asset]

    データタイプ：文字列
    result.documentation AI プロンプト製品モデルレコードのドキュメント。

    テーブル:AI プロンプト製品モデル [cmdb_ai_prompt_product_model]

    データタイプ：文字列
    result.managed_by AI プロンプト資産レコードを管理するユーザー。

    データタイプ: オブジェクト

    "managed_by": {
  "name": "String",
  "sys_id": "String"
}
    result.managed_by.name 資産レコードを管理するユーザーの名前。

    データタイプ：文字列
    result.managed_by.sys_id 資産レコードの管理担当者ユーザーに対応するユーザーレコードのSys_id。

    テーブル:ユーザー [sys_user]、AI プロンプト資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.name 関連付けられた AI プロンプト製品モデルの名前。

    テーブル:AI プロンプト製品モデル [cmdb_ai_prompt_product_model]

    データタイプ：文字列
    result.prompt_info AI プロンプト資産レコードのプロンプト情報。

    テーブル:AI プロンプト資産 [alm_ai_prompt_digital_asset]

    データタイプ：文字列
    result.provider AI プロンプト製品モデルレコードのプロバイダー。
    "provider": {
  "name": "String",
  "sys_id": "String"
}

    データタイプ: オブジェクト
    result.provider.name 関連付けられた AI プロンプト製品モデルレコードの名前。

    データタイプ：文字列
    result.provider.sys_id 関連する AI プロンプト製品モデルレコードのプロバイダーに対応する会社 [core_company] テーブルレコードのSys_id。

    テーブル:会社 [core_company]、AI プロンプト製品モデル [cmdb_ai_prompt_product_model]

    データタイプ：文字列
    result.state AI プロンプト資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.sys_id AI プロンプト資産レコードのSys_id。

    テーブル:AI プロンプト資産 [alm_ai_prompt_digital_asset]

    データタイプ：文字列
    result.updated AI プロンプト資産レコードが最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.version 関連付けられた AI プロンプト製品モデルレコードのバージョン。例:V2。

    データタイプ：文字列

    cURL 要求

    次の例は、特定の ID を使用して AI プロンプトアセットモデルに関する情報を取得する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/cc419cb2331e92101c9aca989d5c7b4c" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    応答本文は、取得された特定のプロンプト資産モデルに関する詳細を返します。

    {
  "result": {
    "sys_id": "cc419cb2331e92101c9aca989d5c7b4c",
    "display_name": "ServiceNow ServiceNow Incident Summarization Prompt 4 V8",
    "name": "ServiceNow Incident Summarization Prompt 4",
    "description": "Prompt for Incident Summarization",
    "version": "V8",
    "provider": {
      "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
      "name": "ServiceNow"
    },
    "documentation": "Documentation",
    "state": "Development",
    "ai_model": {
      "sys_id": "a57d0be6eb1e5210aa82fab8bad0cd18",
      "name": "mistral-large"
    },
    "prompt_info": "Provide incident summary using short_decription, state, worknotes",
    "managed_by": {
      "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
      "name": "Abel Tuter"
    },
    "created": "2024-12-09 03:18:46",
    "updated": "2024-12-09 04:26:08"
  }
}

    AI 資産 API:GET /sn_ent/asset/ai_system/{sys_id}

    指定された AI システム資産のデータを取得します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_system/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_system/{sys_id}

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。指定されたsys_idでの資産のフェッチに失敗しました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    結果 取得された AI システム資産の詳細。
    result: {
  "ai_models": [Array],
  "ai_prompts": [Array],
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": Number,
  "sys_id": "String",
  "updated": "String",
  "version": "String"
}
    result.ai_models AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコード内の AI モデルのリスト。

    データタイプ：アレイ

    "ai_models": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_models.name AI システムデジタル資産レコードの名前。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.ai_models.sys_id AI システムデジタル資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.ai_prompts AI システム資産レコード内の AI プロンプトのリスト。

    データタイプ：アレイ

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_prompts.name AI プロンプトの名前。

    データタイプ：文字列
    result.ai_prompts.sys_id AI プロンプトデジタル資産レコードのSys_id。

    テーブル:AI プロンプトデジタル資産 [alm_ai_prompt_digital_asset]

    データタイプ：文字列
    result.created AI システム資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.description 関連する AI システム製品モデルレコードの説明。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.display_name AI システム資産レコードの表示名。

    テーブル:AI システム資産 [cmdb_ai_ system_asset_model]

    データタイプ：文字列
    result.documentation AI システム製品システムレコードのドキュメント。

    表:AIシステム製品システム [cmdb_ai_system_product_system]

    データタイプ：文字列
    result.evaluation_datasets AI システムデジタル資産レコードのモデルを評価するために使用される AI データセットのリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI システム資産 [alm_ai_system_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]

    デフォルト:空の文字列
    result.evaluation_datasets.name AI データセットデジタル資産の名前。

    データタイプ：文字列
    result.evaluation_datasets.sys_id AI データセットデジタル資産レコードのSys_id。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.evaluation_metrics_report AI システム資産レコードの評価結果。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.managed_by AI システム資産レコードを管理するユーザーの詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name AI システム資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.managed_by.sys_id AI システム資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.name 関連付けられた AI システム製品モデルレコードの名前。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.provider 関連する AI システム製品モデルレコードの [プロバイダー] フィールドの値。

    テーブル:AI システム製品モデル [cmdb_ai_ system_product_model]

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name 関連付けられた AI システム製品モデルレコード内のプロバイダーの名前。

    テーブル:AI システム製品モデル [cmdb_ai_ system_product_model]

    データタイプ：文字列
    result.provider.sys_id 関連付けられた AI システム製品モデルレコード内のプロバイダーのSys_id。

    テーブル:AI システム製品モデル [cmdb_ai_ system_product_model]

    データタイプ：文字列
    result.state AI システム資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.sys_id AI システム資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.updated AI システム資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.version 関連付けられた AI システム製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列

    cURL 要求

    次の例は、指定された ID で AI システムモデル資産を取得する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_ent/asset/ai_system/3b140397435a9210a63d00002fb8f2d7" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    応答本文は、指定された AI システムモデル資産に関する詳細を返します。

    {
  "result": {
      "sys_id": "3b140397435a9210a63d00002fb8f2d7",
      "display_name": "ServiceNow Incident Summarization V2",
      "name": "Incident Summarization",
      "description": "Incident Summarization Skill",
      "version": "V2",
      "provider": {
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
        "name": "ServiceNow"
      },
      "documentation": "Sample Documentation",
      "state": "Deployed",
      "ai_models": [{ 
        "sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "llm_generic_small" 
      },
      { 
        "sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "mixtral-instruct" 
      }],
      "ai_prompts": [{ 
        "sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "LLM Prompt" 
      }],
      "evaluation_datasets": [{ 
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "Base dataset" 
      }],
      "evaluation_metrics_report": "Sample Report",
      "managed_by": {
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter"
      },
      "created": "2024-12-11 18:23:09",
      "updated": "2024-12-11 18:23:09"
  }
}

    AI 資産 API - POST /sn_ent/asset/ai_dataset

    要求本文に指定した詳細に従って、AI データセットデジタル資産 [alm_ai_dataset_digital_asset] と AI データセット製品モデル [cmdb_ai_dataset_product_model] に新しい AI データセット資産エントリを作成します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_dataset

    デフォルト URL: /api/sn_ent/asset/ai_dataset

    サポートされている要求パラメーター

    表 : 25. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    なし
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    {object} 
    {
  "acceptable_usage": "String",
  "base_datasets": [Array],
  "dataset_card": "String"
  "data_type": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String", 
  "name": "String", 
  "provider": "String",
  "state": "String" 
  "source": "String",
  "version": "String"
}
    {object} 
    {
  "acceptable_usage": "String",
  "base_datasets": [Array],
  "dataset_card": "String"
  "data_type": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String", 
  "name": "String", 
  "provider": "String",
  "state": "String" 
  "source": "String",
  "version": "String"
}
    {オブジェクト}.acceptable_usage 通常はトレーニングまたは評価の目的で、データセットまたはモデルを使用する方法を決定します。
    有効な値：
    • 1:トレーニング
    • 2:評価

    データタイプ：文字列
    {オブジェクト}.base_datasets このデータセットを構築するために必要な基本データセットのカンマ区切りリスト。AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブルに存在するデータセットの名前またはsys_idsを受け入れます。

    データタイプ：アレイ

    “base_datasets”: [ “String”, “String”]
    {オブジェクト}.data_type データセットに存在するデータのタイプ。例: テキスト、ビデオ、画像 、 または 1,2。

    データタイプ：文字列
    {オブジェクト}.dataset_card データセットカード。dataset_cardは、AI データセットの内容、構造、およびコンテキストを記述するメタデータドキュメントです。適切な理解と使用を保証するために、データソース、機能、使用目的、既知の制限などの詳細を提供します。

    データタイプ：文字列
    {object}.description AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブル内の関連レコードの説明。

    データタイプ：文字列
    {object}.documentation AI データセット製品モデルのドキュメント。

    データタイプ：文字列
    {オブジェクト}.managed_by 既存のユーザー [sys_user] テーブルレコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列
    {object}.name 必須。AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブル内の関連レコードの名前。

    データタイプ：文字列
    {object}.provider 必須。会社 [core_company] テーブルの既存レコードの [プロバイダー] フィールドの値。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    {object}.source データセットのソースに関する詳細。
    有効な値：
    • データセットのソースへのリンク。
    • プレーンテキストでのソースの詳細。

    データタイプ：文字列

    デフォルト:空または null
    {object}.state AI データセット資産のステータス。
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    {object}.version 関連付けられた AI データセット製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 新しく作成された AI データセット資産の詳細。

    データタイプ: オブジェクト

    "result": {
  "acceptable_usage": {Object},
  "base_datasets": [Array],
  "created": "String",
  "dataset_card": "String",
  "data_type": {Object},
  "description": "String",
  "documentation": "String",
  "display_name": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": "Development",
  "source": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
}
    result.acceptable_usage AI データセット資産レコードの許容可能な使用法。許容される使用法とは、通常、トレーニングまたは評価の目的で、データセットまたはモデルを使用する方法を指します。

    データタイプ: オブジェクト

    "acceptable_usage": {
  "label": "String" 
  "value": "String" 
}
    result.acceptable_usage.label 許容可能な使用値のラベルを表示します。

    データタイプ：文字列
    result.acceptable_usage.value 許容可能な使用法の数値。
    有効な値：
    • 1:トレーニング
    • 2:評価

    データタイプ：文字列
    result.base_datasets 指定されたデータセットをビルドするために必要な基本データセットのカンマ区切りリスト。AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブル内のベースデータセットの名前またはsys_idを受け入れます。

    データタイプ：アレイ

    "base_datasets": ["String", "String"]
    result.created AI データセット資産レコードが作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.data_type AI データセット資産レコードに存在するデータのタイプ。

    データタイプ: オブジェクト

    "data_type": {
  "label": "String",
  "value": "String"
}
    result.data_type.label データタイプ値の表示ラベル。

    データタイプ：文字列
    result.data_type.value データセット資産のデータタイプの値。

    データタイプ：文字列
    result.dataset_card データセットカード。dataset_cardは、AI データセットの内容、構造、およびコンテキストを記述するメタデータドキュメントです。適切な理解と使用を保証するために、データソース、機能、使用目的、既知の制限などの詳細を提供します。

    データタイプ：文字列
    result.description 関連付けられた AI データセット製品モデルレコードの説明。

    テーブル:AI データセット製品モデル [cmdb_ai_dataset_product_model]

    データタイプ：文字列
    result.display_name AI データセット資産レコードの表示名。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.documentation 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.managed_by AI データセット資産レコードを管理するユーザーの詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name AI データセット資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.managed_by.sys_id AI データセット資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.name 関連付けられた AI データセット製品モデルレコードの名前。

    テーブル:AI データセット製品モデル [cmdb_ai_dataset_product_model]

    データタイプ：文字列
    result.provider 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのプロバイダー。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.sys_id 関連付けられた AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.provider.name プロバイダーの名前。

    データタイプ：文字列
    result.source AI データセット資産のソースに関する詳細。
    有効な値：
    • データセット資産のソースへのリンク。
    • データセット資産のソースの詳細 (プレーンテキスト)。たとえば、製品や Web サイトの名前などです。

    データタイプ：文字列

    デフォルト:空または null
    result.state AI データセット資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.sys_id AI データセット資産レコードのSys_id。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.updated AI データセット資産レコードが最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.version 関連付けられた AI データセット製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列
    result.warnings データセットの作成時に表示される警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターのsys_idが無効な場合など、検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例は、新しい AI データセット資産レコードを作成する方法を示しています。

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' { 
  "name": "Dataset One", 
  "description": "Description for dataset ", 
  "provider": "servicenow", 
  "version": "V1", 
  "state": 31, 
  “source”: “Source of dataset” 
  "documentation": "document", 
  “dataset_card”: “Dataset Card”, 
  “base_datasets”: [ “Dataset Two”, “Dataset Three”], 
  “data_type”: “1,2”, 
  “acceptable_usage”: “1,2”, 
  "managed_by": "abel.tuter" 
}'

    応答本文。新しく作成されたデータセット資産レコードの結果。

    { 
  "result": { 
    "asset": { 
      "sys_id": "da8393eb40d25210f877b00c113d1fc1", 
      "display_name": "ServiceNow Closed Incidents", 
      "name": "Closed Incidents", 
      "description": "Incidents with resolution", 
      "documentation": "Sample Documentation", 
      "source": "incident table on servicenow instance", 
      "dataset_card": "Dataset Card", 
      "state": "Deployed", 
      "version": null, 
      "data_type": { 
        "value": "1", 
        "label": "Text" 
      }, 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "managed_by": { 
        "sys_id": "undefined", 
        "name": "" 
      }, 
      "acceptable_usage": { 
        "value": "1", 
        "label": "Training" 
      }, 
      "base_datasets": [], 
      "created": "2024-12-12 01:23:03", 
      "updated": "2024-12-12 01:23:03" 
    }, 
    "warnings": [] 
       } 
}

    AI 資産 API - POST /sn_ent/asset/ai_prompt

    要求本文に指定した詳細に従って、AI プロンプトデジタル資産 [alm_ai_prompt_digital_asset] テーブルと AI プロンプト製品モデル [cmdb_ai_promt_product_model] テーブルに新しい AI プロンプト資産エントリを作成します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_prompt

    デフォルト URL: /api/sn_ent/asset/ai_prompt

    サポートされている要求パラメーター

    表 : 31. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 32. クエリパラメーター
    名前 説明
    なし
    表 : 33. 要求本文パラメーター (XML または JSON)
    名前 説明
    オブジェクト 必須。更新する AI プロンプト資産のコンテンツ。

    データタイプ: オブジェクト

    {
  "ai_model": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String" 
  "name": "String",
  "prompt_info": "String", 
  "provider": "String",
  "state": Number,
  "version": "String"
}
    ai_model AI モデルデジタル資産 [alm_ai_model_digital_asset] テーブルの既存のレコードの [AI モデル] フィールドの値。
    有効な値：
    • AI モデルデジタル資産 [alm_ai_model_digital_asset] レコードの名前
    • AI モデルデジタル資産 [alm_ai_model_digital_asset] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列
    説明 AI プロンプト製品モデルを示す説明。

    テーブル:AI プロンプト製品モデル [cmdb_ai_prompt_product_model]

    データタイプ：文字列

    デフォルト:空の文字列
    ドキュメント AI プロンプト製品モデルのドキュメント。

    データタイプ：文字列

    デフォルト:空の文字列
    managed_by ユーザー [sys_user] テーブルの既存レコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列
    名前 必須。AI プロンプト製品モデル [cmdb_ai_prompt_product_model] テーブル内の関連レコードの名前。

    データタイプ：文字列

    デフォルト:空の文字列
    prompt_info AI プロンプト資産のプロンプト情報。

    データタイプ：文字列

    デフォルト:空の文字列
    プロバイダー 必須。会社 [core_company] テーブルの既存レコードの [プロバイダー] フィールドの値。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    状況 AI モデル資産に適用するステータス。たとえば
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    バージョン AI プロンプト製品モデルに割り当てるバージョン番号。例:V2。

    データタイプ：文字列

    デフォルト:空の文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 34. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 36. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 新しい AI 資産プロンプトの結果。

    データタイプ: オブジェクト

    "result": { 
    "asset": Object, 
    "warnings": [Array] 
 }
    result.asset 新しく作成されたエントリの詳細。

    データタイプ: オブジェクト

    "asset": {
  "ai_model": [Array],
  "ai_prompts": [Array]
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "name": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    result.asset.ai_model AI システム資産 [cmdb_ai_ system_asset_model] テーブルレコード内の AI モデルのリスト。

    データタイプ：アレイ

    "ai_model": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_models.name AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードの名前。

    データタイプ：文字列
    result.asset.ai_models.sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.ai_prompts AI システム資産レコードの AI プロンプトのリスト。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：アレイ

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_prompts.name AI プロンプトの名前。

    データタイプ：文字列
    result.asset.ai_prompts.sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.created AI モデル資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.description 関連する AI システム製品モデルレコードの説明。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.display_name AI システム資産レコードの表示名。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.documentation 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.asset.evaluation_datasets AI システム資産モデルを評価するために使用される AI データセットのsys_ids名または表示名のリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.evaluation_datasets.name AI データセットデジタル資産の名前。

    データタイプ：文字列
    result.asset.evaluation_datasets.sys_id AI システムデジタル資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.evaluation_metrics_report AI システム資産の評価結果。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.asset.managed_by 資産を管理するユーザーに関する詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name AI モデル資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.managed_by.sys_id AI モデル資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.name 関連付けられた AI システム製品モデルレコードの名前。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.provider 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードの [プロバイダー] フィールドの値。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーの名前。

    データタイプ：文字列
    result.asset.provider.sys_id 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.asset.state AI モデル資産のステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.asset.sys_id AI システム資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.updated AI モデル資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.warning 警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターのsys_idが無効な場合など、検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例は、POST メソッドを使用して、要求本文に指定された詳細に従って新しい AI プロンプトを作成する方法を示しています。

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Incident Summarization prompt1", 
  "description": "Prompt for Incident Summarization", 
  "provider": "servicenow", 
  "version": "V1", 
  "state": 31, 
  "documentation": "Document", 
  "ai_model": "mixtral-instruct", 
  "prompt_info": "Provide incident summary using short_decription, state, worknotes", 
  "managed_by": "abel.tuter" 
 }'

    応答本文。

    { 
  "result": { 
    "asset": { 
      "sys_id": "9833721b331e92101c9aca989d5c7bf0", 
      "display_name": "ServiceNow Incident Summarization prompt1 V1", 
      "name": "Incident Summarization prompt1", 
      "description": "Prompt for Incident Summarization", 
      "version": "V1", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Document", 
      "state": "Deployed", 
      "ai_model": { 
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2", 
        "name": "mixtral-instruct" 
      }, 
      "prompt_info": "Provide incident summary using short_decription, state, worknotes", 
      "managed_by": { 
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
        "name": "Abel Tuter" 
      }, 
      "created": "2024-12-11 04:23:17", 
      "updated": "2024-12-11 04:23:17" 
    }, 
    "warnings": [] 
  } 
}

    AI 資産 API - POST /sn_ent/asset/ai_model

    要求本文に指定した詳細に従って、AI モデルデジタル資産 [alm_ai_model_digital_asset] テーブルと AI モデル製品モデル [cmdb_ai_model_product_model] テーブルに新しい AI モデル資産エントリを作成します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_model

    デフォルト URL: /api/sn_ent/asset/ai_model

    サポートされている要求パラメーター

    表 : 37. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 38. クエリパラメーター
    名前 説明
    なし
    表 : 39. 要求本文パラメーター (XML または JSON)
    名前 説明
    {object} 必須。新しい資産モデルレコードに適用する詳細。

    データタイプ: オブジェクト

    "object": {
  "base_model": {Object},
  "context_window:" "String",
  "deployment_guideline": "String",
  "description": "String", 
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": "String",
  "managed_by": "String", 
  "model_size_in_mb": "String",
  "model_weights_info": "String",
  "name": "String",
  "parameters_info": "String",
  "provider": "String",
  "required_infrastructure": "String",
  "source": "String",
  "state": Number,
  "supported_languages: [Array],
  "training_datasets": [Array],
  "training_procedure": "String",
  "version": "String"
}
    {オブジェクト}.base_model このモデルバージョンの派生元となった AI モデル。
    注:
    組織内で開発されたモデルにのみ適用されます。

    データタイプ: オブジェクト

    {
  "name": "String",
  "sys_id": "String"
 }
    {object}.base_model.name この AI モデルをモデル化する AI モデル資産の名前。

    データタイプ：文字列
    {オブジェクト}.base_model.sys_id この AI モデルをモデル化する AI モデル資産のSys_id。

    テーブル:AI モデルデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列

    デフォルト:空の文字列
    {オブジェクト}.context_window モデルが処理できる入力シーケンスのサイズ (つまり、トークンの数)。

    データタイプ：整数

    デフォルト:空の値
    {オブジェクト}.deployment_guideline 組織内で開発および展開されたモデルに適用される手順。

    データタイプ：文字列

    デフォルト:空の文字列
    {object}.description AI モデル製品モデルを示す説明。

    更新されたテーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列

    デフォルト:空の文字列
    {object}.documentation AI モデル製品モデルのドキュメント。

    データタイプ：文字列

    デフォルト:空の文字列
    {オブジェクト}.evaluation_datasets モデルの評価に使用される AI データセットの AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI モデル資産 [alm_ai_model_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": ["String", "String"]
    有効な値：
    • AI データセットデジタル資産レコードの名前。
    • AI データセットデジタル資産レコードのSys_id。

    デフォルト:空の文字列
    {オブジェクト}.evaluation_metrics_report AI モデルデジタル資産レコードのテキストフィールド内にある評価結果への参照。例：
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列

    デフォルト:空の文字列
    {オブジェクト}.managed_by ユーザー [sys_user] テーブルの既存レコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列
    {オブジェクト}.model_size_in_mb モデルのサイズ (MB)。主に、組織内で開発および展開されたモデルに適用されます。

    データタイプ：数値

    デフォルト:null または空
    {オブジェクト}.model_weights_info 追加のモデル情報 (利用可能な場合)。主に組織内で開発されたモデルに適用されます。

    データタイプ：文字列

    デフォルト:null または空
    {object}.name 必須。AI モデル製品モデルの名前。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列

    デフォルト:null または空
    {オブジェクト}.parameters_info モデルに与えられたパラメーターの数。

    データタイプ：文字列

    デフォルト:空の文字列
    {object}.provider 必須。会社 [core_company] テーブルの既存レコードの [プロバイダー] フィールドの値。このプロバイダーを新しい AI モデルにアサインします。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列
    {オブジェクト}.required_infrastructure モデル展開に必要なインフラストラクチャのドキュメント。たとえば、インフラストラクチャスタックや処理のニーズに関する詳細などです。主に、組織内に展開されたモデルに適用されます。

    データタイプ：文字列

    デフォルト:空または null
    {object}.source 誰が、または何がモデルを作成したかのソースに関する詳細。
    有効な値：
    • モデルのソースへのリンク。たとえば、Github へのリンク https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 などです。
    • プレーンテキストでのソースの詳細。例:Microsoft Azure

    データタイプ：文字列

    デフォルト:空または null
    {object}.state AI モデル資産に適用するステータス。
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    {オブジェクト}.supported_languages AI モデルでサポートされている言語のカンマ区切りリスト。

    データタイプ：アレイ

    "supported_languages": [
  "String",
  "String"
]
    有効な値：
    • 言語 [sys_language] レコードのSys_id
    • 言語 [sys_language] レコードの名前。たとえば、「フランス語」、「英語」などです。

    デフォルト:空の文字列
    {オブジェクト}.training_datasets AI モデルのトレーニングに使用されるデータセット。AI データセット資産 [alm_ai_dataset_digital_asset] テーブルのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    データタイプ：アレイ

    "training_datasets": [
  "String",
  "String"
]

    デフォルト:空の文字列
    {オブジェクト}.training_procedure AI モデルに適用するトレーニングのタイプ。
    有効な値：
    • 1:ディシジョンツリー
    • 2: ディープニューラルネットワーク
    • 3:線形回帰
    • 4:ロジスティック回帰
    • 5:ランダムフォレスト
    • 6:教師あり学習
    • 7:教師なし学習
    • 8:強化学習
    • 9:転移学習
    • 10:半教師あり学習
    • 11:命令ファインチューニング
    • 12:教師ありファインチューニング

    データタイプ:数値で表される文字列 ( 例:「3」)

    デフォルト:1:ディシジョンツリー
    {object}.version AI モデル製品モデルのバージョン。例:V2。

    データタイプ：文字列

    デフォルト:空の文字列

    応答本文のパラメーター (JSON または XML)

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 40. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 42. ステータスコード
    ステータスコード 説明
    201 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    [Name (名前)] 説明
    結果 AI モデル資産作成の結果。

    データタイプ: オブジェクト

    "result": { 
    "asset": Object, 
    "warnings": [Array], 
 }
    result.asset 作成された AI モデル資産の詳細。

    データタイプ: オブジェクト

    "asset": {
  "base_model": Object,
  "context_window": String,
  "created": "String",
  "deployment_guideline": String,
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": Array,
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "model_size_in_mb": String,
  "name": "String",
  "parameters_info": "String",
  "provider": Object,
  "required_infrastructure": String,
  "state": "String",
  "source": String, 
  "supported_languages": Array,
  "sys_id": "String",
  "training_datasets": Array,
  "training_procedure": String,
  "updated": "String",
  "version": "String"
}
    result.asset.base_model このバージョンの派生元である AI モデル資産に関する情報。

    データタイプ: オブジェクト

    "base_model": { 
  "name": "String",
  "sys_id": "String"
}
    result.asset.base_model.name AI モデル資産の表示名。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.base_model.sys_id AI モデル資産のSys_id。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.context_window モデルが処理できる入力シーケンスのサイズ。つまり、トークンの数です。

    データタイプ:数値で表される文字列。例: 「6000」。
    result.asset.created AI モデル資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.deployment_guideline 組織内で開発および展開されたモデルに適用される手順。

    データタイプ：文字列
    result.asset.description 関連する AI モデル製品モデルレコードの説明。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.display_name AI モデル資産レコードの表示名。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset] (display_nameフィールド)

    データタイプ：文字列
    result.asset.documentation 関連する AI モデル製品モデルレコードのドキュメント。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.evaluation_datasets モデルの評価に使用される AI モデルデジタル資産の AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    result.evaluation_datasets.name AI データセットデジタル資産の名前。

    データタイプ：文字列
    result.evaluation_datasets.sys_id AI モデルデジタル資産レコードのSys_id。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.evaluation_metrics_report 評価結果への参照。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.asset.managed_by AI モデル資産レコードを管理するユーザー。

    データタイプ: オブジェクト

    " managed_by": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.managed_by.name AI モデル資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.managed_by.sys_id AI モデル資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.model_size_in_mb モデルのサイズ (MB)。通常、組織内で開発および展開されたモデルに適用されます。

    データタイプ：数値
    result.asset.name 関連付けられた AI モデル製品モデルレコードの名前。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.provider 関連する AI モデル製品モデルレコードのプロバイダー。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ: オブジェクト

    "provider": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name プロバイダーの名前。

    データタイプ：文字列
    result.asset.provider.sys_id 関連する AI モデル製品モデルレコードのプロバイダーに対応する会社 [core_company] テーブルからのレコードSys_id。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.source 資産のソースに関する詳細。
    有効な値：
    • モデルのソースへのリンク。たとえば、Github へのリンク https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 などです。
    • プレーンテキストでのソースの詳細。例:Microsoft Azure

    データタイプ：文字列
    result.asset.state AI モデル資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.asset.supported_languages.name サポートされている言語の名前。

    テーブル:言語 [sys_language]

    データタイプ：文字列
    result.asset.supported_languages.sys_id サポートされている言語のSys_id。

    テーブル:言語 [sys_language]

    データタイプ：文字列
    result.asset.sys_id AI モデル資産レコードのSys_id

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.training_datasets モデルのトレーニングに使用される 1+ つの関連データセットへの参照。

    データタイプ：アレイ

    "training_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    result.asset.training_procedure モデルに適用された AI トレーニングのタイプ。
    可能な値：
    • 1:ディシジョンツリー
    • 2: ディープニューラルネットワーク
    • 3:線形回帰
    • 4:ロジスティック回帰
    • 5:ランダムフォレスト
    • 6:教師あり学習
    • 7:教師なし学習
    • 8:強化学習
    • 9:転移学習
    • 10:半教師あり学習
    • 11:命令ファインチューニング
    • 12:教師ありファインチューニング

    データタイプ：文字列
    result.asset.updated AI モデル資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.version 関連付けられた AI モデル製品モデルレコードのバージョン。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_modelテーブル]

    データタイプ：文字列
    result.required_infrastructure モデルの展開に必要なインフラストラクチャのドキュメント。たとえば、インフラストラクチャスタックや処理のニーズに関する詳細などです。

    データタイプ：文字列
    result.asset.parameters_info 学習プロセス中に学習するトレーニングデータのプロパティ。例: 7B または 30B。

    データタイプ：文字列
    result.asset.supported_languages AI モデル資産でサポートされている言語の詳細。

    テーブル:言語 [sys_language]

    データタイプ: オブジェクト

    "supported_languages": [
 { 
  "name": "String",
  "sys_id": "String"
  }
]
    result.warnings 警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターの sysId が無効な場合などの検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例では、要求本文に指定された詳細に従って AI モデル資産を作成します。

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "name": "Now LLM",
  "description": "enables text-to-text like question answering and summarization",
  "provider": "servicenow",
  "documentation": "Now LLM V5 Documentation",
  "version": "V8",
  "parameters_info": "7B",
  "supported_languages": [
    "English",
    "French"
  ],
  "model_size_in_mb": "87",
  "deployment_guideline": "Deployed on ServiceNow infrastructure",
  "source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
  "training_procedure": "2",
  "context_window": "8000",
  "state": "31",
  "base_model": "Servicenow Now LLM V6",
  "model_weights_info": "refer to weights and biases project",
  "required_infrastructre": "GPUs needed: 1, GPU Type: A100",
  "training_datasets": [
    "Servicenow Open Incidents"
  ],
  "evaluation_datasets": [
    "Servicenow Open Incidents"
  ],
  "evaluation_metrics_report": "Testing results: See files attached to this record",
  "managed_by": "abel.tuter"
}'
    応答本文には、結果のsys_idなど、新しく作成された AI モデル資産に関する詳細が表示されます。
    {
  "result": {
    "asset": {
      "sys_id": "a438d170ff96da10c1fbffffffffffd5",
      "display_name": "ServiceNow Now LLM V6",
      "name": "Now LLM",
      "description": "enables text-to-text like question answering and summarization",
      "version": "V8",
      "provider": {
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
        "name": "ServiceNow"
      },
      "documentation": "Now LLM V5 Documentation",
      "parameters_info": "7B",
      "supported_languages": [
        {
          "sys_id": "914493a30f320010e96b0e4fef767e90",
          "name": "English"
        }
      ],
      "model_size_in_mb": "87",
      "deployment_guideline": "Deployed on ServiceNow infrastructure",
      "source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1",
      "training_procedure": "2",
      "context_window": "8000",
      "state": "Deployed",
      "required_infrastructure": "Servicenow Instance",
      "base_model": {
        "sys_id": "a438d170ff96da10c1fbffffffffffd5",
        "name": "ServiceNow Now LLM V8"
      },
      "evaluation_datasets": [
        {
          "sys_id": "45cb45baff06d610c1fbffffffffffa9",
          "name": "ServiceNow Open Incidents"
        }
      ],
      "training_datasets": [
        {
          "sys_id": "45cb45baff06d610c1fbffffffffffa9",
          "name": "ServiceNow Open Incidents"
        }
      ],
      "evaluation_metrics_report": "Testing results: See files attached to this record",
      "managed_by": {
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter"
      },
      "created": "2024-12-03 16:50:53",
      "updated": "2024-12-12 15:56:28"
    },
    "warnings": [
      "Reference record 'French' not found for supported_languages in table sys_language"
    ]
  }
}

    AI 資産 API - POST /sn_ent/asset/ai_system

    要求本文に指定した詳細に従って、AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルと AI システム製品モデル [cmdb_ai_system_product_model] テーブルに新しい AI システム資産エントリを作成します。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_system

    デフォルト URL: /api/sn_ent/asset/ai_system

    サポートされている要求パラメーター

    表 : 43. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 44. クエリパラメーター
    名前 説明
    なし
    表 : 45. 要求本文パラメーター (XML または JSON)
    名前 説明
    オブジェクト 必須。AI システムで更新する詳細。

    データタイプ: オブジェクト

    { 
  "name": "String", 
  "description": "String", 
  "provider": "String", 
  "version": "String", 
  "state": Number, 
  "documentation": "String", 
  "ai_models": "String", 
  "ai_prompts": "Strings", 
  "evaluation_datasets": [Array], 
  "evaluation_metrics_report": "String", 
  "managed_by": "String" 
}
    object.name 必須。AI システム製品モデルの名前。

    データタイプ：文字列
    object.description AI システム製品モデルの説明。

    データタイプ：文字列
    object.provider 必須。既存の会社 [core_company] テーブルレコードの [プロバイダー] フィールドの値。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    Object.State AI システム資産に適用するステータス。
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列

    デフォルト:空の文字列
    object.version AI システム製品モデルのバージョン。例:V2。

    データタイプ：文字列

    デフォルト:空の文字列
    object.documentation AI システム資産のドキュメント。

    データタイプ：文字列

    Default (デフォルト)：
    object.ai_models 文字列のカンマ区切りリスト。各文字列は、既存の AI モデルデジタル資産レコードの AI モデルフィールド値を表します。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    有効な値：
    • AI モデルデジタル資産レコードの名前。
    • AI モデルデジタル資産レコードのSys_id。

    データタイプ：文字列

    デフォルト:空の文字列
    object.evaluation_datasets AI システム資産レコードの評価に使用される AI データセットのカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI システム資産 [AI システムデジタル資産 alm_ai_system_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [{String", "String"}]
    有効な値：
    • AI データセットデジタル資産レコードの名前。
    • AI データセットデジタル資産レコードのSys_id。

    デフォルト:空の文字列
    object.evaluation_metrics_report AI システム資産レコードのテキストフィールド内にある評価結果への参照。例：
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列

    デフォルト:空の文字列
    object.managed_by 既存のユーザー [sys_user] テーブルレコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 46. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 47. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 48. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 新しい AI システム資産の結果。

    データタイプ: オブジェクト

    "result": {
  "asset": Object,
  "warnings": [Array]
}
    result.asset 新しく作成されたエントリの詳細。

    データタイプ: オブジェクト

    "asset": {
  "ai_model": [Array],
  "ai_prompts": [Array]
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": [Array],
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "name": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    result.asset.ai_models AI システムデジタル資産 [alm_ai_system_digital_asset] レコード内の AI モデルのリスト。

    データタイプ：アレイ

    "ai_models": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_models.name AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードの名前。

    データタイプ：文字列
    result.asset.ai_models.sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.ai_prompts AI システムデジタル資産 [alm_ai_system_digital_asset] レコードの AI プロンプトのリスト。

    データタイプ：アレイ

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_prompts.name AI プロンプトの名前。

    データタイプ：文字列
    result.asset.ai_prompts.sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.created AI モデル資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.description 関連する AI システム製品モデルレコードの説明。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.display_name AI システム資産レコードの表示名。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.documentation 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.asset.evaluation_datasets AI システム資産レコードの評価に使用される AI データセットのリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI システム資産 [alm_ai_system_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.evaluation_datasets.name AI データセットデジタル資産の名前。

    データタイプ：文字列
    result.asset.evaluation_datasets.sys_id AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.evaluation_metrics_report AI システム資産の評価結果。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.asset.managed_by モデルの評価に使用される AI システム資産の AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name AI モデル資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.managed_by.sys_id AI モデル資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.name 関連付けられた AI システム製品モデルレコードの名前。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.provider 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードの [プロバイダー] フィールドの値。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーの名前。

    データタイプ：文字列
    result.asset.provider.sys_id 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.asset.state AI モデル資産のステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.asset.sys_id AI システム資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.updated AI モデル資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.version 関連付けられた AI システム製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列
    result.asset.warnings 警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターのsys_idが無効な場合など、検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例では、要求本文に含まれる詳細を使用して、AI システムデジタル資産テーブルと AI システム製品モデルテーブルに新しいエントリを挿入します。

    curl -X POST 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Incident Summarization", 
  "description": "Incident Summarization Skill", 
  "provider": "servicenow", 
  "documentation": "Sample Documentation", 
  "version": "V2", 
  "state": 31, 
  "ai_models": [ 
    "llm_generic_small", 
    "mixtral-instruct" 
  ], 
  "ai_prompts": [ 
    "LLM Prompt"   
  ], 
  "evaluation_datasets": [ 
    "Base dataset" 
  ], 
  "evaluation_metrics_report": "Sample Report", 
  "managed_by": "abel.tuter" 
}'

    応答本文。

    { 
  "result": { 
    "asset": { 
      "sys_id": "3b140397435a9210a63d00002fb8f2d7", 
      "display_name": "ServiceNow Incident Summarization V2", 
      "name": "Incident Summarization", 
      "description": "Incident Summarization Skill", 
      "version": "V2", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Sample Documentation", 
      "state": "Deployed", 
      "ai_models": [{  
        "sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "llm_generic_small"  
      }, 
      {  
        "sys_id": "7efdc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "mixtral-instruct"  
      }], 
      "ai_prompts": [{  
        "sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "LLM Prompt"  
      }], 
      "evaluation_datasets": [{  
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",  
        "name": "Base dataset"  
      }], 
      "evaluation_metrics_report": "Sample Report", 
      "managed_by": { 
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
        "name": "Abel Tuter" 
      }, 
      "created": "2024-12-11 18:23:09", 
      "updated": "2024-12-11 18:23:09" 
    }, 
    "warnings": [] 
  } 
}

    AI 資産 API - PUT /sn_ent/asset/ai_dataset/{sys_id}

    要求本文に指定した情報に従って、特定の AI データセット資産レコードのデータを更新します。

    注:
    更新する特定のデータのパラメーターと値のペアのみを指定します。このエンドポイントは、要求で送信されるパラメーターのデータを上書きします。

    AI 資産 API:GET /sn_ent/asset/ai_dataset/{sys_id}メソッドを使用して、指定された ID を持つ既存の AI データセットレコードを取得します。その後、この PUT メソッドを使用して、同じ ID 情報を使用してデータセット内の値を更新できます。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_dataset/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_dataset/{sys_id}

    サポートされている要求パラメーター

    表 : 49. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI データセット資産 [alm_ai_dataset_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 50. クエリパラメーター
    名前 説明
    なし
    表 : 51. 要求本文パラメーター (XML または JSON)
    名前 説明
    {object} 
    {
  "acceptable_usage": "String",
  "base_datasets": [Array],
  "dataset_card": "String"
  "data_type": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String", 
  "name": "String", 
  "provider": "String",
  "state": "String" 
  "source": "String",
  "version": "String"
}
    {オブジェクト}.acceptable_usage 通常はトレーニングまたは評価の目的で、データセットまたはモデルを使用する方法を決定します。
    有効な値：
    • 1:トレーニング
    • 2:評価

    データタイプ：文字列
    {オブジェクト}.base_datasets このデータセットを構築するために必要な基本データセットのカンマ区切りリスト。AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブルに存在するデータセットの名前またはsys_idsを受け入れます。

    データタイプ：アレイ

    “base_datasets”: [ “String”, “String”]
    {オブジェクト}.data_type データセットに存在するデータのタイプ。例: テキスト、ビデオ、画像 、 または 1,2。

    データタイプ：文字列
    {オブジェクト}.dataset_card データセットカード。dataset_cardは、AI データセットの内容、構造、およびコンテキストを記述するメタデータドキュメントです。適切な理解と使用を保証するために、データソース、機能、使用目的、既知の制限などの詳細を提供します。

    データタイプ：文字列
    {object}.description AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブル内の関連レコードの説明。

    データタイプ：文字列
    {object}.documentation AI データセット製品モデルのドキュメント。

    データタイプ：文字列
    {オブジェクト}.managed_by 既存のユーザー [sys_user] テーブルレコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列
    {object}.name 必須。AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブル内の関連レコードの名前。

    データタイプ：文字列
    {object}.provider 必須。会社 [core_company] テーブルの既存レコードの [プロバイダー] フィールドの値。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    {object}.source データセットのソースに関する詳細。
    有効な値：
    • データセットのソースへのリンク。
    • プレーンテキストでのソースの詳細。

    データタイプ：文字列

    デフォルト:空または null
    {object}.state AI データセット資産のステータス。
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    {object}.version 関連付けられた AI データセット製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 52. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 53. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 54. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 新しく作成された AI データセット資産の詳細。

    データタイプ: オブジェクト

    "result": {
  "acceptable_usage": {Object},
  "base_datasets": [Array],
  "created": "String",
  "dataset_card": "String",
  "data_type": {Object},
  "description": "String",
  "documentation": "String",
  "display_name": "String",
  "managed_by": {Object},
  "name": "String",
  "provider": {Object},
  "state": "Development",
  "source": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
}
    result.acceptable_usage AI データセット資産レコードの許容可能な使用法。許容される使用法とは、通常、トレーニングまたは評価の目的で、データセットまたはモデルを使用する方法を指します。

    データタイプ: オブジェクト

    "acceptable_usage": {
  "label": "String" 
  "value": "String" 
}
    result.acceptable_usage.label 許容可能な使用値のラベルを表示します。

    データタイプ：文字列
    result.acceptable_usage.value 許容可能な使用法の数値。
    有効な値：
    • 1:トレーニング
    • 2:評価

    データタイプ：文字列
    result.base_datasets 指定されたデータセットをビルドするために必要な基本データセットのカンマ区切りリスト。AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブル内のベースデータセットの名前またはsys_idを受け入れます。

    データタイプ：アレイ

    "base_datasets": ["String", "String"]
    result.created AI データセット資産レコードが作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.data_type AI データセット資産レコードに存在するデータのタイプ。

    データタイプ: オブジェクト

    "data_type": {
  "label": "String",
  "value": "String"
}
    result.data_type.label データタイプ値の表示ラベル。

    データタイプ：文字列
    result.data_type.value データセット資産のデータタイプの値。

    データタイプ：文字列
    result.dataset_card データセットカード。dataset_cardは、AI データセットの内容、構造、およびコンテキストを記述するメタデータドキュメントです。適切な理解と使用を保証するために、データソース、機能、使用目的、既知の制限などの詳細を提供します。

    データタイプ：文字列
    result.description 関連付けられた AI データセット製品モデルレコードの説明。

    テーブル:AI データセット製品モデル [cmdb_ai_dataset_product_model]

    データタイプ：文字列
    result.display_name AI データセット資産レコードの表示名。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.documentation 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.managed_by AI データセット資産レコードを管理するユーザーの詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.managed_by.name AI データセット資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.managed_by.sys_id AI データセット資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.name 関連付けられた AI データセット製品モデルレコードの名前。

    テーブル:AI データセット製品モデル [cmdb_ai_dataset_product_model]

    データタイプ：文字列
    result.provider 関連する AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコードのプロバイダー。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.provider.name プロバイダーの名前。

    データタイプ：文字列
    result.provider.sys_id 関連付けられた AI データセット製品モデル [cmdb_ai_dataset_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.source AI データセット資産のソースに関する詳細。
    有効な値：
    • データセット資産のソースへのリンク。
    • データセット資産のソースの詳細 (プレーンテキスト)。たとえば、製品や Web サイトの名前などです。

    データタイプ：文字列

    デフォルト:空または null
    result.state AI データセット資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.sys_id AI データセット資産レコードのSys_id。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列
    result.updated AI データセット資産レコードが最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.version 関連付けられた AI データセット製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列
    result.warnings データセットの作成時に表示される警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターのsys_idが無効な場合など、検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例は、指定された ID で AI データセットレコードの詳細を更新する方法を示しています。要求本文には、更新するパラメーター値が含まれています。

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_dataset/9833721b331e92101c9aca989d5c7bf0' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Dataset One", 
  "description": "Description for dataset ", 
  "provider": "servicenow", 
  "version": "V1", 
  "state": 31, 
  “source”: “Source of dataset” 
  "documentation": "document", 
  “dataset_card”: “Dataset Card”, 
  “base_datasets”: [ “Dataset Two”, “Dataset Three”], 
  “data_type”: “1,2”, 
  “acceptable_usage”: “1,2”, 
  "managed_by": "abel.tuter" 
}'

    応答本文。

    { 
  "result": { 
    "asset": { 
      "sys_id": "da8393eb40d25210f877b00c113d1fc1", 
      "display_name": "ServiceNow Closed Incidents", 
      "name": "Closed Incidents", 
      "description": "Incidents with resolution", 
      "documentation": "Sample Documentation", 
      "source": "incident table on servicenow instance", 
      "dataset_card": "Dataset Card", 
      "state": "Deployed", 
      "version": null, 
      "data_type": { 
        "value": "1", 
        "label": "Text" 
      }, 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "managed_by": { 
        "sys_id": "undefined", 
        "name": "" 
      }, 
      "acceptable_usage": { 
        "value": "1", 
        "label": "Training" 
      }, 
      "base_datasets": [], 
      "created": "2024-12-12 01:23:03", 
      "updated": "2024-12-12 01:23:03" 
    }, 
    "warnings": [] 
       } 
}

    AI 資産 API - PUT /sn_ent/asset/ai_prompt/{sys_id}

    要求本文に入力した情報に従って、特定の AI プロンプト資産レコードのデータを更新します。

    関連項目：
    注:
    更新する特定のデータのパラメーターと値のペアのみを指定します。このエンドポイントは、要求で送信されるパラメーターのデータを上書きします。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_prompt/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_prompt/{sys_id}

    サポートされている要求パラメーター

    表 : 55. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI プロンプト資産 [alm_ai_prompt_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 56. クエリパラメーター
    名前 説明
    なし
    表 : 57. 要求本文パラメーター (XML または JSON)
    名前 説明
    オブジェクト 必須。更新する AI プロンプト資産のコンテンツ。

    データタイプ: オブジェクト

    {
  "ai_model": "String",
  "description": "String",
  "documentation": "String",
  "managed_by": "String" 
  "name": "String",
  "prompt_info": "String", 
  "provider": "String",
  "state": Number,
  "version": "String"
}
    ai_model AI モデルデジタル資産 [alm_ai_model_digital_asset] テーブルの既存のレコードの [AI モデル] フィールドの値。
    有効な値：
    • AI モデルデジタル資産 [alm_ai_model_digital_asset] レコードの名前
    • AI モデルデジタル資産 [alm_ai_model_digital_asset] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列
    説明 AI プロンプト製品モデルを示す説明。

    テーブル:AI プロンプト製品モデル [cmdb_ai_prompt_product_model]

    データタイプ：文字列

    デフォルト:空の文字列
    ドキュメント AI プロンプト製品モデルのドキュメント。

    データタイプ：文字列

    デフォルト:空の文字列
    managed_by ユーザー [sys_user] テーブルの既存レコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列
    名前 必須。AI プロンプト製品モデル [cmdb_ai_prompt_product_model] テーブル内の関連レコードの名前。

    データタイプ：文字列

    デフォルト:空の文字列
    prompt_info AI プロンプト資産のプロンプト情報。

    データタイプ：文字列

    デフォルト:空の文字列
    プロバイダー 必須。会社 [core_company] テーブルの既存レコードの [プロバイダー] フィールドの値。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    状況 AI モデル資産に適用するステータス。たとえば
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    バージョン AI プロンプト製品モデルに割り当てるバージョン番号。例:V2。

    データタイプ：文字列

    デフォルト:空の文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 58. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 59. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 60. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    404 見つかりません。指定されたsys_idでの資産のフェッチに失敗しました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    結果 
    result: {
  "asset": {Object},
  "warnings": [Array]
}
    result.asset 新しく作成されたエントリの詳細。

    データタイプ: オブジェクト

    "asset": {
  "ai_model": Object,
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "managed_by": Object,
  "name": "String",
  "prompt_info": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    result.asset.ai_model AI システム資産 [cmdb_ai_ system_asset_model] テーブルレコード内の AI モデルのリスト。

    データタイプ：アレイ

    "ai_model": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.ai_models.name AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードの名前。

    データタイプ：文字列
    result.asset.ai_models.sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.created AI モデル資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.description 関連する AI システム製品モデルレコードの説明。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.display_name AI システム資産レコードの表示名。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.documentation 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.asset.managed_by 資産を管理するユーザーに関する詳細。

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name AI モデル資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.managed_by.sys_id AI モデル資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.name 関連付けられた AI システム製品モデルレコードの名前。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.prompt_info AI プロンプト資産レコードのプロンプト情報。

    データタイプ：文字列
    result.asset.provider 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードの [プロバイダー] フィールドの値。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーの名前。

    データタイプ：文字列
    result.asset.provider.sys_id 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.asset.state AI モデル資産のステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.asset.sys_id AI システム資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.updated AI モデル資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.version 関連付けられた AI システム製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列
    result.warning 警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターのsys_idが無効な場合など、検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例では、要求本文で指定されたパラメーター値に従って、指定されたsys_idで AI プロンプト資産のデータを更新します。

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/9833721b331e92101c9aca989d5c7bf0' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -u 'username':'password' \
  -d '{
  "name": "Incident Summarization prompt1",
  "description": "Prompt for Incident Summarization",
  "provider": "servicenow",
  "version": "V1",
  "state": 31,
  "documentation": "Docuuu",
  "ai_model": "mixtral-instruct",
  "prompt_info": "Provide incident summary using short_decription, state, worknotes",
  "managed_by": "abel.tuter"
 }'

    応答本文：

    {
  "result": {
    "asset": {
      "sys_id": "9833721b331e92101c9aca989d5c7bf0",
      "display_name": "ServiceNow Incident Summarization prompt1 V1",
      "name": "Incident Summarization prompt1",
      "description": "Prompt for Incident Summarization",
      "version": "V1",
      "provider": {
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb",
        "name": "ServiceNow"
      },
      "documentation": "Docuuu",
      "state": "Deployed",
      "ai_model": {
        "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",
        "name": "mixtral-instruct"
      },
      "prompt_info": "Provide incident summary using short_decription, state, worknotes",
      "managed_by": {
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter"
      },
      "created": "2024-12-11 04:23:17",
      "updated": "2024-12-11 04:23:17"
    },
    "warnings": []
  }
}

    AI 資産 API - PUT /sn_ent/asset/ai_system/{sys_id}

    要求本文に入力した情報に従って、特定の AI システムレコードのデータを更新します。

    注:
    更新する特定のデータのパラメーターと値のペアのみを指定します。このエンドポイントは、要求で送信されるパラメーターのデータを上書きします。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_system/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_system/{sys_id}

    サポートされている要求パラメーター

    表 : 61. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI システムデジタル資産 [alm_ai_system_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 62. クエリパラメーター
    名前 説明
    なし
    表 : 63. 要求本文パラメーター (XML または JSON)
    名前 説明
    オブジェクト 必須。AI システムで更新する詳細。

    データタイプ: オブジェクト

    { 
  "name": "String", 
  "description": "String", 
  "provider": "String", 
  "version": "String", 
  "state": Number, 
  "documentation": "String", 
  "ai_models": "String", 
  "ai_prompts": "Strings", 
  "evaluation_datasets": [Array], 
  "evaluation_metrics_report": "String", 
  "managed_by": "String" 
}
    object.name 必須。AI システム製品モデルの名前。

    データタイプ：文字列
    object.description AI システム製品モデルの説明。

    データタイプ：文字列
    object.provider 必須。既存の会社 [core_company] テーブルレコードの [プロバイダー] フィールドの値。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    Object.State AI システム資産に適用するステータス。
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列

    デフォルト:空の文字列
    object.version AI システム製品モデルのバージョン。例:V2。

    データタイプ：文字列

    デフォルト:空の文字列
    object.documentation AI システム資産のドキュメント。

    データタイプ：文字列

    Default (デフォルト)：
    object.ai_models 文字列のカンマ区切りリスト。各文字列は、既存の AI モデルデジタル資産レコードの AI モデルフィールド値を表します。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    有効な値：
    • AI モデルデジタル資産レコードの名前。
    • AI モデルデジタル資産レコードのSys_id。

    データタイプ：文字列

    デフォルト:空の文字列
    object.evaluation_datasets AI システム資産レコードの評価に使用される AI データセットのカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI システム資産 [AI システムデジタル資産 alm_ai_system_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [{String", "String"}]
    有効な値：
    • AI データセットデジタル資産レコードの名前。
    • AI データセットデジタル資産レコードのSys_id。

    デフォルト:空の文字列
    object.evaluation_metrics_report AI システム資産レコードのテキストフィールド内にある評価結果への参照。例：
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列

    デフォルト:空の文字列
    object.managed_by 既存のユーザー [sys_user] テーブルレコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列

    デフォルト:空の文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 64. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 65. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 66. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    404 見つかりません。指定されたsys_idでの資産のフェッチに失敗しました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    結果 更新された AI システム資産の結果。

    データタイプ: オブジェクト

    "result": {
  "asset": Object,
  "warnings": [Array]
}
    result.asset 新しく作成された資産の詳細。

    データタイプ: オブジェクト

    "asset": {
  "ai_model": [Array],
  "ai_prompts": [Array]
  "created": "String",
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": Array,
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "name": "String",
  "provider": Object,
  "state": "String",
  "sys_id": "String",
  "updated": "String",
  "version": "String",
  "warnings": [Array]
}
    result.ai_models AI システムデジタル資産 [alm_ai_system_digital_asset] テーブルレコード内の AI モデルのリスト。

    データタイプ：アレイ

    "ai_models": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_models.name AI システムデジタル資産レコードの名前。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.ai_models.sys_id AI システムデジタル資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.ai_prompts AI システム資産レコード内の AI プロンプトのリスト。

    データタイプ：アレイ

    "ai_prompts": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.ai_prompts.name AI プロンプトの名前。

    データタイプ：文字列
    result.ai_prompts.sys_id AI プロンプトデジタル資産レコードのSys_id。

    テーブル:AI プロンプトデジタル資産 [alm_ai_prompt_digital_asset]

    データタイプ：文字列
    result.asset.created AI モデル資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.description 関連する AI システム製品モデルレコードの説明。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.display_name AI システム資産レコードの表示名。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.documentation 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードのドキュメント。

    データタイプ：文字列
    result.asset.evaluation_datasets AI システム資産レコードの評価に使用される AI データセットのリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI システム資産 [alm_ai_system_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.evaluation_datasets.name AI データセットデジタル資産の名前。

    データタイプ：文字列
    result.asset.evaluation_datasets.sys_id AI データセットデジタル資産 [alm_ai_dataset_digital_asset] テーブルレコードのSys_id。

    データタイプ：文字列
    result.asset.evaluation_metrics_report AI システム資産の評価結果。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.asset.managed_by モデルの評価に使用される AI システム資産の AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ: オブジェクト

    "managed_by": [
  {
  "name": "String",
  "sys_id": "String"
  }
]
    result.asset.managed_by.name AI モデル資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.managed_by.sys_id AI モデル資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.name 関連付けられた AI システム製品モデルレコードの名前。

    テーブル:AI システム製品モデル [cmdb_ai_system_product_model]

    データタイプ：文字列
    result.asset.provider 関連する AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコードの [プロバイダー] フィールドの値。

    データタイプ: オブジェクト

    provider: {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーの名前。

    データタイプ：文字列
    result.asset.provider.sys_id 関連付けられた AI システム製品モデル [cmdb_ai_ system_product_model] テーブルレコード内のプロバイダーのSys_id。

    データタイプ：文字列
    result.asset.state AI モデル資産のステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.asset.sys_id AI システム資産レコードのSys_id。

    テーブル:AI システムデジタル資産 [alm_ai_system_digital_asset]

    データタイプ：文字列
    result.asset.updated AI モデル資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.version 関連付けられた AI システム製品モデルレコードのバージョン番号。例:V2。

    データタイプ：文字列
    result.asset.warnings 警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターのsys_idが無効な場合など、検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例では、要求本文で更新する詳細を使用して AI システムを更新します。

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_prompt/3b140397435a9210a63d00002fb8f2d7' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d '{ 
  "name": "Incident Summarization", 
  "description": "Skill to summarize incident", 
  "provider": "servicenow", 
  "documentation": "Sample Documentation", 
  "version": "V3", 
  "state": 31, 
  "ai_models": [ 
    "llm_generic_small" 
  ], 
  "ai_prompts": [ 
    "LLM Prompt" 
  ], 
  "evaluation_datasets": [ 
    "Base dataset" 
  ], 
  "evaluation_metrics_report": "Sample Report", 
  "managed_by": "abel.tutor" 
}'

    応答本文には、指定された AI システムsys_idに適用された更新の結果が表示されます。

    { 
  "result": { 
    "asset": { 
      "sys_id": "3b140397435a9210a63d00002fb8f2d7", 
      "display_name": "ServiceNow Incident Summarization V2", 
      "name": "Incident Summarization", 
      "description": "Skill to summarize incident", 
      "version": "V3", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Sample Documentation", 
      "state": "Deployed", 
      "ai_models": [{  
       "sys_id": "9tgdc7e6eb1e5210aa82fab8bad0cda2",  
       "name": "llm_generic_small"  
     }], 
      "ai_prompts": [{  
       "sys_id": "7d7dc7e6eb1e5210aa82fab8bad0cda2",  
       "name": "LLM Prompt"  
     }], 
      "evaluation_datasets": [{  
       "sys_id": "9d7dc7e6eb1e5210aa82fab8bad0cda2",  
       "name": "Base dataset"  
     }], 
      "evaluation_metrics_report": "Sample Report", 
      "managed_by": { 
        "sys_id": "a8f98bb0eb32010045e1a5115206fe3a", 
        "name": "Abraham Lincoln" 
      }, 
      "created": "2024-12-11 19:07:13", 
      "updated": "2024-12-11 19:07:42" 
    }, 
    "warnings": [] 
  } 
}

    AI 資産 API - PUT /sn_ent/asset/ai_model/{sys_id}

    要求本文に入力した情報に従って、特定の AI モデル資産レコードのデータを更新します。

    注:
    更新する特定のデータのパラメーターと値のペアのみを指定します。このエンドポイントは、要求で送信されるすべてのパラメーターのデータを上書きします。

    URL 形式

    バージョニングされた URL: /api/sn_ent/{api_version}/asset/ai_model/{sys_id}

    デフォルト URL: /api/sn_ent/asset/ai_model/{sys_id}

    サポートされている要求パラメーター

    表 : 67. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    sys_id AI プロンプト資産 [alm_ai_prompt_digital_asset] テーブル内の資産のSys_id。

    データタイプ：文字列
    表 : 68. クエリパラメーター
    名前 説明
    なし
    表 : 69. 要求本文パラメーター (XML または JSON)
    名前 説明
    オブジェクト 必須。指定された AI モデルで更新する詳細。

    データタイプ: オブジェクト

    {
  "base_model": "String",
  "context_window": "String",
  "deployment_guideline": "String",
  "description": "String",
  "documentation": "String",
  "evaluation_datasets": "String",
  "evaluation_metrics_report": "String",
  "managed_by": "String",
  "model_size_in_mb": "String",
  "model_weights_info": "String",
  "name": "String",
  "parameters_info": "String",
  "provider": "String",
  "required_infrastructure": "String",
  "state": Number,
  "supported_languages": "String",
  "training_datasets": "String",
  "training_procedure": "String",
  "version": "String"
}
    base_model このモデルバージョンの派生元となった AI モデル。
    注:
    組織内で開発されたモデルにのみ適用されます。

    データタイプ: オブジェクト

    {
  "name": "String",
  "sys_id": "String"
 }

    デフォルト:空のオブジェクト
    base_model.name この AI モデルをモデル化する AI モデル資産の名前。

    データタイプ：文字列
    base_model.sys_id この AI モデルをモデル化する AI モデル資産のSys_id。

    テーブル:AI モデルデジタル資産alm_ai_model_digital_asset

    データタイプ：文字列
    context_window モデルが処理できる入力シーケンスのサイズ (つまり、トークンの数)。

    データタイプ：整数

    デフォルト：0
    deployment_guideline 組織内で開発および展開されたモデルに適用される手順。

    データタイプ：文字列

    デフォルト：空
    説明 AI モデル製品モデルを示す説明。

    テーブルで更新:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列

    デフォルト：空
    ドキュメント AI プロンプト製品モデルレコードのドキュメント。

    テーブル:AI プロンプト製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列

    デフォルト：空
    evaluation_datasets モデルの評価に使用される AI プロンプトデジタル資産の AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI プロンプトデジタル資産 [alm_ai_prompt_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  "String",
  "String"
]
    有効な値：
    • AI データセットデジタル資産レコードの名前。
    • AI データセットデジタル資産レコードのSys_id。

    デフォルト:空の文字列
    evaluation_metrics_report AI データセット資産レコードのテキストフィールド内にある評価結果への参照。例：
    Testing results:  link to the result document

Details:
Accuracy: 85%
Hallucination: 10%
Eval Run 1: link
Eval Run 2: link

    テーブル:AI データセット資産 [alm_ai_dataset_digital_asset]

    データタイプ：文字列

    デフォルト:空の文字列
    managed_by ユーザー [sys_user] テーブルの既存レコードの [管理担当者] フィールドの値。
    有効な値：
    • ユーザー [sys_user] レコードの名前
    • ユーザー [sys_user] レコードのSys_id

    データタイプ：文字列

    デフォルト：空
    model_size_in_mb モデルのサイズ (MB)。主に、組織内で開発および展開されたモデルに適用されます。

    データタイプ：数値

    デフォルト：空
    model_weights_info 追加のモデル情報 (利用可能な場合)。主に組織内で開発されたモデルに適用されます。

    データタイプ：文字列

    デフォルト：空
    名前 必須。AI モデル製品モデルの名前。

    テーブルで更新:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    parameters_info モデルに与えるパラメーターの数。

    データタイプ：文字列

    デフォルト:空の文字列
    プロバイダー 必須。既存の会社 [core_company] テーブルレコードの [プロバイダー] フィールドの値。このプロバイダーを新しい AI モデルにアサインします。
    有効な値：
    • 会社の名前 [core_company] レコード
    • 会社の [core_company] レコードのSys_id

    データタイプ：文字列
    required_infrastructure モデル展開に必要なインフラストラクチャのドキュメント。たとえば、インフラストラクチャスタックや処理のニーズに関する詳細などです。主に、組織内に展開されたモデルに適用されます。

    データタイプ：文字列

    デフォルト：空
    ソース 誰が、または何がモデルを作成したかのソースに関する詳細。
    有効な値：
    • モデルのソースへのリンク。たとえば、Github へのリンク https://huggingface.co/mistralai/model1 などです。
    • プレーンテキストでのソースの詳細。例:Microsoft Azure

    データタイプ：文字列

    デフォルト:空または null
    状況 AI モデル資産に適用するステータス。
    有効な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    supported_languages AI モデルでサポートされている言語のカンマ区切りリスト。

    データタイプ：アレイ

    "supported_languages": [
  "String",
  "String"
]
    有効な値：
    • 言語 [sys_language] レコードのSys_id
    • 言語 [sys_language] レコードの名前。例:「フランス語」、「英語」

    デフォルト:空の文字列
    training_datasets モデルのトレーニングに使用される 1+ つの関連データセットへの参照。AI データセット資産 [alm_ai_dataset_digital_asset] テーブルのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    データタイプ：アレイ

    "training_datasets": [
  "String",
  "String"
]

    デフォルト:空の文字列
    training_procedure AI モデルに適用するトレーニングのタイプ。
    有効な値：
    • 1:ディシジョンツリー
    • 2: ディープニューラルネットワーク
    • 3:線形回帰
    • 4:ロジスティック回帰
    • 5:ランダムフォレスト
    • 6:教師あり学習
    • 7:教師なし学習
    • 8:強化学習
    • 9:転移学習
    • 10:半教師あり学習
    • 11:命令ファインチューニング
    • 12:教師ありファインチューニング

    データタイプ:数値で表される文字列 ( 例:「3」)

    デフォルト:1:ディシジョンツリー
    バージョン AI モデル製品モデルのバージョン。例:V2。

    データタイプ：文字列

    デフォルト：空

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 70. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 71. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 72. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。

    応答本文のパラメーター (JSON または XML)

    [Name (名前)] 説明
    結果 AI モデル資産作成の結果。

    データタイプ: オブジェクト

    "result": { 
    "asset": Object, 
    "warnings": [Array], 
 }
    result.asset 作成された AI モデル資産の詳細。

    データタイプ: オブジェクト

    "asset": {
  "base_model": Object,
  "context_window": String,
  "created": "String",
  "deployment_guideline": String,
  "description": "String",
  "display_name": "String",
  "documentation": "String",
  "evaluation_datasets": Array,
  "evaluation_metrics_report": String,
  "managed_by": Object,
  "model_size_in_mb": String,
  "name": "String",
  "parameters_info": "String",
  "provider": Object,
  "required_infrastructure": String,
  "state": "String",
  "source": String, 
  "supported_languages": Array,
  "sys_id": "String",
  "training_datasets": Array,
  "training_procedure": String,
  "updated": "String",
  "version": "String"
}
    result.asset.base_model このバージョンの派生元である AI モデル資産に関する情報。

    データタイプ: オブジェクト

    "base_model": { 
  "name": "String",
  "sys_id": "String"
}
    result.asset.base_model.name AI モデル資産の表示名。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.base_model.sys_id AI モデル資産のSys_id。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.context_window モデルが処理できる入力シーケンスのサイズ。つまり、トークンの数です。

    データタイプ:数値で表される文字列。例: 「6000」。
    result.asset.created AI モデル資産が作成された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.deployment_guideline 組織内で開発および展開されたモデルに適用される手順。

    データタイプ：文字列
    result.asset.description 関連する AI モデル製品モデルレコードの説明。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.display_name AI モデル資産レコードの表示名。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset] (display_nameフィールド)

    データタイプ：文字列
    result.asset.documentation 関連する AI モデル製品モデルレコードのドキュメント。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.evaluation_datasets モデルの評価に使用される AI モデルデジタル資産の AI データセットのsys_ids名または表示名のカンマ区切りリスト。主に組織内で開発されたモデルに適用されます。

    テーブル:AI データセットデジタル資産 [alm_ai_dataset_digital_asset]、AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：アレイ

    "evaluation_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    result.evaluation_datasets.name AI データセットデジタル資産の名前。

    データタイプ：文字列
    result.evaluation_datasets.sys_id AI モデルデジタル資産レコードのSys_id。

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.evaluation_metrics_report 評価結果への参照。
    可能な値：
    • 結果の概要を示す詳細 (プレーンテキスト)
    • 特定の結果へのリンク

    データタイプ：文字列
    result.asset.managed_by AI モデル資産レコードを管理するユーザー。

    データタイプ: オブジェクト

    " managed_by": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.managed_by.name AI モデル資産レコードを管理するユーザーの名前。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.managed_by.sys_id AI モデル資産レコードを管理するユーザーのSys_id。

    テーブル:ユーザー [user]

    データタイプ：文字列
    result.asset.model_size_in_mb モデルのサイズ (MB)。通常、組織内で開発および展開されたモデルに適用されます。

    データタイプ：数値
    result.asset.name 関連付けられた AI モデル製品モデルレコードの名前。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.provider 関連する AI モデル製品モデルレコードのプロバイダー。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ: オブジェクト

    "provider": {
  "name": "String",
  "sys_id": "String"
}
    result.asset.provider.name プロバイダーの名前。

    データタイプ：文字列
    result.asset.provider.sys_id 関連する AI モデル製品モデルレコードのプロバイダーに対応する会社 [core_company] テーブルからのレコードSys_id。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_model]

    データタイプ：文字列
    result.asset.source 資産のソースに関する詳細。
    有効な値：
    • モデルのソースへのリンク。たとえば、Github へのリンク https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1 などです。
    • プレーンテキストでのソースの詳細。例:Microsoft Azure

    データタイプ：文字列
    result.asset.state AI モデル資産レコードのステータス。
    可能な値：
    • 1:使用中
    • 31:展開済み
    • 32:廃止
    • 33:開発
    • 34:不明
    • 35:該当なし

    データタイプ：文字列
    result.asset.supported_languages.name サポートされている言語の名前。

    テーブル:言語 [sys_language]

    データタイプ：文字列
    result.asset.supported_languages.sys_id サポートされている言語のSys_id。

    テーブル:言語 [sys_language]

    データタイプ：文字列
    result.asset.sys_id AI モデル資産レコードのSys_id

    テーブル:AI モデルデジタル資産 [alm_ai_model_digital_asset]

    データタイプ：文字列
    result.asset.training_datasets モデルのトレーニングに使用される 1+ つの関連データセットへの参照。

    データタイプ：アレイ

    "training_datasets": [
  { 
  "name": "String",
  "sys_id": "String"
  } 
]
    result.asset.training_procedure モデルに適用された AI トレーニングのタイプ。
    可能な値：
    • 1:ディシジョンツリー
    • 2: ディープニューラルネットワーク
    • 3:線形回帰
    • 4:ロジスティック回帰
    • 5:ランダムフォレスト
    • 6:教師あり学習
    • 7:教師なし学習
    • 8:強化学習
    • 9:転移学習
    • 10:半教師あり学習
    • 11:命令ファインチューニング
    • 12:教師ありファインチューニング

    データタイプ：文字列
    result.asset.updated AI モデル資産が最後に更新された日時。

    形式：YYYY-MM-DD HH:mm:ss

    データタイプ：文字列
    result.asset.version 関連付けられた AI モデル製品モデルレコードのバージョン。

    テーブル:AI モデル製品モデル [cmdb_ai_model_product_modelテーブル]

    データタイプ：文字列
    result.required_infrastructure モデルの展開に必要なインフラストラクチャのドキュメント。たとえば、インフラストラクチャスタックや処理のニーズに関する詳細などです。

    データタイプ：文字列
    result.asset.parameters_info 学習プロセス中に学習するトレーニングデータのプロパティ。例: 7B または 30B。

    データタイプ：文字列
    result.asset.supported_languages AI モデル資産でサポートされている言語の詳細。

    テーブル:言語 [sys_language]

    データタイプ: オブジェクト

    "supported_languages": [
 { 
  "name": "String",
  "sys_id": "String"
  }
]
    result.warnings 警告メッセージのカンマ区切りリスト。これらの警告は、オプションのパラメーターの sysId が無効な場合などの検証チェックである可能性があります。

    データタイプ：アレイ

    "warnings": ["String"]

    cURL 要求

    次の例は、PUT メソッドを使用して特定の AI 資産モデルを更新する方法を示しています。

    curl -X PUT 'https://instance.servicenow.com/api/sn_ent/asset/ai_model/9833721b331e92101c9aca989d5c7bf0' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
-d '{ 
    "name": "Now LLM", 
    "description": "enables text-to-text like question answering and summarization", 
    "provider": "servicenow", 
    "documentation": "Now LLM V5 Documentation", 
    "version": "V8", 
    "parameters_info": "7B", 
    "supported_languages": [ 
        "English", 
        "French" 
    ], 
    "model_size_in_mb": "87", 
    "deployment_guideline": "Deployed on ServiceNow infrastructure", 
    "source": "huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1", 
    "training_procedure": "2", 
    "context_window": "8000", 
    "state": "31", 
    "base_model": "Servicenow Now LLM V6", 
    "model_weights_info": "refer to weights and biases project", 
    "required_infrastructre": "GPUs needed: 1, GPU Type: A100", 
    "training_datasets": [ 
        "Servicenow Open Incidents" 
    ], 
    "evaluation_datasets": [ 
        "Servicenow Open Incidents" 
    ], 
    "evaluation_metrics_report": "Testing results: See files attached to this record", 
    "managed_by": "abel.tuter" 
}'

    応答本文。

     { 
  "result": { 
    "asset": { 
      "sys_id": "a438d170ff96da10c1fbffffffffffd5", 
      "display_name": "ServiceNow Now LLM V6", 
      "name": "Now LLM", 
      "description": "enables text-to-text like question answering and summarization", 
      "version": "V8", 
      "provider": { 
        "sys_id": "93d4ecfac0a8000b6294d71b733977fb", 
        "name": "ServiceNow" 
      }, 
      "documentation": "Now LLM V5 Documentation", 
      "parameters_info": "7B", 
      "supported_languages": [ 
        { 
          "sys_id": "914493a30f320010e96b0e4fef767e90", 
          "name": "English" 
        } 
      ], 
      "model_size_in_mb": "87", 
      "deployment_guideline": "Deployed on ServiceNow infrastructure", 
      "source": "https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1", 
      "training_procedure": "2", 
      "context_window": "8000", 
      "state": "Deployed", 
      "required_infrastructure": "undefined", 
      "base_model": { 
        "sys_id": "a438d170ff96da10c1fbffffffffffd5", 
        "name": "ServiceNow Now LLM V8" 
      }, 
      "evaluation_datasets": [ 
        { 
          "sys_id": "45cb45baff06d610c1fbffffffffffa9", 
          "name": "ServiceNow Open Incidents" 
        } 
      ], 
      "training_datasets": [ 
        { 
          "sys_id": "45cb45baff06d610c1fbffffffffffa9", 
          "name": "ServiceNow Open Incidents" 
        } 
      ], 
      "evaluation_metrics_report": "Testing results: See files attached to this record", 
      "managed_by": { 
        "sys_id": "62826bf03710200044e0bfc8bcbe5df1", 
        "name": "Abel Tuter" 
      }, 
      "created": "2024-12-03 16:50:53", 
      "updated": "2024-12-12 15:56:28" 
    }, 
    "warnings": [ 
      "Reference record 'French' not found for supported_languages in table sys_language" 
    ] 
  } 
}