OnlineEndpointOperations クラス

OnlineEndpointOperations。

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

継承

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

OnlineEndpointOperations

コンストラクター

OnlineEndpointOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_02_2022_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, local_endpoint_helper: _LocalEndpointHelper, credentials: TokenCredential | None = None, **kwargs: Dict)

パラメーター

operation_scope

operation_config

service_client_02_2022_preview

all_operations

local_endpoint_helper

credentials

既定値: None

メソッド

begin_create_or_update	エンドポイントを作成または更新します。
begin_delete	オンライン エンドポイントを削除します。
begin_regenerate_keys	エンドポイントのキーを再生成します。
get	エンドポイント リソースを取得します。
get_keys	認証資格情報を取得します。
invoke	指定されたペイロードを使用してエンドポイントを呼び出します。
list	ワークスペースのエンドポイントを一覧表示します。

begin_create_or_update

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

begin_create_or_update(endpoint: OnlineEndpoint, *, local: bool = False) -> LROPoller[OnlineEndpoint]

パラメーター

endpoint

OnlineEndpoint

必須

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

local

bool

ローカル Docker 環境でエンドポイントと対話するかどうか。 既定値は False です。

戻り値

リモートの場合は操作の状態を追跡するポーリングャー。それ以外の場合は、ローカルの場合は None を返します。

の戻り値の型 :

LROPoller[OnlineEndpoint]

例外

ValidationException

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

AssetException

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

ModelException

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

EmptyDirectoryError

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

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。

begin_delete

オンライン エンドポイントを削除します。

begin_delete(name: str | None = None, *, local: bool = False) -> LROPoller[None]

パラメーター

name

str

必須

エンドポイントの名前。

local

bool

ローカル Docker 環境でエンドポイントと対話するかどうか。 既定値は False です。

戻り値

リモートの場合は操作の状態を追跡するポーリングャー。それ以外の場合は、ローカルの場合は None を返します。

の戻り値の型 :

LROPoller[None]

例外

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。

begin_regenerate_keys

エンドポイントのキーを再生成します。

begin_regenerate_keys(name: str, *, key_type: str = 'primary') -> LROPoller[None]

パラメーター

name

<xref:<xref:The endpoint type. Defaults to ONLINE_ENDPOINT_TYPE.>>

必須

エンドポイント名。

key_type

str

"primary"、"secondary" のいずれか。 既定値は "primary" です。

戻り値

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

の戻り値の型 :

LROPoller[None]

例外

ValidationException

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

AssetException

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

ModelException

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

EmptyDirectoryError

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

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。

get

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

get(name: str, *, local: bool = False) -> OnlineEndpoint

パラメーター

name

str

必須

エンドポイントの名前。

local

Optional[bool]

ローカル Docker 環境でエンドポイントと対話するかどうかを示します。 既定値は False です。

戻り値

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

の戻り値の型 :

OnlineEndpoint

例外

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。

get_keys

認証資格情報を取得します。

get_keys(name: str) -> EndpointAuthKeys | EndpointAuthToken

パラメーター

name

str

必須

エンドポイント名

戻り値

エンドポイントの認証モードに応じて、キーまたはトークンのいずれかを返します

の戻り値の型 :

Union[EndpointAuthKeys, EndpointAuthToken]

例外

ValidationException

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

AssetException

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

ModelException

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

EmptyDirectoryError

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

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。

invoke

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

invoke(endpoint_name: str, *, request_file: str | None = None, deployment_name: str | None = None, input_data: str | Data | None = None, params_override=None, local: bool = False, **kwargs) -> str

パラメーター

endpoint_name

str

必須

エンドポイント名

request_file

Optional[str]

要求ペイロードを含むファイル。 これは、オンライン エンドポイントでのみ有効です。

deployment_name

Optional[str]

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

input_data

Optional[Union[str, Data]]

事前登録されたデータ資産を使用するには、str を形式で渡します

local

Optional[bool]

ローカル Docker 環境でエンドポイントと対話するかどうかを示します。 既定値は False です。

戻り値

オンライン エンドポイントの予測出力。

の戻り値の型 :

str

例外

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。

MultipleLocalDeploymentsFoundError

複数のデプロイがあり、deployment_nameが指定されていない場合に発生します。

InvalidLocalEndpointError

ローカル エンドポイントが None の場合に発生します。

list

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

list(*, local: bool = False) -> ItemPaged[OnlineEndpoint]

パラメーター

local

(省略可能)ローカル Docker 環境でエンドポイントと対話するかどうかを示すフラグ。 既定値はFalse

戻り値

エンドポイントの一覧

の戻り値の型 :

ItemPaged[OnlineEndpoint]

例外

ValidationException

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

AssetException

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

ModelException

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

EmptyDirectoryError

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

LocalEndpointNotFoundError

ローカル エンドポイント リソースが存在しない場合に発生します。