Skip to content

アプリケーション内で をクリックすると、お使いのDataRobotバージョンに関する全プラットフォームドキュメントにアクセスできます。

REST APIの変更履歴

DataRobotのREST APIの新バージョンにおける変更点です。

DataRobot REST API v2.32

新機能

  • ドキュメントのサムネイルについてのインサイトを新たなルートで取得できます。
    • GET /api/v2/projects/(projectId)/documentThumbnails/
    • GET /api/v2/projects/(projectId)/documentPages/(documentPageId)/file/
    • GET /api/v2/projects/(projectId)/documentThumbnailSamples/
    • GET /api/v2/projects/(projectId)/documentThumbnailBins/
  • ドキュメントのテキスト抽出サンプルについてのインサイトを新たなルートで計算・取得できます。
    • POST /api/v2/models/(modelId)/documentTextExtractionSamples/
    • GET /api/v2/projects/(projectId)/documentTextExtractionSamples/
    • GET /api/v2/models/(modelId)/documentTextExtractionSampleDocuments/
    • GET /api/v2/models/(modelId)/documentTextExtractionSamplePages/
  • ドキュメントのデータ品質情報を新たなルートで取得できます。
    • GET /api/v2/projects/(projectId)/documentsDataQualityLog/
    • GET /api/v2/datasets/(datasetId)/documentsDataQualityLog/
    • GET /api/v2/datasets/(datasetId)/versions/(datasetVersionId)/documentsDataQualityLog/
  • ドキュメントのデータ品質情報をログファイルとして取得する際、新たなルートを利用できます。
    • GET /api/v2/projects/(projectId)/documentsDataQualityLog/file/
    • GET /api/v2/datasets/(datasetId)/documentsDataQualityLog/file/,
    • GET /api/v2/datasets/(datasetId)/versions/(datasetVersionId)/documentsDataQualityLog/file/
  • デプロイの予測値対実測値の時系列データを新たなルートで取得できます。
    • GET /api/v2/deployments/(deploymentId)/predictionsVsActualsOverTime/
  • 登録モデルと登録モデルバージョン(以前はモデルパッケージと呼ばれていました)を新たなルートで管理できます。
    • GET /api/v2/registeredModels/
    • GET /api/v2/registeredModels/(registeredModelId)/
    • PATCH /api/v2/registeredModels/(registeredModelId)/
    • DELETE /api/v2/registeredModels/(registeredModelId)/
    • GET /api/v2/registeredModels/(registeredModelId)/versions/
    • GET /api/v2/registeredModels/(registeredModelId)/versions/(versionId)/
    • PATCH /api/v2/registeredModels/(registeredModelId)/sharedRoles/
    • GET /api/v2/registeredModels/(registeredModelId)/sharedRoles/
    • GET /api/v2/registeredModels/(registeredModelId)/deployments/
    • GET /api/v2/registeredModels/(registeredModelId)/versions/(versionId)/deployments/
  • ユースケースに新しいルートが追加されました。
    • GET /api/v2/useCases/
    • POST /api/v2/useCases/
    • GET /api/v2/useCases/(useCaseId)/
    • PATCH /api/v2/useCases/(useCaseId)/
    • DELETE /api/v2/useCases/(useCaseId)/
    • GET /api/v2/useCases/(useCaseId)/projects/
    • GET /api/v2/useCases/(useCaseId)/applications/
    • GET /api/v2/useCases/(useCaseId)/datasets/
    • GET /api/v2/useCases/(useCaseId)/notebooks/
    • GET /api/v2/useCases/(useCaseId)/playgrounds/
    • GET /api/v2/useCases/(useCaseId)/vectorDatabases/
    • GET /api/v2/useCases/(useCaseId)/modelsForComparison/
    • GET /api/v2/useCases/(useCaseId)/filterMetadata/
    • GET /api/v2/useCases/(useCaseId)/resources/
    • GET /api/v2/useCases/(useCaseId)/sharedRoles/
    • PATCH /api/v2/useCases/(useCaseId)/sharedRoles/
    • POST /api/v2/useCases/(useCaseId)/(referenceCollectionType)/(entityId)/
    • DELETE /api/v2/useCases/(useCaseId)/(referenceCollectionType)/(entityId)/

APIの変更

  • ユースケースを管理するための以下のエンドポイントが、新しいGET /api/v2/valueTrackers/エンドポイントを優先する形で削除されました。

    • POST /api/v2/useCases/
    • GET /api/v2/useCases/
    • GET /api/v2/useCases/(useCaseId)/
    • PATCH /api/v2/useCases/(useCaseId)/
    • DELETE /api/v2/useCases/(useCaseId)/
    • GET /api/v2/useCases/(useCaseId)/activities/
    • GET /api/v2/useCases/(useCaseId)/attachments/
    • POST /api/v2/useCases/(useCaseId)/attachments/
    • DELETE /api/v2/useCases/(useCaseId)/attachments/(attachmentId)/
    • GET /api/v2/useCases/(useCaseId)/attachments/(attachmentId)/
    • GET /api/v2/useCases/(useCaseId)/realizedValueOverTime/
    • GET /api/v2/useCases/(useCaseId)/sharedRoles
    • PATCH /api/v2/useCases/(useCaseId)/sharedRoles/
  • 次のスケジュール済みジョブAPIエンドポイントが削除されました:

    • GET /api/v2/scheduledJobs/(jobId)/
    • PATCH /api/v2/scheduledJobs/(jobId)/
    • DELETE /api/v2/scheduledJobs/(jobId)/
  • AWS資格情報、Googleサービスアカウント、およびSnowflakeキーペア資格情報は、共有されたセキュアな設定を介して管理者が共有できます。 次のルートは、管理者が共有するセキュアな設定のIDとしてconfigId、パラメーターを受け入れます。

    • POST /api/v2/credentials/
    • PATCH /api/v2/credentials/(credentialId)/
  • 新しいオプションパラメーターlimitおよびoffsetGET /api/v2/projects/に追加されました。 現在のデフォルト制限は1000件です。

使用非推奨

  • was_acted_on およびtimestampPOST /api/v2/deployments/(deploymentId)/actuals/fromJSON/から使用非推奨とされ、バージョン2.34で削除されます。
  • was_acted_on_column およびtimestamp_columnPOST /api/v2/deployments/(deploymentId)/actuals/fromDataset/から使用非推奨とされ、バージョン2.34で削除されます。
  • ルートPOST/api/v2/modelPackages/<modelPackageId>/sharedRoles/は使用非推奨とされ、バージョン2.34で削除されます。代わりにPOST /api/v2/registeredModels/(registeredModelId)/sharedRoles/を使用してください。
  • ルートGET /api/v2/modelPackages/<modelPackageId>/sharedRoles/は使用非推奨とされ、バージョン2.34で削除されます。代わりにGET /api/v2/registeredModels/(registeredModelId)/sharedRoles/を使用してください。
  • ルートPOST /api/v2/modelPackages/<modelPackageId>/archive/は使用非推奨とされ、バージョン2.34で削除されます。代わりにPOST /api/v2/registeredModels/(registeredModelId)/を使用してください。

機能強化

  • 次のルートは、検出されたテキスト特徴量の言語を返すようになりました。
    • GET /api/v2/datasets/(datasetId)/allFeaturesDetails/
    • GET /api/v2/datasets/(datasetId)/versions/(datasetVersionId)/allFeaturesDetails/
    • GET /api/v2/projects/(projectId)/features/
    • GET /api/v2/projects/(projectId)/features/(featurename:featureName)/
    • GET /api/v2/projects/(projectId)/modelingFeatures/
    • GET /api/v2/projects/(projectId)/modelingFeatures/(featurename:featureName)/

更新しました February 8, 2024