AutoMLException 类
指定错误类型的其他字段例外。
构造新的 AutoMLException。
构造函数
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)参数
| 名称 | 说明 |
|---|---|
|
exception_message
必需
|
描述错误的消息。 |
|
target
|
导致引发异常的元素的名称。 默认值: None
|
|
details
|
错误的任何其他信息，例如其他错误响应或堆栈跟踪。 默认值: None
|
|
message_format
|
无变量替换的未格式化版本的exception_message。 默认值: None
|
|
message_parameters
|
与message_format内容相对应的值替换 默认值: None
|
|
reference_code
|
发生故障的模块或代码的指示器 默认值: None
|
|
has_pii
|
表示异常消息是否具有任何 PII 信息的布尔值。 默认值: True
|
|
azureml_error
|
默认值: None
|
|
inner_exception
|
默认值: None
|
方法
| create_without_pii |
创建标记为不包含 PII 的异常。 |
| from_exception |
将任意异常转换为此异常类型。 生成的异常标记为包含 PII。 |
| get_pii_free_exception_msg_format | |
| pii_free_msg |
用于打印包含 PII 的信息不适当的情况的回退消息。 |
| with_generic_msg |
附加在遥测中使用的通用错误消息（如果此异常包含 PII）。 |
create_without_pii
创建标记为不包含 PII 的异常。
create_without_pii(msg: str = '', target: str | None = None, reference_code: str | None = None) -> ExceptionT参数
| 名称 | 说明 |
|---|---|
|
cls
必需
|
类型为 ：class 的类： azureml.automl.core.exceptions.AutoMLException |
|
msg
必需
|
要使用的可选消息，而不是原始异常消息 |
|
target
|
指向异常目标的可选字符串 默认值: None
|
|
reference_code
|
发生故障的模块或代码的指示器 默认值: None
|
from_exception
将任意异常转换为此异常类型。 生成的异常标记为包含 PII。
from_exception(e: BaseException, msg: str | None = None, target: str | None = None, reference_code: str | None = None, has_pii: bool = True) -> AutoMLException参数
| 名称 | 说明 |
|---|---|
|
cls
必需
|
类型为 ：class 的类： azureml.automl.core.exceptions.AutoMLException |
|
e
必需
|
原始异常对象 |
|
msg
|
要使用的可选消息，而不是原始异常消息 默认值: None
|
|
target
|
指向异常目标的可选字符串 默认值: None
|
|
reference_code
|
发生故障的模块或代码的指示器 默认值: None
|
|
has_pii
|
此异常是否包含 PII 默认值: True
|
返回
| 类型 | 说明 |
|---|---|
|
此类型的新异常，保留原始堆栈跟踪 |
get_pii_free_exception_msg_format
get_pii_free_exception_msg_format() -> strpii_free_msg
用于打印包含 PII 的信息不适当的情况的回退消息。
pii_free_msg(scrubbed: bool = True) -> str参数
| 名称 | 说明 |
|---|---|
|
scrubbed
|
如果为 true，则返回泛型“[隐藏，因为它可能包含 PII]”作为回退，否则返回空字符串 默认值: True
|
返回
| 类型 | 说明 |
|---|---|
|
记录遥测中日志记录的安全消息 |
with_generic_msg
附加在遥测中使用的通用错误消息（如果此异常包含 PII）。
with_generic_msg(msg: str) -> ExceptionT参数
| 名称 | 说明 |
|---|---|
|
msg
必需
|
要使用的泛型消息 |
返回
| 类型 | 说明 |
|---|---|
|
此对象 |
属性
error_code
获取此异常的错误代码。
error_type
获取此异常的根错误类型。
has_pii
检查此异常的消息是否包含 PII。
message_format
获取日志安全异常消息（如果有）。
target
导致引发异常的元素的名称。