Condividi tramite

OnlineEndpointOperations Classe

  • Riferimento

OnlineEndpointOperations.

Non è consigliabile creare direttamente un'istanza di questa classe. È invece necessario creare un'istanza di MLClient che lo crea e lo associa come attributo.

Ereditarietà
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
OnlineEndpointOperations

Costruttore

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)

Parametri

operation_scope
operation_config
service_client_02_2022_preview
all_operations
local_endpoint_helper
credentials
valore predefinito: None

Metodi

begin_create_or_update

Creare o aggiornare un endpoint.
begin_delete

Eliminare un endpoint online.
begin_regenerate_keys

Rigenerare le chiavi per l'endpoint.
get

Ottenere una risorsa endpoint.
get_keys

Ottenere le credenziali di autenticazione.
invoke

Richiama l'endpoint con il payload specificato.
list

Elencare gli endpoint dell'area di lavoro.

begin_create_or_update

Creare o aggiornare un endpoint.

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

Parametri

endpoint
OnlineEndpoint
Necessario

Entità endpoint.

local
bool

Se interagire con l'endpoint nell'ambiente Docker locale. Il valore predefinito è False.

Restituisce

Un poller per tenere traccia dello stato dell'operazione se remoto, altrimenti restituisce Nessuno se locale.

Tipo restituito

LROPoller[OnlineEndpoint]

Eccezioni

ValidationException

Generato se OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

AssetException

Generato se gli asset onlineEndpoint (ad esempio Dati, Codice, Modello, Ambiente) non possono essere convalidati correttamente. I dettagli verranno forniti nel messaggio di errore.

ModelException

Generato se il modello OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

EmptyDirectoryError

Generato se il percorso locale ha fornito punti a una directory vuota.

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.

begin_delete

Eliminare un endpoint online.

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

Parametri

name
str
Necessario

Nome dell'endpoint.

local
bool

Se interagire con l'endpoint nell'ambiente Docker locale. Il valore predefinito è False.

Restituisce

Un poller per tenere traccia dello stato dell'operazione se remoto, altrimenti restituisce Nessuno se locale.

Tipo restituito

LROPoller[None]

Eccezioni

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.

begin_regenerate_keys

Rigenerare le chiavi per l'endpoint.

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

Parametri

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

Nome dell'endpoint.

key_type
str

Uno di "primario", "secondario". Le impostazioni predefinite sono "primarie".

Restituisce

Un poller per tenere traccia dello stato dell'operazione.

Tipo restituito

LROPoller[None]

Eccezioni

ValidationException

Generato se OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

AssetException

Generato se gli asset onlineEndpoint (ad esempio Dati, Codice, Modello, Ambiente) non possono essere convalidati correttamente. I dettagli verranno forniti nel messaggio di errore.

ModelException

Generato se il modello OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

EmptyDirectoryError

Generato se il percorso locale ha fornito punti a una directory vuota.

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.

get

Ottenere una risorsa endpoint.

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

Parametri

name
str
Necessario

Nome dell'endpoint.

local
Optional[bool]

Indica se interagire con gli endpoint nell'ambiente Docker locale. Il valore predefinito è False.

Restituisce

Oggetto endpoint recuperato dal servizio.

Tipo restituito

OnlineEndpoint

Eccezioni

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.

get_keys

Ottenere le credenziali di autenticazione.

get_keys(name: str) -> EndpointAuthKeys | EndpointAuthToken

Parametri

name
str
Necessario

Nome dell'endpoint

Restituisce

A seconda della modalità di autenticazione nell'endpoint, restituisce chiavi o token

Tipo restituito

Union[EndpointAuthKeys, EndpointAuthToken]

Eccezioni

ValidationException

Generato se OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

AssetException

Generato se gli asset onlineEndpoint (ad esempio Dati, Codice, Modello, Ambiente) non possono essere convalidati correttamente. I dettagli verranno forniti nel messaggio di errore.

ModelException

Generato se il modello OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

EmptyDirectoryError

Generato se il percorso locale ha fornito punti a una directory vuota.

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.

invoke

Richiama l'endpoint con il payload specificato.

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

Parametri

endpoint_name
str
Necessario

Nome dell'endpoint

request_file
Optional[str]

File contenente il payload della richiesta. Questa operazione è valida solo per l'endpoint online.

deployment_name
Optional[str]

Nome di una distribuzione specifica da richiamare. Operazione facoltativa. Per impostazione predefinita, le richieste vengono indirizzate a una delle distribuzioni in base alle regole del traffico.

input_data
Optional[Union[str, Data]]

Per usare un asset di dati preregistrato, passare str in formato

local
Optional[bool]

Indica se interagire con gli endpoint nell'ambiente Docker locale. Il valore predefinito è False.

Restituisce

Output di stima per l'endpoint online.

Tipo restituito

str

Eccezioni

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.

MultipleLocalDeploymentsFoundError

Generato se sono presenti più distribuzioni e non viene specificato alcun deployment_name.

InvalidLocalEndpointError

Generato se l'endpoint locale è Nessuno.

list

Elencare gli endpoint dell'area di lavoro.

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

Parametri

local

(Facoltativo) Flag per indicare se interagire con gli endpoint nell'ambiente Docker locale. Valore predefinito: False

Restituisce

Elenco di endpoint

Tipo restituito

ItemPaged[OnlineEndpoint]

Eccezioni

ValidationException

Generato se OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

AssetException

Generato se gli asset onlineEndpoint (ad esempio Dati, Codice, Modello, Ambiente) non possono essere convalidati correttamente. I dettagli verranno forniti nel messaggio di errore.

ModelException

Generato se il modello OnlineEndpoint non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

EmptyDirectoryError

Generato se il percorso locale ha fornito punti a una directory vuota.

LocalEndpointNotFoundError

Generato se la risorsa dell'endpoint locale non esiste.