Compartilhar via


AutoMLException Classe

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

Nome Description
exception_message
Obrigatório
str

Uma mensagem que descreve o erro.

target
str

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

Valor padrão: None
details

Qualquer informação adicional para o erro, como outras respostas de erro ou rastreamentos de pilha.

Valor padrão: None
message_format
str

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

Valor padrão: None
message_parameters
<xref:Dictionary>[str, str]

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

Valor padrão: None
reference_code
str

Indicador do módulo ou código em que a falha ocorreu

Valor padrão: None
has_pii

Booliano que representa se a mensagem De exceção tem informações de PII.

Valor padrão: True
azureml_error
Valor padrão: None
inner_exception
Valor padrão: None

Métodos

create_without_pii

Criar uma exceção marcada como não contendo PII.

from_exception

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

get_pii_free_exception_msg_format
pii_free_msg

Mensagem de fallback a ser usada para situações em que a impressão de informações que contêm PII é inadequada.

with_generic_msg

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

create_without_pii

Criar uma exceção marcada como não contendo PII.

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

Parâmetros

Nome Description
cls
Obrigatório

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

msg
Obrigatório

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

target

cadeia de caracteres opcional apontando para o destino da exceção

Valor padrão: None
reference_code

Indicador do módulo ou código em que a falha ocorreu

Valor padrão: None

from_exception

Converter uma exceção arbitrária para esse 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

Nome Description
cls
Obrigatório

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

e
Obrigatório

o objeto de exceção original

msg

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

Valor padrão: None
target

cadeia de caracteres opcional apontando para o destino da exceção

Valor padrão: None
reference_code

Indicador do módulo ou código em que a falha ocorreu

Valor padrão: None
has_pii

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

Valor padrão: True

Retornos

Tipo Description

uma nova exceção desse tipo, preservando o rastreamento de pilha original

get_pii_free_exception_msg_format

get_pii_free_exception_msg_format() -> str

pii_free_msg

Mensagem de fallback a ser usada para situações em que a impressão de informações que contêm PII é inadequada.

pii_free_msg(scrubbed: bool = True) -> str

Parâmetros

Nome Description
scrubbed

Se for true, retornará um '[Oculto pois pode conter PII]' genérico como fallback; caso contrário, uma cadeia de caracteres vazia

Valor padrão: True

Retornos

Tipo Description

Mensagem de log seguro para registro em log na telemetria

with_generic_msg

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

with_generic_msg(msg: str) -> ExceptionT

Parâmetros

Nome Description
msg
Obrigatório

a mensagem genérica a ser usada

Retornos

Tipo Description

esse objeto

Atributos

error_code

Obter o código de erro da exceção.

error_type

Obter o tipo de erro raiz para a exceção.

has_pii

Verificar se a mensagem da exceção contém PII ou não.

message_format

Obter uma mensagem de exceção de log seguro, se houver.

target

Nome do elemento que fez com que a exceção fosse gerada.