Pythonクライアントの変更履歴¶
変更履歴には、 DataRobotのPython APIクライアントの各バージョンのリリースにおける、注目すべき変更点の整理され順序付けられたリストが含まれています。 DataRobotの最新バージョンでの変更点については、以下の変更履歴を参照してください。 また、目次で以前のバージョンを確認することもできます。
Python APIクライアントv3.7の変更履歴¶
新機能¶
- DataRobot PythonクライアントがPython 3.12およびPython 3.13をサポートするようになりました。
- 再トレーニング設定を取得するための
Deployment.get_retraining_settingsが追加されました。 - 再トレーニング設定を更新するための
Deployment.update_retraining_settingsが追加されました。 - サーバーが104接続リセットエラーを返したときにリクエストを再試行するように
RESTClientObjectが更新されました。 - バッチ予測の入出力タイプとして
datasphereのサポートが追加されました。 - 精度指標設定を取得するための
Deployment.get_accuracy_metrics_settingsが追加されました。 - 精度指標設定を更新するための
Deployment.update_accuracy_metrics_settingsが追加されました。 - 位置ごとのカスタム指標値を取得するための
CustomMetricValuesOverSpaceが追加されました。 - 位置ごとのカスタム指標値を取得するための
CustomMetric.get_values_over_spaceが追加されました。 - コンプライアンスドキュメントのカスタムテンプレートでサポートされるプロジェクトタイプを定義する列挙型変数
ComplianceDocTemplateProjectTypeが作成されました。 - テンプレートでサポートされているプロジェクトタイプを識別するために、属性
project_typeがComplianceDocTemplateに追加されました。 - プロジェクトタイプのデフォルトテンプレートを取得するためのオプションパラメーター
project_typeがComplianceDocTemplate.get_defaultに追加されました。 - 作成するテンプレートがサポートするプロジェクトタイプを指定するためのオプションパラメーター
project_typeがComplianceDocTemplate.createに追加されました。 - 作成するテンプレートがサポートするプロジェクトタイプを指定するためのオプションパラメーター
project_typeがComplianceDocTemplate.create_from_json_fileに追加されました。 - 既存のテンプレートのプロジェクトタイプを更新できるように、オプションパラメーター
project_typeがComplianceDocTemplate.updateに追加されました。 - テンプレートのプロジェクトタイプでフィルターと検索ができるように、オプションパラメーター
project_typeがComplianceDocTemplate.listに追加されました。 - SHAPマトリックスの結果をCSVファイルとして取得するための
ShapMatrix.get_as_csvが追加されました。 - SHAPマトリックスの結果をDataFrameとして取得するための
ShapMatrix.get_as_dataframeが追加されました。 - リフトチャートのインサイトを扱うための新しいクラス
LiftChartが追加されました。 - ROC曲線のインサイトを扱うための新しいクラス
RocCurveが追加されました。 - 残差のインサイトを扱うための新しいクラス
Residualsが追加されました。 - レシピを使って特徴量探索プロジェクトを作成するための
Project.create_from_recipeが追加されました。 - ラングリングレシピを作成するために、オプションパラメーター
recipe_typeがdatarobot.models.Recipe.from_datasetに追加されました。 - ラングリングレシピを作成するためのオプションパラメーター
recipe_typeがdatarobot.models.Recipe.from_data_storeに追加されました。 - レシピのメタデータを更新するための
Recipe.set_recipe_metadataが追加されました。 - 使用するスナップショットポリシーを指定するためのオプションパラメーター
snapshot_policyがdatarobot.models.Recipe.from_datasetに追加されました。 - 使用するスナップショットポリシーを指定するための新しい属性
snapshot_policyがdatarobot.models.RecipeDatasetInputに追加されました。 - 使用するデータセットIDを正確に指定するための新しい属性
dataset_idがdatarobot.models.JDBCTableDataSourceInputに追加されました。 - 新しい属性
prediction_point、relationships_configuration_id、およびfeature_discovery_supervised_feature_reductionがRecipeSettingsに追加されました。 list、create、updateの各メソッドで、複数のオプションパラメーターがExecutionEnvironmentに追加されました。- オプションパラメーター
metadata_filterがComparisonPrompt.createに追加されました。 - カスタムモデルでアクセス制御設定を更新するための
CustomInferenceModel.shareが追加されました。 - カスタムモデルでアクセス制御設定を取得するための
CustomInferenceModel.get_access_listが追加されました。 - 新しい属性
latest_successful_versionがExecutionEnvironmentに追加されました。 - プロジェクトのデータからデータセットを作成するための
Dataset.create_from_projectが追加されました。 - 実行環境のアクセス制御設定を更新するための
ExecutionEnvironment.shareが追加されました。 - 実行環境のアクセス制御設定を取得するための
ExecutionEnvironment.get_access_listが追加されました。 - LLMのモデレーションテンプレートを操作するための
ModerationTemplateを作成しました。 - LLMのモデレーション設定を操作するための
ModerationConfigurationを作成しました。 - カスタムテンプレートの要素を操作するための
CustomTemplateを作成しました。 - ターゲットの設定時に使用できる高度なオプションが拡張され、パラメーター
feature_engineering_prediction_point（AdvancedOptionsオブジェクトの一部）が含まれるようになりました。 listおよびgetメソッドで、オプションパラメーターsubstitute_url_parametersがDataStoreに追加されました。- 増分学習モデルを初期化し、チャンキングサービスを使用してトレーニングを開始するための
Model.start_incremental_learning_from_sampleが追加されました。 「データセットサンプルからのプロジェクト作成」機能フラグが必要です。 CustomModelVectorDatabaseValidationとCustomModelEmbeddingValidationの基本クラスとしてNonChatAwareCustomModelValidationが追加されました。 それに対して、CustomModelLLMValidationは、チャット補完APIをサポートするデプロイを操作するために、createメソッドとupdateメソッドを別々に実装するようになりました。- チャット補完APIをサポートするデプロイ済みLLMを追加できるように、オプションパラメーター
chat_model_idがCustomModelLLMValidation.createとCustomModelLLMValidation.updateに追加されました。 ComparisonPromptがエラーが発生した比較プロンプトの結果をロードできない問題を修正しました。- オプションパラメーター
retirement_date、is_deprecated、およびis_activeがLLMDefinitionに追加されました。また、LLMの使用非推奨とサポート終了に関連した情報を公開するために、オプションのパラメーターllm_is_deprecatedがMetricMetadataに追加されました。
機能強化¶
Deployment.update_shared_rolesのエイリアスとしてDeployment.shareが追加されました。use_tcp_keepaliveパラメーターがClientに追加され、接続がタイムアウトしたときにTCPキープアライブパケットが有効になりました（デフォルトで有効）。- READリクエストのタイムアウトを設定するには、
CustomModelVersion.clean_createの既存の入力引数max_waitを内部的に使用します。
バグ修正¶
PredictionEnvironmentでmanagement_metaにuser_idフィールドやusernameフィールドがないAPIレスポンスに対応するため、これらのフィールドをオプションにしました。ComplianceDocTemplateTypeの列挙値を修正しました。WranglingOperationsの列挙値を修正しました。DataWranglingDialectの列挙値を修正しました。EvaluationDatasetConfiguration.listのPlayground IDパラメーターは、オプションではなくなりました。MetricInsights.copy_to_playgroundでインサイトコピーのパスが修正されました。prompt_typeとwarningに不足していたフィールドが、PromptTrace <datarobot.models.genai.prompt_trace.PromptTrace>に追加されました。SidecarModelMetricValidation.listでクエリーパラメーター名を修正しました。- 属性
VectorDatabase:metadata_columnsのタイプミスを修正しました。metada_columnsになっていました。 ChatPrompt.createのmetadata_filterdictをキャメルケースにしないでください。CustomModelLLMValidation.list、CustomModelEmbeddingValidation.list、およびCustomModelVectorDatabaseValidation.listでユースケースのクエリーパラメーター名を修正しました。RelationshipsConfiguration.createおよびRelationshipsConfiguration.replaceのfeatureDiscoverySettingsパラメーター名を修正しました。
APIの変更¶
- メソッド
CustomModelLLMValidation.createではprompt_column_nameおよびtarget_column_nameパラメーターが不要になり、オプションのchat_model_idパラメーターを受け付けるようになりました。 パラメーターの順序が変更されました。 カスタムモデルのLLMデプロイがチャット補完APIをサポートしている場合、列名を指定する代わりに（または列名を指定することに加えて）chat_model_idを使用することを推奨します。
使用非推奨のサマリー¶
Deploymentの使用非推奨のcapabilities属性が削除されました。- メソッド
Model.request_lift_chartは使用非推奨となり、LiftChart.computeに置き換えられる予定です。 - メソッド
Model.get_lift_chartは使用非推奨となり、LiftChart.getに置き換えられる予定です。 - メソッド
Model.get_all_lift_chartsは使用非推奨となり、LiftChart.listに置き換えられる予定です。 - メソッド
Model.request_roc_curveは使用非推奨となり、RocCurve.computeに置き換えられる予定です。 - メソッド
Model.get_roc_curveは使用非推奨となり、RocCurve.getに置き換えられる予定です。 - メソッド
Model.get_all_roc_curvesは使用非推奨となり、RocCurve.listに置き換えられる予定です。 - メソッド
Model.request_residuals_chartは使用非推奨となり、Residuals.computeに置き換えられる予定です。 - メソッド
Model.get_residuals_chartは使用非推奨となり、Residuals.getに置き換えられる予定です。 - メソッド
Model.get_all_residuals_chartsは使用非推奨となり、Residuals.listに置き換えられる予定です。
ドキュメントの変更¶
- 依存関係
numpydocが削除されました。 ドキュメント文字列の解析は、3.6.0からsphinx.ext.napoleonで処理されています。 - ReadTheDocsでの目次のレンダリング方法に関する問題を修正しました。
sphinx-external-tocはdev依存になりました。 - ReadTheDocsサイト全体の形式設定に関する軽微な問題を修正しました。
- 異常評価オブジェクトに関するドキュメントを更新し、重複する情報を削除しました。
エクスペリメントの変更¶
use_caseおよびdeployment_idプロパティがRetrainingPolicyクラスに追加されました。createおよびupdate_use_caseメソッドがRetrainingPolicyクラスに追加されました。- メソッドの名前が
train_first_incremental_from_sampleからstart_incremental_learning_from_sampleに変更になりました。 新しいパラメーターearly_stopping_roundsおよびfirst_iteration_onlyが追加されました。 ChunkDefinitionにおいて、credentials_idパラメーターがcreateメソッドに追加されました。NotebookScheduledJobクラスのnext_run_timeプロパティのバグを修正し、NULL値が許容されるようになりました。highlight_whitespaceプロパティがNotebookSettingsに追加されました。- クライアントのエクスペリメント部分にノートブック専用の新しいディレクトリを作成しました。
- セッションを操作するためのメソッドが
Notebookクラスに追加されました：start_session()、stop_session()、get_session_status()、is_running()。 - 実行および関連する実行ステータスのチェックのために、次のメソッドが
Notebookに追加されました：execute()、get_execution_status()、is_finished_executing()。 - リビジョンを作成するために、
Notebook.create_revisionがNotebookクラスにを追加されました。 ModerationTemplateクラスをModerationTemplateに移動しました。- LLMのモデレーション設定を操作するために、
ModerationConfigurationクラスをModerationConfigurationに移動しました。 - Notebookクラスの
Notebook.runメソッドを更新して、適切な使用を促し、注釈としてよりわかりやすいTypedDictを追加しました。 - 手動実行を処理する際に、より慣用的なコードをサポートするために、
NotebookScheduledJob.get_most_recent_runがNotebookScheduledJobクラスに追加されました。 - Notebookクラスで
Notebook.runメソッドを更新しました。それにより、Codespaceでのノートブックの実行だけでなく、関連する複数の新しいクラスとメソッドがサポートされ、基礎となる実行に必要なAPIカバレッジが拡大しました。 ExecutionEnvironment.assign_environmentがExecutionEnvironmentクラスにが追加され、ノートブックの環境を割り当てたり更新したりできるようになりました。- 使用非推奨の実験的メソッド
Model.get_incremental_learning_metadataが削除されました。 - 使用非推奨の実験的メソッド
Model.start_incremental_learningが削除されました。