OnlineEndpointOperations Classe

  • Referência

OnlineEndpointOperations.

Você não deve instanciar essa classe diretamente. Em vez disso, você deve criar uma instância do MLClient que a instancie para você e a anexa 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 padrão: None

Métodos

begin_create_or_update

Criar ou atualizar um ponto de extremidade.
begin_delete

Excluir um ponto de extremidade online.
begin_regenerate_keys

Regenerar chaves para o ponto de extremidade.
get

Obter um recurso de ponto de extremidade.
get_keys

Obtenha as credenciais de autenticação.
invoke

Invoca o ponto de extremidade com o conteúdo fornecido.
list

Listar pontos de extremidade do workspace.

begin_create_or_update

Criar ou atualizar um ponto de extremidade.

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

Parâmetros

endpoint
OnlineEndpoint
Obrigatório

A entidade do ponto de extremidade.

local
bool

Se deve interagir com o ponto de extremidade no ambiente local do Docker. Usa False como padrão.

Retornos

Um sondador para acompanhar a operação status se remota, caso contrário, retornará Nenhum se local.

Tipo de retorno

LROPoller[OnlineEndpoint]

Exceções

ValidationException

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

AssetException

Gerado se os ativos 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 de extremidade local não existir.

begin_delete

Excluir um ponto de extremidade online.

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

Parâmetros

name
str
Obrigatório

Nome do ponto de extremidade.

local
bool

Se deve interagir com o ponto de extremidade no ambiente local do Docker. Usa False como padrão.

Retornos

Um sondador para acompanhar a operação status se remota, caso contrário, retornará Nenhum se local.

Tipo de retorno

LROPoller[None]

Exceções

LocalEndpointNotFoundError

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

begin_regenerate_keys

Regenerar chaves para o ponto de extremidade.

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

Parâmetros

name
<xref:<xref:The endpoint type. Defaults to ONLINE_ENDPOINT_TYPE.>>
Obrigatório

O nome do ponto de extremidade.

key_type
str

Um de "primário", "secundário". O padrão é "primário".

Retornos

Um sondador para acompanhar a operação status.

Tipo de retorno

LROPoller[None]

Exceções

ValidationException

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

AssetException

Gerado se os ativos 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 de extremidade local não existir.

get

Obter um recurso de ponto de extremidade.

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

Parâmetros

name
str
Obrigatório

Nome do ponto de extremidade.

local
Optional[bool]

Indica se deve interagir com pontos de extremidade no ambiente local do Docker. Usa False como padrão.

Retornos

Objeto de ponto de extremidade recuperado do serviço.

Tipo de retorno

OnlineEndpoint

Exceções

LocalEndpointNotFoundError

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

get_keys

Obtenha as credenciais de autenticação.

get_keys(name: str) -> EndpointAuthKeys | EndpointAuthToken

Parâmetros

name
str
Obrigatório

O nome do ponto de extremidade

Retornos

Dependendo do modo de autenticação no ponto de extremidade, retorna chaves ou token

Tipo de retorno

Union[EndpointAuthKeys, EndpointAuthToken]

Exceções

ValidationException

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

AssetException

Gerado se os ativos 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 de extremidade local não existir.

invoke

Invoca o ponto de extremidade com o conteúdo 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
Obrigatório

O nome do ponto de extremidade

request_file
Optional[str]

Arquivo que contém o conteúdo da solicitação. Isso só é válido para o ponto de extremidade online.

deployment_name
Optional[str]

Nome de uma implantação específica a ser invocada. Isso é opcional. Por padrão, as solicitações são roteadas para qualquer uma das implantações de acordo com as regras de tráfego.

input_data
Optional[Union[str, Data]]

Para usar um ativo de dados pré-registrado, passe str no formato

local
Optional[bool]

Indica se deve interagir com pontos de extremidade no ambiente local do Docker. Usa False como padrão.

Retornos

Saída de previsão para o ponto de extremidade online.

Tipo de retorno

str

Exceções

LocalEndpointNotFoundError

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

MultipleLocalDeploymentsFoundError

Gerado se houver várias implantações e nenhuma deployment_name for especificada.

InvalidLocalEndpointError

Gerado se o ponto de extremidade local for Nenhum.

list

Listar pontos de extremidade do workspace.

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

Parâmetros

local

(Opcional) Sinalizador para indicar se deve interagir com pontos de extremidade no ambiente local do Docker. Padrão: False

Retornos

Uma lista de pontos de extremidade

Tipo de retorno

ItemPaged[OnlineEndpoint]

Exceções

ValidationException

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

AssetException

Gerado se os ativos 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 de extremidade local não existir.