Dela via


AutoMLException Klass

Undantag med ytterligare ett fält som anger vilken typ av fel det är.

Skapa en ny AutoMLException.

Arv
azureml._common.exceptions.AzureMLException
AutoMLException

Konstruktor

AutoMLException(exception_message: str = '', target: str | None = None, details: List[str] | None = None, message_format: str | None = None, message_parameters: Dict[str, str] | None = None, reference_code: str | None = None, has_pii: bool = True, azureml_error: AzureMLError | None = None, inner_exception: BaseException | None = None)

Parametrar

Name Description
exception_message
Obligatorisk
str

Ett meddelande som beskriver felet.

target
str

Namnet på det element som orsakade att undantaget utlöstes.

Standardvärde: None
details

Eventuell ytterligare information om felet, till exempel andra felsvar eller stackspårningar.

Standardvärde: None
message_format
str

Oformaterad version av exception_message utan variabel ersättning.

Standardvärde: None
message_parameters
<xref:Dictionary>[str, str]

Värdeersättningar som motsvarar innehållet i message_format

Standardvärde: None
reference_code
str

Indikator för modulen eller koden där felet inträffade

Standardvärde: None
has_pii

Booleskt värde som representerar om undantagsmeddelandet har någon PII-information.

Standardvärde: True
azureml_error
Standardvärde: None
inner_exception
Standardvärde: None

Metoder

create_without_pii

Skapa ett undantag som är taggat som inte innehåller PII.

from_exception

Konvertera ett godtyckligt undantag till den här undantagstypen. Det resulterande undantaget markeras som innehåller PII.

get_pii_free_exception_msg_format
pii_free_msg

Återställningsmeddelande som ska användas för situationer där det är olämpligt att skriva ut PII-innehållande information.

with_generic_msg

Bifoga ett allmänt felmeddelande som ska användas i telemetri om det här undantaget innehåller PII.

create_without_pii

Skapa ett undantag som är taggat som inte innehåller PII.

create_without_pii(msg: str = '', target: str | None = None, reference_code: str | None = None) -> ExceptionT

Parametrar

Name Description
cls
Obligatorisk

Klass av typen :class: azureml.automl.core.exceptions.AutoMLException

msg
Obligatorisk

valfritt meddelande att använda i stället för det ursprungliga undantagsmeddelandet

target

valfri sträng som pekar på målet för undantaget

Standardvärde: None
reference_code

Indikator för modulen eller koden där felet inträffade

Standardvärde: None

from_exception

Konvertera ett godtyckligt undantag till den här undantagstypen. Det resulterande undantaget markeras som innehåller PII.

from_exception(e: BaseException, msg: str | None = None, target: str | None = None, reference_code: str | None = None, has_pii: bool = True) -> AutoMLException

Parametrar

Name Description
cls
Obligatorisk

Klass av typen :class: azureml.automl.core.exceptions.AutoMLException

e
Obligatorisk

det ursprungliga undantagsobjektet

msg

valfritt meddelande att använda i stället för det ursprungliga undantagsmeddelandet

Standardvärde: None
target

valfri sträng som pekar på målet för undantaget

Standardvärde: None
reference_code

Indikator för modulen eller koden där felet inträffade

Standardvärde: None
has_pii

om det här undantaget innehåller PII eller inte

Standardvärde: True

Returer

Typ Description

ett nytt undantag av den här typen, vilket bevarar den ursprungliga stackspårningen

get_pii_free_exception_msg_format

get_pii_free_exception_msg_format() -> str

pii_free_msg

Återställningsmeddelande som ska användas för situationer där det är olämpligt att skriva ut PII-innehållande information.

pii_free_msg(scrubbed: bool = True) -> str

Parametrar

Name Description
scrubbed

Om det är sant returnerar du ett allmänt [Dolt eftersom det kan innehålla PII] som en reserv, annars en tom sträng

Standardvärde: True

Returer

Typ Description

Logga säkert meddelande för loggning i telemetri

with_generic_msg

Bifoga ett allmänt felmeddelande som ska användas i telemetri om det här undantaget innehåller PII.

with_generic_msg(msg: str) -> ExceptionT

Parametrar

Name Description
msg
Obligatorisk

det allmänna meddelande som ska användas

Returer

Typ Description

det här objektet

Attribut

error_code

Hämta felkoden för det här undantaget.

error_type

Hämta rotfeltypen för det här undantaget.

has_pii

Kontrollera om det här undantagets meddelande innehåller PII eller inte.

message_format

Hämta ett loggsäkert undantagsmeddelande, om det finns något.

target

Namnet på elementet som orsakade att undantaget utlöstes.