BatchEndpointOperations クラス

  • リファレンス

BatchEndpointOperations。

このクラスを直接インスタンス化しないでください。 代わりに、それをインスタンス化して属性としてアタッチする MLClient インスタンスを作成する必要があります。

継承
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
BatchEndpointOperations

コンストラクター

BatchEndpointOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_05_2022: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, credentials: TokenCredential | None = None, **kwargs: Dict)

パラメーター

operation_scope
<xref:azure.ai.ml._scope_dependent_operations.OperationScope>
必須

MLClient オブジェクトの操作クラスのスコープ変数。

operation_config
<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
必須

MLClient オブジェクトの操作クラスの一般的な構成。

service_client_05_2022
<xref:<xref:azure.ai.ml._restclient.v2022_05_01._azure_machine_learning_workspaces. AzureMachineLearningWorkspaces>>
必須

エンド ユーザーが Azure Machine Learning ワークスペース リソースを操作できるようにするサービス クライアント。

all_operations
<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
必須

MLClient オブジェクトのすべての操作クラス。

credentials
TokenCredential
既定値: None

認証に使用する資格情報。

メソッド

begin_create_or_update

バッチ エンドポイントを作成または更新します。
begin_delete

バッチ エンドポイントを削除します。
get

エンドポイント リソースを取得します。
invoke

指定されたペイロードを使用してバッチ エンドポイントを呼び出します。
list

ワークスペースのエンドポイントを一覧表示します。
list_jobs

指定されたバッチ エンドポイントのデプロイでジョブを一覧表示します。 これはバッチ エンドポイントでのみ有効です。

begin_create_or_update

バッチ エンドポイントを作成または更新します。

begin_create_or_update(endpoint: BatchEndpoint) -> LROPoller[BatchEndpoint]

パラメーター

endpoint
BatchEndpoint
必須

エンドポイント エンティティ。

戻り値

操作の状態を追跡するポーリングャー。

の戻り値の型 :

LROPoller[BatchEndpoint]

例

エンドポイントの作成の例。


   from azure.ai.ml.entities import BatchEndpoint

   endpoint_example = BatchEndpoint(name=endpoint_name_2)
   ml_client.batch_endpoints.begin_create_or_update(endpoint_example)

begin_delete

バッチ エンドポイントを削除します。

begin_delete(name: str) -> LROPoller[None]

パラメーター

name
str
必須

バッチ エンドポイントの名前。

戻り値

操作の状態を追跡するポーリングャー。

の戻り値の型 :

LROPoller[None]

例

エンドポイントの削除の例。


   ml_client.batch_endpoints.begin_delete(endpoint_name)

get

エンドポイント リソースを取得します。

get(name: str) -> BatchEndpoint

パラメーター

name
str
必須

エンドポイントの名前。

戻り値

サービスから取得されたエンドポイント オブジェクト。

の戻り値の型 :

BatchEndpoint

例

エンドポイントの取得の例。


   ml_client.batch_endpoints.get(endpoint_name)

invoke

指定されたペイロードを使用してバッチ エンドポイントを呼び出します。

invoke(endpoint_name: str, *, deployment_name: str | None = None, inputs: Dict[str, Input] | None = None, **kwargs) -> BatchJob

パラメーター

endpoint_name
str
必須

エンドポイント名。

deployment_name
str

(省略可能)呼び出す特定のデプロイの名前。 これは省略可能です。 既定では、要求はトラフィック ルールに従っていずれかのデプロイにルーティングされます。

inputs
Dict[str, Input]

(省略可能)デプロイで使用する既存のデータ資産、パブリック URI ファイル、またはフォルダーのディクショナリ

戻り値

呼び出されたバッチ デプロイ ジョブ。

の戻り値の型 :

BatchJob

例外

ValidationException

デプロイを正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。

AssetException

BatchEndpoint アセット (データ、コード、モデル、環境など) が正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。

ModelException

BatchEndpoint モデルを正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。

EmptyDirectoryError

指定されたローカル パスが空のディレクトリを指している場合に発生します。

例

エンドポイントの呼び出しの例。


   ml_client.batch_endpoints.invoke(endpoint_name_2)

list

ワークスペースのエンドポイントを一覧表示します。

list() -> ItemPaged[BatchEndpoint]

戻り値

エンドポイントの一覧

の戻り値の型 :

ItemPaged[BatchEndpoint]

例

リストの例。


   ml_client.batch_endpoints.list()

list_jobs

指定されたバッチ エンドポイントのデプロイでジョブを一覧表示します。 これはバッチ エンドポイントでのみ有効です。

list_jobs(endpoint_name: str) -> ItemPaged[BatchJob]

パラメーター

endpoint_name
str
必須

エンドポイント名

戻り値

ジョブの一覧

の戻り値の型 :

ItemPaged[BatchJob]

例

ジョブの一覧表示の例。


   ml_client.batch_endpoints.list_jobs(endpoint_name_2)