Partilhar via

OnlineEndpointOperations Classe

  • Referência

OnlineEndpointOperations.

Não deve instanciar esta classe diretamente. Em vez disso, deve criar uma instância MLClient que a instancia por si e anexe-a como um atributo.

Herança
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
OnlineEndpointOperations

Construtor

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)

Parâmetros

operation_scope
operation_config
service_client_02_2022_preview
all_operations
local_endpoint_helper
credentials
valor predefinido: None

Métodos

begin_create_or_update

Criar ou atualizar um ponto final.
begin_delete

Eliminar um Ponto Final Online.
begin_regenerate_keys

Regenerar chaves para o ponto final.
get

Obter um recurso de Ponto Final.
get_keys

Obtenha as credenciais de autenticação.
invoke

Invoca o ponto final com o payload fornecido.
list

Listar pontos finais da área de trabalho.

begin_create_or_update

Criar ou atualizar um ponto final.

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

Parâmetros

endpoint
OnlineEndpoint
Necessário

A entidade de ponto final.

local
bool

Se pretende interagir com o ponto final no ambiente local do Docker. A predefinição é Falso.

Devoluções

Um poller para controlar o estado da operação se for remoto, caso contrário, devolve Nenhum se for local.

Tipo de retorno

LROPoller[OnlineEndpoint]

Exceções

ValidationException

Gerado se o OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

AssetException

Gerado se os recursos onlineEndpoint (por exemplo, Dados, Código, Modelo, Ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.

ModelException

Gerado se o modelo OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

EmptyDirectoryError

Gerado se o caminho local fornecido apontar para um diretório vazio.

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.

begin_delete

Eliminar um Ponto Final Online.

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

Parâmetros

name
str
Necessário

Nome do ponto final.

local
bool

Se pretende interagir com o ponto final no ambiente local do Docker. A predefinição é Falso.

Devoluções

Um poller para controlar o estado da operação se for remoto, caso contrário, devolve Nenhum se for local.

Tipo de retorno

LROPoller[None]

Exceções

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.

begin_regenerate_keys

Regenerar chaves para o ponto final.

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

Parâmetros

name
<xref:<xref:The endpoint type. Defaults to ONLINE_ENDPOINT_TYPE.>>
Necessário

O nome do ponto final.

key_type
str

Um de "primário", "secundário". A predefinição é "primária".

Devoluções

Um poller para controlar o estado da operação.

Tipo de retorno

LROPoller[None]

Exceções

ValidationException

Gerado se o OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

AssetException

Gerado se os recursos onlineEndpoint (por exemplo, Dados, Código, Modelo, Ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.

ModelException

Gerado se o modelo OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

EmptyDirectoryError

Gerado se o caminho local fornecido apontar para um diretório vazio.

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.

get

Obter um recurso de Ponto Final.

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

Parâmetros

name
str
Necessário

Nome do ponto final.

local
Optional[bool]

Indica se pretende interagir com pontos finais no ambiente local do Docker. A predefinição é Falso.

Devoluções

Objeto de ponto final obtido do serviço.

Tipo de retorno

OnlineEndpoint

Exceções

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.

get_keys

Obtenha as credenciais de autenticação.

get_keys(name: str) -> EndpointAuthKeys | EndpointAuthToken

Parâmetros

name
str
Necessário

O nome do ponto final

Devoluções

Dependendo do modo de autenticação no ponto final, devolve chaves ou token

Tipo de retorno

Union[EndpointAuthKeys, EndpointAuthToken]

Exceções

ValidationException

Gerado se o OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

AssetException

Gerado se os recursos onlineEndpoint (por exemplo, Dados, Código, Modelo, Ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.

ModelException

Gerado se o modelo OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

EmptyDirectoryError

Gerado se o caminho local fornecido apontar para um diretório vazio.

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.

invoke

Invoca o ponto final com o payload fornecido.

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

Parâmetros

endpoint_name
str
Necessário

O nome do ponto final

request_file
Optional[str]

Ficheiro que contém o payload do pedido. Isto só é válido para o ponto final online.

deployment_name
Optional[str]

Nome de uma implementação específica a invocar. Isto é opcional. Por predefinição, os pedidos são encaminhados para qualquer uma das implementações de acordo com as regras de tráfego.

input_data
Optional[Union[str, Data]]

Para utilizar um recurso de dados pré-registado, transmita str no formato

local
Optional[bool]

Indica se pretende interagir com pontos finais no ambiente local do Docker. A predefinição é Falso.

Devoluções

Saída de predição para o ponto final online.

Tipo de retorno

str

Exceções

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.

MultipleLocalDeploymentsFoundError

Gerado se existirem várias implementações e não for especificado nenhum deployment_name.

InvalidLocalEndpointError

Gerado se o ponto final local for Nenhum.

list

Listar pontos finais da área de trabalho.

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

Parâmetros

local

(Opcional) Sinalizar para indicar se pretende interagir com pontos finais no ambiente local do Docker. Predefinição: Falso

Devoluções

Uma lista de pontos finais

Tipo de retorno

ItemPaged[OnlineEndpoint]

Exceções

ValidationException

Gerado se o OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

AssetException

Gerado se os recursos onlineEndpoint (por exemplo, Dados, Código, Modelo, Ambiente) não puderem ser validados com êxito. Os detalhes serão fornecidos na mensagem de erro.

ModelException

Gerado se o modelo OnlineEndpoint não puder ser validado com êxito. Os detalhes serão fornecidos na mensagem de erro.

EmptyDirectoryError

Gerado se o caminho local fornecido apontar para um diretório vazio.

LocalEndpointNotFoundError

Gerado se o recurso de ponto final local não existir.