Python APIクライアントの変更履歴¶

DataRobotのPython APIクライアントの新バージョンで導入された変更を確認できます。

Pythonクライアントv3.3¶

新機能¶

• Python 3.11のサポートが追加されました。
• Python 3.7〜3.10との後方互換性を維持しつつ、StrEnumのサポートを追加するために、新しいライブラリ"strenum"が追加されました。Python3.11では、DataRobotはネイティブStrEnumクラスを使用しません。
• DataRobotの予測環境とやり取りするための新しいクラスPredictionEnvironmentが追加されました。
• ターゲットを設定する際に使用できる高度なオプションを拡張し、新しいパラメーターmodelGroupId、modelRegimeId、modelBaselinesを追加しました（AdvancedOptionsオブジェクトの一部）。 これらのパラメーターを使用すると、OTVプロジェクトで特徴量派生なしで時系列モデルを実行する際に必要なユーザー列を指定できます。

• トレーニングデータでの予測の説明を計算するための新しいメソッドPredictionExplanations.create_on_training_dataが追加されました。

• DataRobotの登録モデルとやり取りするための新しいクラスRegisteredModelを追加し、以下のメソッドがサポートされました。

• RegisteredModel.get RegisteredModelオブジェクトをIDで検索します。
• RegisteredModel.list 登録されているすべてのモデルを一覧表示します。
• RegisteredModel.archive 登録されているモデルを永久保存します。
• RegisteredModel.update 登録されているモデルを更新します。
• RegisteredModel.get_shared_roles で登録済みモデルのアクセス制御情報を取得します。
• RegisteredModel.share 登録されているモデルを共有します。
• RegisteredModel.get_version RegisteredModelVersionオブジェクトをIDで検索します。
• RegisteredModel.list_versions 登録されているモデルバージョンを一覧表示します。

• RegisteredModel.list_associated_deployments 登録モデルに関連付けられたデプロイを一覧表示します。

• DataRobotの登録モデルバージョン（モデルパッケージとも呼ばれます）とやり取りするための新しいクラスRegisteredModelVersionを追加し、以下のメソッドがサポートされました。

• RegisteredModelVersion.create_for_external 外部モデルから新しい登録モデルバージョンを作成します。
• RegisteredModelVersion.list_associated_deployments 登録されているモデルバージョンに関連付けられたデプロイを一覧表示します。
• RegisteredModelVersion.create_for_leaderboard_item リーダーボードモデルから新しい登録モデルバージョンを作成します。

• RegisteredModelVersion.create_for_custom_model_version カスタムモデルのバージョンから新しい登録モデルバージョンを作成します。

• 登録モデルバージョンからのデプロイの作成をサポートする新しいメソッドDeployment.create_from_registered_model_versionが追加されました。

• 現在デプロイされているモデルのモデルパッケージファイル（.mlpkg）のダウンロードをサポートする新しいメソッドDeployment.download_model_package_fileが追加されました。

• ドキュメントのサムネイルを取得できるようになりました。

• DocumentThumbnail <datarobot.models.documentai.document.DocumentThumbnail>

• DocumentPageFile <datarobot.models.documentai.document.DocumentPageFile>

• 以下を使用してドキュメントテキスト抽出サンプルを取得できるようになりました。

• DocumentTextExtractionSample
• DocumentTextExtractionSamplePage

• DocumentTextExtractionSampleDocument

• ネットワークポリシーを制御するための新しいフィールドがCustomTaskVersionに追加されました。 新しいフィールドはレスポンスにも追加されました。 これはdatarobot.enums.CustomTaskOutgoingNetworkPolicyで設定できます。

• デプロイの代わりにリーダーボードモデルを使用してバッチ予測を実行する新しいメソッドBatchPredictionJob.score_with_leaderboard_modelが追加されました。

• 設定：プロパティtypeにそれぞれIntakeSettingsとOutputSettingsにIntakeAdaptersとOutputAdapters列挙値を使用します。

• デプロイの予測値対実測値の時系列データを取得するメソッドDeployment.get_predictions_vs_actuals_over_timeが追加されました。

バグ修正¶

• ペイロードプロパティsubsetがModel.request_feature_effectでsourceに名前の変更がされました
• 環境変数またはDR設定ファイルからコンテキストtrace_contextが設定されていなかった問題が修正されました。
• Project.refresh はProject.advanced_optionsをディクショナリに設定しなくなりました。
• カテゴリーを保持またはクリアするタイミングの動作を明確にするためにDataset.modifyが修正されました。
• Python 3.11環境でenumプロパティの値の代わりにenumクラスとプロパティが印刷される結果となるf-stringsのenumの問題が修正されました。

使用非推奨のサマリー¶

• バージョン3.5がリリースされた後は、Project.refreshはディクショナリにProject.advanced_optionsとして設定されなくなりました。 Project.advanced_optionsとのすべての操作は、AdvancedOptionsクラスを介して行われる必要があります。

エクスペリメントの変更¶

• DataRobotベクターデータベースを操作するための新しいクラスVectorDatabaseが追加されました。
• VectorDatabase.get は、IDでVectorDatabaseオブジェクトを取得します。
• VectorDatabase.list は、ユーザーが使用できるすべてのVectorDatabaseを一覧表示します。
• VectorDatabase.create は新しいVectorDatabaseを作成します。
• VectorDatabase.create では、検証済みのカスタムモデルのデプロイを独自のベクターデータベースとして使用できます。
• VectorDatabase.update VectorDatabaseの名前を更新します。
• VectorDatabase.delete は単一のVectorDatabaseを削除します。
• VectorDatabase.get_supported_embeddings はサポートされているすべての埋め込みモデルを取得します。
• VectorDatabase.get_supported_text_chunkings はサポートされるすべてのテキストチャンキング設定を取得します。

• VectorDatabase.download_text_and_embeddings_asset は内部ベクターデータベースデータを含むparquetファイルをダウンロードします。

• ベクターデータベースとして使用するカスタムモデルデプロイを検証するための新しいクラスCustomModelVectorDatabaseValidationが追加されました。

• CustomModelVectorDatabaseValidation.get はCustomModelVectorDatabaseValidationオブジェクトをIDで取得します。
• CustomModelVectorDatabaseValidation.get_by_values はCustomModelVectorDatabaseValidationオブジェクトをフィールド値で取得します。
• CustomModelVectorDatabaseValidation.create はデプロイの検定を開始します。

• CustomModelVectorDatabaseValidation.revalidate はリンクされていない外部ベクターデータベースを修復します。

• DataRobotの生成AIプレイグラウンドを操作するための新しいクラスPlaygroundが追加されました。

• Playground.get はIDでプレイグラウンドオブジェクトを取得します。
• Playground.list はユーザーが使用できるすべてのプレイグラウンドを一覧表示します。
• Playground.create は新しいプレイグラウンドを作成します。
• Playground.update はプレイグラウンドの名前と説明を更新します。

• Playground.delete は単一のプレイグラウンドを削除します。

• DataRobotの生成AIプレイグラウンドを操作するための新しいクラスLLMDefinitionが追加されました。

• LLMDefinition.list はユーザーが使用できるすべてのLLMを一覧表示します。

• DataRobotの生成AI LLMブループリントを操作するための新しいクラスLLMBlueprintが追加されました。

• LLMBlueprint.get はIDでLLMブループリントオブジェクトを取得します。
• LLMBlueprint.list はユーザーが使用できるすべてのLLMブループリントを一覧表示します。
• LLMBlueprint.create は新しいLLMブループリントを作成します。
• LLMBlueprint.create_from_llm_blueprint は既存のブループリントから新しいLLMブループリントを作成します。
• LLMBlueprint.update はLLMブループリントを更新します。

• LLMBlueprint.delete は単一のLLMブループリントを削除します。

• DataRobotの生成AIチャットプロンプトを操作するための新しいクラスChatPromptが追加されました。

• ChatPrompt.get はIDでチャットプロンプトオブジェクトを取得します。
• ChatPrompt.list はユーザーが使用できるすべてのチャットプロンプトを一覧表示します。
• ChatPrompt.create は新しいチャットプロンプトを作成します。

• ChatPrompt.delete は単一のチャットプロンプトを削除します。

• カスタムモデルLLMとして使用するカスタムモデルデプロイを検証するための新しいクラスCustomModelLLMValidationが追加されました。

• CustomModelLLMValidation.get はCustomModelLLMValidationオブジェクトをIDで取得します。
• CustomModelLLMValidation.get_by_values はCustomModelLLMValidationオブジェクトをフィールド値で取得します。
• CustomModelLLMValidation.create はデプロイの検定を開始します。

• CustomModelLLMValidation.revalidate はリンクされていない外部カスタムモデルLLMを修復します。

• DataRobotの生成AI比較プロンプトを操作するための新しいクラスComparisonPromptが追加されました。

• ComparisonPrompt.get はIDで比較プロンプトオブジェクトを取得します。
• ComparisonPrompt.list はユーザーが使用できるすべての比較プロンプトを一覧表示します。
• ComparisonPrompt.create は新しい比較プロンプトを作成します。
• ComparisonPrompt.update は比較プロンプトを更新します。

• ComparisonPrompt.delete は単一の比較プロンプトを削除します。

• UseCaseが拡張され、ベクターデータベースとプレイグラウンドの数を表す2つの新しいフィールドが追加されました。

• チャットプロンプトからLLMブループリントを作成する新しい方法ChatPrompt.create_llm_blueprintが追加されました。

• カスタムモデルのLLM検定レコードを削除する新しい方法CustomModelLLMValidation.deleteが追加されました。

• 生成AI LLMブループリントからカスタムモデルを登録するための新しい方法LLMBlueprint.register_custom_modelが追加されました。