promptflow.exceptions 模块

class promptflow.exceptions.ErrorCategory(value)

基类：str, Enum

一个枚举。

SYSTEM_ERROR = 'SystemError'

UNKNOWN = 'Unknown'

USER_ERROR = 'UserError'

class promptflow.exceptions.ErrorTarget(value)

基类：str, Enum

错误的目标，指示错误发生在系统的哪一部分。

AZURE_RUN_STORAGE = 'AzureRunStorage'

BATCH = 'Batch'

CONTROL_PLANE_SDK = 'ControlPlaneSDK'

CORE = 'Core'

EXECUTOR = 'Executor'

FLOW_EXECUTOR = 'FlowExecutor'

FLOW_INVOKER = 'FlowInvoker'

FUNCTION_PATH = 'FunctionPath'

NODE_EXECUTOR = 'NodeExecutor'

RUNTIME = 'Runtime'

RUN_STORAGE = 'RunStorage'

RUN_TRACKER = 'RunTracker'

SERVING_APP = 'ServingApp'

TOOL = 'Tool'

UNKNOWN = 'Unknown'

exception promptflow.exceptions.PromptflowException(message='', message_format='', target: ErrorTarget = ErrorTarget.UNKNOWN, module=None, privacy_info: Optional[List[str]] = None, **kwargs)

基类：Exception

所有错误的基异常。

参数:

• message (str) – 描述错误的A消息。这是用户将看到的错误消息。

• target (ErrorTarget) – 导致抛出异常的元素的名称。

• error (Exception) – 原始异常（如果有）。

• privacy_info (List[str]) – 为了将消息记录到遥测，有必要屏蔽私有信息。如果设置为None，消息将不会记录到遥测。否则，它将把包含privacy_info的消息中的内容字符串替换为“{privacy_info}”。

property additional_info

返回异常的附加信息字典。

默认情况下，此信息通常可以为空。

但是，我们仍然可以为某些特定异常定义附加信息。例如，对于ToolExcutionError，我们可以将工具的行号、堆栈跟踪添加到附加信息中。

property error_codes

返回此异常的错误代码列表。

错误代码的定义与类继承相同。例如，对于继承自UserErrorException的ToolExcutionError，结果将是[“UserErrorException”, “ToolExecutionError”]。

get_arguments_from_message_format(message_format)

从消息格式中获取参数。

property inner_exception

获取内部异常。

内部异常可以通过以下任何一种方式设置：

1. 通过构造函数中的错误参数设置。

   raise PromptflowException(“message”, error=inner_exception)

2. 通过raise from语句设置。

   raise PromptflowException(“message”) from inner_exception

property message

错误消息。

property message_format

错误消息格式。

property message_parameters

错误消息参数。

property module

发生错误的模块。

它类似于target，但更具体。它旨在存储引发异常的代码的Python模块名称。

property reference_code

错误的参考代码。

property serializable_message_parameters

可序列化的错误消息参数。

property target

错误目标。

返回:

错误目标。

返回类型:

ErrorTarget

exception promptflow.exceptions.SystemErrorException(message='', message_format='', target: ErrorTarget = ErrorTarget.UNKNOWN, module=None, privacy_info: Optional[List[str]] = None, **kwargs)

基类：PromptflowException

服务错误触发时引发的异常。

exception promptflow.exceptions.UserErrorException(message='', message_format='', target: ErrorTarget = ErrorTarget.UNKNOWN, module=None, privacy_info: Optional[List[str]] = None, **kwargs)

基类：PromptflowException

提供无效或不支持的输入时引发的异常。

exception promptflow.exceptions.ValidationException(message='', message_format='', target: ErrorTarget = ErrorTarget.UNKNOWN, module=None, privacy_info: Optional[List[str]] = None, **kwargs)

基类：UserErrorException

验证失败时引发的异常。