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.UNKNOWN, module=None, privacy_info: Optional[List[str]] = None, **kwargs)

基础：Exception

所有错误的基类异常。

Parameters:

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

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

• error (Exception) – 如果有的话，原始异常。

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

property additional_info

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

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

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

property error_codes

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

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

get_arguments_from_message_format(message_format)

从消息格式中获取参数。

property inner_exception

获取内部异常。

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

1. Set via the error parameter in the constructor.

   raise PromptflowException("message", error=inner_exception)

2. Set via raise from statement.

   从 inner_exception 引发 PromptflowException("message")

property message

错误信息。

property message_format

错误消息格式。

property message_parameters

错误消息参数。

property module

发生错误的模块。

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

property reference_code

错误的参考代码。

property serializable_message_parameters

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

property target

错误目标。

Returns:

错误目标。

Return type:

ErrorTarget

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

基础类: PromptflowException

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

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

基础类: PromptflowException

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

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

基础：UserErrorException

验证失败时引发的异常。