Partilhar via

AutoMLException Classe

  • Referência

Exceção com um campo adicional que especifica o tipo de erro.

Construa uma nova AutoMLException.

Herança
azureml._common.exceptions.AzureMLException
AutoMLException

Construtor

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)

Parâmetros

exception_message
str
Necessário

Uma mensagem que descreve o erro.

target
str
valor predefinido: None

O nome do elemento que causou a exceção.

details
list(str)
valor predefinido: None

Quaisquer informações adicionais sobre o erro, tais como outras respostas de erro ou rastreios de pilha.

message_format
str
valor predefinido: None

Versão não formatada do exception_message sem substituição de variáveis.

message_parameters
<xref:Dictionary>[str, str]
valor predefinido: None

Substituições de valores correspondentes ao conteúdo de message_format

reference_code
str
valor predefinido: None

Indicador do módulo ou código onde ocorreu a falha

has_pii
bool
valor predefinido: True

Valor booleano que representa se a mensagem Exceção tem alguma informação PII.

azureml_error
valor predefinido: None
inner_exception
valor predefinido: None

Métodos

create_without_pii

Crie uma exceção etiquetada como não contendo PII.
from_exception

Converter uma exceção arbitrária para este tipo de exceção. A exceção resultante é marcada como contendo PII.
get_pii_free_exception_msg_format
pii_free_msg

Mensagem de contingência a utilizar para situações em que imprimir informações contendo PII é inadequada.
with_generic_msg

Anexe uma mensagem de erro genérica que será utilizada na telemetria se esta exceção contiver PII.

create_without_pii

Crie uma exceção etiquetada como não contendo PII.

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

Parâmetros

cls
Necessário

Classe do tipo :class: azureml.automl.core.exceptions.AutoMLException

msg
Necessário

mensagem opcional a utilizar em vez da mensagem de exceção original

target
valor predefinido: None

cadeia opcional que aponta para o destino da exceção

reference_code
valor predefinido: None

Indicador do módulo ou código onde ocorreu a falha

from_exception

Converter uma exceção arbitrária para este tipo de exceção. A exceção resultante é marcada como contendo PII.

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

Parâmetros

cls
Necessário

Classe do tipo :class: azureml.automl.core.exceptions.AutoMLException

e
Necessário

o objeto de exceção original

msg
valor predefinido: None

mensagem opcional a utilizar em vez da mensagem de exceção original

target
valor predefinido: None

cadeia opcional que aponta para o destino da exceção

reference_code
valor predefinido: None

Indicador do módulo ou código onde ocorreu a falha

has_pii
valor predefinido: True

se esta exceção contém PII ou não

Devoluções

uma nova exceção deste tipo, preservando o rastreio de pilha original

get_pii_free_exception_msg_format 

get_pii_free_exception_msg_format() -> str

pii_free_msg

Mensagem de contingência a utilizar para situações em que imprimir informações contendo PII é inadequada.

pii_free_msg(scrubbed: bool = True) -> str

Parâmetros

scrubbed
valor predefinido: True

Se for verdadeiro, devolva um genérico "[Oculto, pois pode conter PII]" como contingência, caso contrário, uma cadeia vazia

Devoluções

Registar uma mensagem segura para iniciar sessão na telemetria

with_generic_msg

Anexe uma mensagem de erro genérica que será utilizada na telemetria se esta exceção contiver PII.

with_generic_msg(msg: str) -> ExceptionT

Parâmetros

msg
Necessário

a mensagem genérica a utilizar

Devoluções

este objeto

Atributos

error_code

Obtenha o código de erro para esta exceção.

error_type

Obtenha o tipo de erro de raiz para esta exceção.

has_pii

Verifique se a mensagem desta exceção contém PII ou não.

message_format

Obtenha uma mensagem de exceção de segurança de registo, se existir.

target

Nome do elemento que causou a exceção.