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 資產 (例如無法成功驗證 Data、Code、Model、Environment) ，則引發。 錯誤訊息中將會提供詳細資料。

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」。

傳回

用來追蹤作業狀態的輪詢器。

傳回類型

LROPoller[None]

例外狀況

ValidationException

如果無法成功驗證 OnlineEndpoint，則引發 。 錯誤訊息中將會提供詳細資料。

AssetException

如果 OnlineEndpoint 資產 (例如無法成功驗證 Data、Code、Model、Environment) ，則引發。 錯誤訊息中將會提供詳細資料。

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 資產 (例如無法成功驗證 Data、Code、Model、Environment) ，則引發。 錯誤訊息中將會提供詳細資料。

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 資產 (例如無法成功驗證 Data、Code、Model、Environment) ，則引發。 錯誤訊息中將會提供詳細資料。

ModelException

如果無法成功驗證 OnlineEndpoint 模型，則引發 。 錯誤訊息中將會提供詳細資料。

EmptyDirectoryError

如果提供的本機路徑指向空的目錄，則引發 。

LocalEndpointNotFoundError

如果本機端點資源不存在，則引發。