promptflow.contracts.run_info 模块#
- class promptflow.contracts.run_info.FlowRunInfo(run_id: str, status: 状态, error: object, inputs: object, output: object, metrics: Dict[str, Any], request: object, parent_run_id: str, root_run_id: str, source_run_id: str, flow_id: str, start_time: datetime, end_time: datetime, index: Optional[int] = None, api_calls: Optional[List[Dict[str, Any]]] = None, name: str = '', description: str = '', tags: Optional[Mapping[str, str]] = None, system_metrics: Optional[Dict[str, Any]] = None, result: Optional[object] = None, upload_metrics: bool = False, otel_trace_id: Optional[str] = '', message_format: str = 'basic')#
基础类:
object表示运行信息的数据类。
- Parameters:
run_id (str) – 运行的id，等于
flow_run_id:child_flow_run_idstatus (Status) – 流程运行的状态
error (Dict[str, Any]) – 流程运行期间发生的错误
inputs (object) – 流程运行的输入
output (object) – 流程运行的输出
metrics (Dict[str, Any]) – 流程运行的指标
request (object) – 为流程运行发出的请求
parent_run_id (str) – 流程运行的父运行ID
root_run_id (str) – 流程运行的根运行ID
source_run_id (str) – 触发流程运行的运行ID
flow_id (str) – 流程运行的流程ID
start_time (datetime) – 流程运行的开始时间
end_time (datetime) – 流程运行的结束时间
index (可选[int]) – 流程运行的索引（用于批量测试模式）
api_calls (可选[列表[字典[str, 任意]]]) – 在流程运行期间进行的API调用
name (可选[str]) – 流程运行的名称
描述 (可选[str]) – 流程运行的描述
tags (可选[Dict[str, str]]) – 流程运行的标签
system_metrics (可选[Dict[str, Any]]) – 流程运行的系统指标
result (可选[对象]) – 流程运行的结果
upload_metrics (可选[布尔值]) – 标志，指示是否上传流程运行的指标
message_format (str) – 表示不同多媒体合同的消息格式类型。
- api_calls: Optional[List[Dict[str, Any]]] = None#
- static create_with_error(start_time, inputs, index, run_id, error)#
- description: str = ''#
- static deserialize(data: dict) FlowRunInfo#
从字典中反序列化FlowRunInfo。
- end_time: datetime#
- error: object#
- flow_id: str#
- index: Optional[int] = None#
- inputs: object#
- message_format: str = 'basic'#
- metrics: Dict[str, Any]#
- name: str = ''#
- otel_trace_id: Optional[str] = ''#
- output: object#
- parent_run_id: str#
- request: object#
- result: object = None#
- root_run_id: str#
- run_id: str#
- source_run_id: str#
- start_time: datetime#
- system_metrics: Dict[str, Any] = None#
- tags: Optional[Mapping[str, str]] = None#
- upload_metrics: bool = False#
- class promptflow.contracts.run_info.RunInfo(node: str, flow_run_id: str, run_id: str, status: 状态, inputs: Mapping[str, Any], output: object, metrics: Dict[str, Any], error: Dict[str, Any], parent_run_id: str, start_time: datetime, end_time: datetime, index: Optional[int] = None, api_calls: Optional[List[Dict[str, Any]]] = None, cached_run_id: Optional[str] = None, cached_flow_run_id: Optional[str] = None, logs: Optional[Dict[str, str]] = None, system_metrics: Optional[Dict[str, Any]] = None, result: Optional[object] = None, message_format: str = 'basic')#
基础类:
object表示运行信息的数据类。
- Parameters:
node (str) – 节点名称
flow_run_id (str) – 流程运行的ID
run_id (str) – 运行的id，等于
flow_run_id:step_run_idstatus (Status) – 运行状态
inputs (list) – 运行的输入列表
output (object) – 运行的输出
metrics (Dict[str, Any]) – 运行的指标
error (Dict[str, Any]) – 运行期间发生的错误
parent_run_id (str) – 父运行ID
start_time (datetime) – 运行的开始时间
end_time (datetime) – 运行的结束时间
index (可选[int]) – 运行的索引
api_calls (可选[列表[字典[str, Any]]]) – 运行期间进行的API调用
cached_run_id (可选[str]) – 缓存的运行ID
cached_flow_run_id (可选[str]) – 缓存的流程运行ID
logs (可选[字典[字符串, 字符串]]) – 运行的日志
system_metrics (可选[字典[字符串, 任意类型]]) – 运行的系统指标
result (可选[对象]) – 运行的结果
message_format (str) – 表示不同多媒体合同的消息格式类型。
- api_calls: Optional[List[Dict[str, Any]]] = None#
- cached_flow_run_id: str = None#
- cached_run_id: str = None#
- end_time: datetime#
- error: Dict[str, Any]#
- flow_run_id: str#
- index: Optional[int] = None#
- inputs: Mapping[str, Any]#
- logs: Optional[Dict[str, str]] = None#
- message_format: str = 'basic'#
- metrics: Dict[str, Any]#
- node: str#
- output: object#
- parent_run_id: str#
- result: object = None#
- run_id: str#
- start_time: datetime#
- system_metrics: Dict[str, Any] = None#