你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

返回

用于跟踪操作状态的轮询程序。

返回类型

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

如果本地终结点资源不存在，则引发。