APIのキーとツール¶
DataRobotには、予測リクエストを行うとき、またはDataRobot APIを使用するときに使用できる複数の開発者ツールが用意されています。 現在利用可能なツールは以下のとおりです。
これらの機能にアクセスするには、自分のユーザーアイコンをクリックし、APIのキーとツールに移動します。
APIキー管理¶
API keys are the preferred method for authenticating web requests to the DataRobot APIs; they replace the legacy API token method. You can simply post the API key into the request header and the application requests you as a user. すべてのDataRobot APIエンドポイントでは、APIキーが認証のモードとして使用されます。
Generating multiple API keys allows you to create a new key, update your existing integrations, and then revoke the old key, all without disruption of service of your API calls. また、複数の異なる等号に個別のキーを生成することもできます（キーAを使用するスクリプトA、キーBを使用するスクリプトBなど）。
備考
If you were previously using an API token, that token has been upgraded to an API key. 既存のすべてのインテグレーションは、DataRobot APIおよび予測APIの両方で予期した通りに機能します。
APIキー管理へのアクセス¶
You can register and manage—name, create, and delete—multiple API keys. このページにアクセスするには、自分のユーザーアイコンをクリックし、APIのキーとツールのページに移動します。
The Personal API keys tab lists your API keys with a variety of options available:
| 要素 | 説明 | |
|---|---|---|
| 1 | APIエンドポイント | Copy the API endpoint to your clipboard (contents blurred out in this image) to paste elsewhere. |
| 2 | ドキュメントを開く | Access multiple code-first resources, such as REST API documentation, Python client documentation, or AI accelerators. |
| 3 | キーの種類 | Toggle between tabs for the three kinds of API keys: API keys for personal use of the API, application API keys for use with custom applications, and agent API keys for use with agentic workflows. |
| 4 | 検索 | 名前または作成日でAPIのリストを検索します。 |
| 5 | + Create new key | Create a new personal API key. |
| 6 | コピー | Copy a key to your clipboard (contents blurred out in this image) to paste elsewhere. |
| 7 | アクションメニュー | アクションメニューを展開して、APIキーの名前を変更または削除します。 |
個人APIキー¶
Each personal API key on the Personal API keys tab lists the key name, status, value, creation date, and when it was last used. To create a personal API key, from the Personal API keys tab on the API keys and tools page, click + Create new key. Then enter an API key name and click Create. This activates the new key, making it ready for use.
アプリケーションのAPIキー¶
An application API key grants an application the necessary access to the DataRobot Public API, allowing you to grant users the ability to access and use data from within an application. A new key is automatically created each time you build a custom application. While sharing roles grant control over the application as an entity within DataRobot, application API keys grant control over the requests the app can make when a user accesses it. See configuring application API keys for custom applications for more information.
Application API keys are listed in the Application API keys tab of the API keys and tools page.
| フィールド | 説明 |
|---|---|
| 名前 | The name of the key. |
| キー | APIキーの値。 |
| 役割 | The scope of access the application has to the public API granted by the key. |
| 接続されたアプリケーション | The name of the custom application that the key belongs to. リンクをクリックすると、アプリケーションにアクセスできます。 |
| 作成日 | キーが作成された日付。 |
| 最後の使用 | The time elapsed since the last use of the key. |
| 有効期限 | The time remaining until the key expires. |
使用可能なエンドポイント
アプリケーションには、パブリックAPIへの完全なアクセス権が付与されていません。キーは、アプリケーションが使用するために、限られた数のAPIエンドポイントへのアクセスを許可します。 以下のリストは、アプリケーションがアクセスできるすべてのエンドポイント（およびその子エンドポイント、たとえば/api/v2/projects/<project_id>/）を示しています。
- /api/v2/account/info/
- /api/v2/account/validateApiKey/
- /api/v2/applications/
- /api/v2/automatedDocumentOptions/
- /api/v2/automatedDocuments/
- /api/v2/batchJobs/
- /api/v2/batchMonitoring/
- /api/v2/batchMonitoringJobDefinitions/
- /api/v2/batchPredictionJobDefinitions/
- /api/v2/batchPredictions/
- /api/v2/calendarCountryCodes/
- /api/v2/calendars/
- /api/v2/catalogItems/
- /api/v2/changeRequests/
- /api/v2/comments/
- /api/v2/credentials/
/associations/ / - /api/v2/credentials/associations/
/ - /api/v2/customApplicationSources/
- /api/v2/customJobLimits/
- /api/v2/customJobs/
- /api/v2/customModelDeployments/
- /api/v2/customModelLimits/
- /api/v2/customModelTests/
- /api/v2/customTasks/
- /api/v2/customTrainingBlueprints/
- /api/v2/dataEngineQueryGenerators/
- /api/v2/dataEngineWorkspaceStates/
- /api/v2/datasets/
- /api/v2/dataSlices/
- /api/v2/deployments/
- /api/v2/executionEnvironments/
- /api/v2/externalDataSources/
- /api/v2/externalDataStores/
- /api/v2/files/
- /api/v2/genai/llmgw/
- /api/v2/guardConfigurations/
- /api/v2/guardTemplates/
- /api/v2/imageAugmentationLists/
- /api/v2/imageAugmentationOptions/
- /api/v2/insights/
- /api/v2/keyValues/
- /api/v2/modelComplianceDocsInitializations/
- /api/v2/modelPackages/
- /api/v2/models/
- /api/v2/moderationSupportedLlms/
- /api/v2/multilabelInsights/
- /api/v2/ocrJobResources/
- /api/v2/overallModerationConfiguration/
- /api/v2/predictionServers/
- /api/v2/projectClones/
- /api/v2/projects/
- /api/v2/recipes/
- /api/v2/registeredModels/
- /api/v2/relationshipsConfigurations/
- /api/v2/remoteEvents/
- /api/v2/remoteRepositories/
- /api/v2/scheduledJobs/
- /api/v2/status/
- /api/v2/stringEncryptions/
- /api/v2/useCases/
- /api/v2/useCasesWithShortenedInfo/
- /api/v2/userBlueprints/
- /api/v2/userBlueprintsBulkValidations/
- /api/v2/userBlueprintsInputTypes/
- /api/v2/userBlueprintsProjectBlueprints/
- /api/v2/userBlueprintsTaskParameters/
- /api/v2/userBlueprintsTasks/
- /api/v2/userBlueprintsValidations/
- /api/v2/version/
エージェントのAPIキー¶
To differentiate between various applications and agents using a deployment, agent API keys are generated automatically when a new Agentic workflow deployment is created. Agent API keys are listed in the Agent API keys tab of the API keys and tools page, and can be edited (renamed) or deleted.
| フィールド | 説明 |
|---|---|
| 名前 | The name of the key. |
| キー | The value of the key. |
| 接続されたデプロイ | The name of the deployment that the key belongs to. Click the link to access the deployment. |
| 作成日 | キーが作成された日付。 |
| 最後の使用 | The time elapsed since the last use of the key. |
既存のキーの削除¶
既存のキーを削除するには、削除したいキーのアクションメニューを展開し、削除をクリックします。 削除による影響に関する注意を示すダイアログボックスが表示されます。 もう一度削除をクリックして、キーを削除します。
監視エージェントのtarball¶
監視エージェントは、DataRobotの外部の外部モデルのモニタリングおよび統計のレポートを行うソリューションとして利用できます。 この種のデプロイをモニタするには、最初にDataRobotが提供する次のソフトウェアコンポーネントを実装する必要があります。
- MLOpsライブラリ（Python、Java、Rで利用可能）
- 監視エージェント
これらのコンポーネントは、DataRobotアプリケーションでtarballとして使用できるインストーラーパッケージの一部です。
監視エージェントのtarballをダウンロード¶
監視エージェントの tarball は、APIのキーとツール セクション、およびデプロイの予測 > モニタリングタブの2つの場所からアクセスできます。
自分のユーザーアイコンをクリックし、APIのキーとツールに移動します。 管理および監視エージェントのヘッダーの下で、ダウンロードアイコンをクリックします。 エージェントをセットアップするための追加ドキュメントは、tarballに含まれています。
備考
You can also download the DataRobot Python libraries from the public Python Package Index site. Download and install the DataRobot metrics reporting library and the DataRobot Connected Client. これらのページには、ライブラリをインストールするための指示が含まれています。
ポータブル予測サーバーのDockerイメージ¶
本機能の提供について
一部のインストールでは、ポータブル予測サーバーのイメージを使用できない場合があります。 詳細については、可用性に関するガイドラインを参照してください。
APIのキーとツールからポータブル予測サーバーのDockerイメージをダウンロードします。
イメージに関するいくつかの重要な情報を確認できます。
| 要素 | 説明 | |
|---|---|---|
| 1 | イメージ名 | ダウンロードするイメージアーカイブファイルの名前。 |
| 2 | イメージの作成日 | イメージが作成された日付。 |
| 3 | ファイルサイズ | ダウンロードする圧縮画像のサイズ。 圧縮されていないイメージのサイズは12GBを超える場合があります。 |
| 4 | Docker Image ID |
docker imagesコマンドによって表示されるように、DockerImage IDの短縮バージョン。 これはコンテンツベースであるため、イメージタグに関係なく、この値は同じままです。 これを使用して、現在実行しているイメージとバージョンを比較します。 |
| 5 | ハッシュ | ハッシュアルゴリズムとコンテンツハッシュの合計。 ダウンロード後にファイルの整合性をチェックするために使用します（以下の例を参照）。 現在、SHA256はハッシュアルゴリズムとして使用されます。 |
ダウンロードアイコンをクリックして、ファイルがダウンロードされるのを待ちます。 イメージのサイズにより、ネットワーク速度によってはダウンロードに数分（または数時間）かかる場合があります。 ダウンロードが完了したら、ハッシュ合計を使用してファイルの整合性を確認します。 Linuxの場合を例に説明します。
sha256sum datarobot-portable-prediction-api-7.0.0-r1736.tar.gz
5bafef491c3575180894855164b08efaffdec845491678131a45f1646db5a99d datarobot-portable-prediction-api-7.0.0-r1736.tar.gz
チェックサムがイメージ情報に表示されている値（上記のハッシュ値（5））と一致する場合、画像は正常にダウンロードされ、安全にDockerにロードできます。