OnlineEndpointOperations Classe

  • Référence

OnlineEndpointOperations.

Vous ne devez pas instancier cette classe directement. Au lieu de cela, vous devez créer un instance MLClient qui l’instancie pour vous et l’attache en tant qu’attribut.

Héritage
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
OnlineEndpointOperations

Constructeur

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)

Paramètres

operation_scope
operation_config
service_client_02_2022_preview
all_operations
local_endpoint_helper
credentials
valeur par défaut: None

Méthodes

begin_create_or_update

Créer ou mettre à jour un point de terminaison.
begin_delete

Supprimer un point de terminaison en ligne.
begin_regenerate_keys

Régénérez les clés pour le point de terminaison.
get

Obtenir une ressource de point de terminaison.
get_keys

Obtenez les informations d’identification d’authentification.
invoke

Appelle le point de terminaison avec la charge utile fournie.
list

Répertorier les points de terminaison de l’espace de travail.

begin_create_or_update

Créer ou mettre à jour un point de terminaison.

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

Paramètres

endpoint
OnlineEndpoint
Obligatoire

Entité de point de terminaison.

local
bool

Indique s’il faut interagir avec le point de terminaison dans l’environnement Docker local. Valeur par défaut False.

Retours

Un polleur pour suivre l’opération status s’il est distant, sinon, retourne Aucun si local.

Type de retour

LROPoller[OnlineEndpoint]

Exceptions

ValidationException

Déclenché si OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

AssetException

Déclenché si les ressources OnlineEndpoint (par exemple, Données, Code, Modèle, Environnement) ne peuvent pas être validées avec succès. Les détails seront fournis dans le message d’erreur.

ModelException

Déclenché si le modèle OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

EmptyDirectoryError

Déclenché si le chemin d’accès local fourni pointe vers un répertoire vide.

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.

begin_delete

Supprimer un point de terminaison en ligne.

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

Paramètres

name
str
Obligatoire

Nom du point de terminaison,

local
bool

Indique s’il faut interagir avec le point de terminaison dans l’environnement Docker local. Valeur par défaut False.

Retours

Un polleur pour suivre l’opération status s’il est distant, sinon, retourne Aucun si local.

Type de retour

LROPoller[None]

Exceptions

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.

begin_regenerate_keys

Régénérez les clés pour le point de terminaison.

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

Paramètres

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

Nom du point de terminaison.

key_type
str

L’un des « primaires », « secondaires ». La valeur par défaut est « primary ».

Retours

Un polleur pour suivre l’opération status.

Type de retour

LROPoller[None]

Exceptions

ValidationException

Déclenché si OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

AssetException

Déclenché si les ressources OnlineEndpoint (par exemple, Données, Code, Modèle, Environnement) ne peuvent pas être validées avec succès. Les détails seront fournis dans le message d’erreur.

ModelException

Déclenché si le modèle OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

EmptyDirectoryError

Déclenché si le chemin d’accès local fourni pointe vers un répertoire vide.

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.

get

Obtenir une ressource de point de terminaison.

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

Paramètres

name
str
Obligatoire

Nom du point de terminaison,

local
Optional[bool]

Indique s’il faut interagir avec les points de terminaison dans l’environnement Docker local. Valeur par défaut False.

Retours

Objet point de terminaison récupéré à partir du service.

Type de retour

OnlineEndpoint

Exceptions

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.

get_keys

Obtenez les informations d’identification d’authentification.

get_keys(name: str) -> EndpointAuthKeys | EndpointAuthToken

Paramètres

name
str
Obligatoire

Nom du point de terminaison

Retours

En fonction du mode d’authentification dans le point de terminaison, retourne des clés ou un jeton

Type de retour

Union[EndpointAuthKeys, EndpointAuthToken]

Exceptions

ValidationException

Déclenché si OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

AssetException

Déclenché si les ressources OnlineEndpoint (par exemple, Données, Code, Modèle, Environnement) ne peuvent pas être validées avec succès. Les détails seront fournis dans le message d’erreur.

ModelException

Déclenché si le modèle OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

EmptyDirectoryError

Déclenché si le chemin d’accès local fourni pointe vers un répertoire vide.

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.

invoke

Appelle le point de terminaison avec la charge utile fournie.

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

Paramètres

endpoint_name
str
Obligatoire

Nom du point de terminaison

request_file
Optional[str]

Fichier contenant la charge utile de la demande. Cela est uniquement valide pour le point de terminaison en ligne.

deployment_name
Optional[str]

Nom d’un déploiement spécifique à appeler. Ce paramètre est facultatif. Par défaut, les demandes sont routées vers l’un des déploiements en fonction des règles de trafic.

input_data
Optional[Union[str, Data]]

Pour utiliser une ressource de données préinscrite, passez str au format

local
Optional[bool]

Indique s’il faut interagir avec les points de terminaison dans l’environnement Docker local. Valeur par défaut False.

Retours

Sortie de prédiction pour le point de terminaison en ligne.

Type de retour

str

Exceptions

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.

MultipleLocalDeploymentsFoundError

Déclenché s’il existe plusieurs déploiements et qu’aucun deployment_name n’est spécifié.

InvalidLocalEndpointError

Déclenché si le point de terminaison local est None.

list

Répertorier les points de terminaison de l’espace de travail.

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

Paramètres

local

(Facultatif) Indicateur pour indiquer s’il faut interagir avec les points de terminaison dans l’environnement Docker local. Valeur par défaut : False

Retours

Liste des points de terminaison

Type de retour

ItemPaged[OnlineEndpoint]

Exceptions

ValidationException

Déclenché si OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

AssetException

Déclenché si les ressources OnlineEndpoint (par exemple, Données, Code, Modèle, Environnement) ne peuvent pas être validées avec succès. Les détails seront fournis dans le message d’erreur.

ModelException

Déclenché si le modèle OnlineEndpoint ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

EmptyDirectoryError

Déclenché si le chemin d’accès local fourni pointe vers un répertoire vide.

LocalEndpointNotFoundError

Déclenché si la ressource de point de terminaison local n’existe pas.