Skip to content

REST APIの変更履歴

変更履歴には、 DataRobotのREST APIクライアントの各バージョンのリリースにおける、注目すべき変更点のリストが含まれています。 DataRobotの最新バージョンの変更点を見るには、以下の変更履歴を参照し、目次で過去のバージョンを見ます。

v2.39の変更履歴

DataRobotのREST APIバージョン2.39で導入された変更点を参照します。

新機能

  • カスタム指標を一括アップロードするためのエンドポイントPOST /api/v2/deployments/{deploymentId}/customMetrics/bulkUpload/が追加されました。

  • プロンプトテンプレート管理で生成AIワークフローのLLMとプロンプトテンプレートを管理するための新しいエンドポイントが追加されました。 この機能により、ユーザーはLLM情報の取得、バージョン管理をサポートするプロンプトテンプレートの作成と管理、および生成AIアプリケーション間で一貫して使用するためのプロンプトの整理を行うことができます。 プロンプトテンプレートはバージョン管理が可能であり、時間の経過に伴う変更を追跡し、再現性を維持することができます。 エンドポイントは、作成からバージョン追跡までのプロンプト管理のライフサイクル全体をサポートし、プロンプトを体系的に開発、テスト、デプロイできるようにします。

    • GET /api/v2/genai/llms/{llmId}/
    • GET /api/v2/genai/promptTemplates/
    • POST /api/v2/genai/promptTemplates/
    • GET /api/v2/genai/promptTemplates/{promptTemplateId}/
    • GET /api/v2/genai/promptTemplates/{promptTemplateId}/versions/
    • POST /api/v2/genai/promptTemplates/{promptTemplateId}/versions/
    • GET /api/v2/genai/promptTemplates/{promptTemplateId}/versions/{promptTemplateVersionId}/
    • GET /api/v2/otel/{entityType}/{entityId}/metrics/autocollectedValues/
  • OpenTelemetry指標のオブザーバビリティのための新しいエンドポイントが追加されました。 OpenTelemetryの指標データを取得し、DataRobotエンティティの監視と観察を行います。 この機能により、自動的に収集された指標、ポッド、コンテナの情報、および属性ごとにグループ化された時間経過に伴う指標値へのアクセスが可能となります。 エンドポイントにより、標準化されたOpenTelemetry指標を通じて、システムパフォーマンス、リソースの使用状況、アプリケーションの正常性を監視できます。 また、パフォーマンスの問題をトラブルシューティングしたり、デプロイやその他のエンティティ全体におけるリソース消費パターンを把握したりするのにも役立ちます。

    • GET /api/v2/otel/{entityType}/{entityId}/metrics/podInfo/
    • POST /api/v2/otel/{entityType}/{entityId}/metrics/valuesOverTime/segments/
    • GET /api/v2/tenantUsageResources/
  • テナント利用とリソース管理のための新しいエンドポイントが追加されました。 エンドポイントを使って、テナントのリソース使用状況とアクティブなユーザーの情報を監視およびエクスポートし、管理上の監督とキャパシティプランニングを行います。 この機能により、システム管理者と組織管理者は、テナント全体のリソース消費状況の追跡、アクティブなユーザーの特定、利用可能なリソースカテゴリーの取得、レポート作成や分析のための使用状況データのエクスポートができます。 エンドポイントは、テナント別とクラスター全体の両方の使用状況レポートをサポートしているため、管理者はプラットフォームの使用状況を把握して、キャパシティプランニングと効率的なリソース割り当てを行うことができます。

    • GET /api/v2/tenantUsageResources/activeUsers/
    • GET /api/v2/tenantUsageResources/categories/
    • GET /api/v2/tenantUsageResources/export/

APIの変更

  • GET /api/v2/comments/{entityType}/{entityId}/のパラメーターentityTypeのスキーマが更新されました。

  • GET /api/v2/entityNotificationPolicies/{relatedEntityType}/{relatedEntityId}/のパラメーターeventGroupのスキーマが更新されました。

  • GET /api/v2/entityNotificationPolicyTemplates/{relatedEntityType}/のパラメーターeventGroupのスキーマが更新されました。

  • GET /api/v2/notificationPolicies/のパラメーターeventGroupのスキーマが更新されました。

  • 新しいオプションパラメーターskip_consentPOST /api/v2/externalOAuth/providers/{providerId}/authorize/に追加されました。

  • GET /api/v2/genai/llms/のパラメーターlimitのスキーマが更新されました。

  • 新しいオプションパラメーターspanIdGET /api/v2/otel/{entityType}/{entityId}/logs/に追加されました。

  • GET /api/v2/tenants/{tenantId}/activeUsers/の説明が更新されました。

  • GET /api/v2/tenants/{tenantId}/resourceCategories/のパラメーターtenantId(パス)が削除されました。

  • GET /api/v2/tenants/{tenantId}/usage/の説明が更新されました。

  • GET /api/v2/tenants/{tenantId}/usageExport/の説明が更新されました。

v2.38の変更履歴

使用非推奨のサマリー

  • POST /api/v2/deployments/(deploymentId)/retrainingPolicies/PATCH /api/v2/deployments/(deploymentId)/retrainingPolicies/(retrainingPolicyId)/で、トリガープロパティ内のcustomJobIdフィールドが使用非推奨になりました。 このフィールドはv2.40で削除されます。

  • custom_jobトリガータイプは、POST /api/v2/deployments/(deploymentId)/retrainingPolicies/PATCH /api/v2/deployments/(deploymentId)/retrainingPolicies/(retrainingPolicyId)/ではサポートされなくなりました。 カスタムジョブの再トレーニングポリシーを作成するには、代わりにmodel_selection: custom_jobを使用します。 このオプションはドキュメントに記載されなくなり、v2.40で削除される予定です。

v2.37の変更履歴

DataRobot REST APIのv2.37では、変更点は報告されていません。

v2.36の変更履歴

新機能

  • ロールベースのアクセス管理のための新しいエンドポイントが追加されました。 以下のエンドポイントを使用します。

  • GET /api/v2/accessRoles/

  • GET /api/v2/accessRoles/{role_id}/
  • POST /api/v2/accessRoles/
  • PUT /api/v2/accessRoles/{role_id}/
  • DELETE /api/v2/accessRoles/{role_id}/
  • GET /api/v2/accessRoles/users/

  • 増分学習モデルを初期化し、チャンキングサービスPOST /api/v2/projects/(projectId)/incrementalLearningModels/fromSampleModel/を使用してトレーニングを開始するエンドポイントが追加されました。 これを使用するには、機能フラグ「プロジェクトを開始するためのサンプルデータ」を有効にします。

  • デプロイのmodel_historyを取得するためのエンドポイントGET /api/v2/deployments/(deploymentId)/modelHistory/が追加されました。

  • セキュアな構成管理のための新しいAPIが追加されました。 以下のエンドポイントを使用します。

  • POST /api/v2/secureConfigs/

  • GET /api/v2/secureConfigSchemas/
  • GET /api/v2/secureConfigSchemas/(secureConfigSchemaId)/
  • PATCH /api/v2/secureConfigs/(secureConfigId)/
  • GET /api/v2/secureConfigs/(secureConfigId)/values/
  • GET /api/v2/secureConfigs/(secureConfigId)/sharedRoles/
  • PATCH /api/v2/secureConfigs/(secureConfigId)/sharedRoles/
  • GET /api/v2/deployments/(deploymentId)/dataQualityView/では、startおよびendクエリーパラメーターは不要になりました。 指定がない場合、デフォルト値が1週間提供されます。
  • POST /api/v2/deployments/{deploymentId}/predictionDataExports/では、startおよびendボディーパラメーターは不要になりました。 指定がない場合、デフォルト値が1週間提供されます。

使用非推奨のサマリー

  • フィールドcapabilitiesは、2.29で使用非推奨になったため、GET /api/v2/deployments/およびGET /api/v2/deployments/(deploymentId)/から削除されました。代わりに、GET /api/v2/deployments/(deploymentId)/capabilities/を使用してください。
  • クエリーパラメーターtargetClassesは、2.31で使用非推奨になったため、GET /api/v2/deployments/(deploymentId)/accuracy/およびGET /api/v2/deployments/(deploymentId)/accuracyOverTime/から削除されました。代わりに、targetClassクエリーパラメーターを使用してください。
  • GET /api/v2/deployments/(deploymentId)/accuracy/からmetricsおよびmodelIdフィールドが使用非推奨になりました。代わりに、同じエンドポイントのdataフィールドを使用してください。 使用非推奨のフィールドは2.40で削除されます。

v2.35の変更履歴

DataRobotのREST APIバージョン2.35で導入された変更点を参照します。

新機能

  • OCRジョブに新しいエンドポイントが追加されました。 これは、PDFを含むデータセットを処理するための機能です。 データセット内のPDFに対してOCRを実行し、それらのPDF内のすべての画像をテキストに置き換えます。 この機能は、次のエンドポイントで構成されています。

    • POST /api/v2/ocrJobResources/
    • GET /api/v2/ocrJobResources/(jobResourceId)/
    • GET /api/v2/ocrJobResources/(jobResourceId)/errorReport/
    • GET /api/v2/ocrJobResources/(jobResourceId)/jobStatus/
    • POST /api/v2/ocrJobResources/(jobResourceId)/start/

APIの変更

  • 自動増分学習オプションを含むプロジェクト用の新しいオプションパラメーターnumberOfIncrementalLearningIterationsBeforeBestModelSelectionPATCH /api/v2/projects/(projectId)/aim/に追加されました。 これは自動増分学習のオートパイロットモードで使用されます。

  • SHAP分布データを計算および取得するエンドポイントが追加されました。

  • POST /api/v2/insights/shapDistributions/
  • GET /api/v2/insights/shapDistributions/models/(entityId)/

使用非推奨のサマリー

  • Primeモデルの作成がサポートされなくなったため、APIエンドポイントGET /api/v2/projects/(projectId)/models/(modelId)/primeInfo/は使用非推奨になりました。
  • クエリーパラメーターのprojectIdapplicationIdGET /api/v2/useCases/には使用非推奨になりました。

ドキュメントの変更

  • POST /api/v2/notifications/に対する正しい予期されるHTTP応答コードが文書化されました。 これは201を返す必要がありますが、200は以前に文書化されました。
  • PATCH /api/v2/ssoConfigurations/(configurationId)/に対する正しい予期されるHTTP応答コードが文書化されました。 これは204を返す必要がありますが、200は以前に文書化されました。 2025年6月

v2.34の変更履歴

DataRobotのREST APIバージョン2.34で導入された変更点を参照します。

新機能

  • カスタムジョブからホストされたカスタム指標を作成するエンドポイントPOST /api/v2/deployments/(deploymentId)/customMetrics/fromCustomJob/が追加されました。
  • ホストされたカスタム指標を一覧表示するエンドポイントGET /api/v2/customJobs/(customJobId)/customMetrics/が追加されました。
  • ホストされたカスタム指標を更新するエンドポイントPATCH /api/v2/deployments/(deploymentId)/customMetrics/(customMetricId)/が追加されました。
  • ホストされたカスタム指標を削除するエンドポイントDELETE /api/v2/deployments/(deploymentId)/customMetrics/(customMetricId)/が追加されました。
  • ホストされたカスタム指標のギャラリーテンプレートからカスタムジョブを作成するエンドポイントPOST /api/v2/customJobs/fromHostedCustomMetricGalleryTemplate/が追加されました。
  • ホストされたカスタム指標のブループリントを作成するエンドポイントPOST /api/v2/customJobs/(customJobId)/hostedCustomMetricTemplate/が追加されました。
  • ホストされたカスタム指標のブループリントを取得するエンドポイントGET /api/v2/customJobs/(customJobId)/hostedCustomMetricTemplate/が追加されました。
  • ホストされたカスタム指標のブループリントを更新するエンドポイントGET /api/v2/customJobs/(customJobId)/hostedCustomMetricTemplate/が追加されました。

機能強化

  • /api/v2/insights/*エンドポイントグループでのインサイトのリクエストでentityTypeパラメーターが受け入れられるようになり、customModelエンティティとネイティブdatarobotModelエンティティのインサイトの計算が可能になりました。 カスタムモデルのインサイトを計算するには、最初にPOST /api/v2/modelComplianceDocsInitializations/(entityId)/を呼び出してインサイトを初期化する必要があります。

  • SHAPインパクト取得のAPIエンドポイントGET /api/v2/insights/shapImpact/models/(entityId)/からのレスポンスが変更されました。 shapImpactsパラメーターはキーペア値のリストになりました。 レスポンスからcappingパラメーターが削除されました。

使用非推奨のサマリー

  • APIエンドポイントGET /api/v2/projects/(projectId)/models/は使用非推奨です。 代わりに、GET /api/v2/projects/(projectId)/modelRecords/を使用してください。
  • APIエンドポイント/projects/(projectId)/featureAssocationFeaturelists/は、リリース2.19で使用非推奨となった後、削除されます。ユーザーは引き続きGET /api/v2/projects/(projectId)/featureAssociationFeaturelists/を使用する必要があります。
  • GET /api/v2/useCases/およびGET /api/v2/useCases/(useCaseId)/のフィールドmodelsCountは使用非推奨であり、2025年6月に削除されます。