-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathflow_response.py
More file actions
109 lines (86 loc) · 2.76 KB
/
flow_response.py
File metadata and controls
109 lines (86 loc) · 2.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# This file was auto-generated by Fern from our API Definition.
from __future__ import annotations
import datetime as dt
import typing
import typing_extensions
from ..types.user_response import UserResponse
from .environment_response import EnvironmentResponseParams
from .evaluator_aggregate import EvaluatorAggregateParams
if typing.TYPE_CHECKING:
from .monitoring_evaluator_response import MonitoringEvaluatorResponseParams
class FlowResponseParams(typing_extensions.TypedDict):
"""
Response model for a Flow.
"""
path: str
"""
Path of the Flow, including the name, which is used as a unique identifier.
"""
id: str
"""
Unique identifier for the Flow.
"""
directory_id: typing_extensions.NotRequired[str]
"""
ID of the directory that the file is in on Humanloop.
"""
attributes: typing.Dict[str, typing.Optional[typing.Any]]
"""
A key-value object identifying the Flow Version.
"""
version_name: typing_extensions.NotRequired[str]
"""
Unique name for the Flow version. Version names must be unique for a given Flow.
"""
version_description: typing_extensions.NotRequired[str]
"""
Description of the Version.
"""
name: str
"""
Name of the Flow.
"""
description: typing_extensions.NotRequired[str]
"""
Description of the Flow.
"""
schema: typing_extensions.NotRequired[typing.Dict[str, typing.Optional[typing.Any]]]
"""
The JSON schema for the File.
"""
readme: typing_extensions.NotRequired[str]
"""
Long description of the file.
"""
tags: typing_extensions.NotRequired[typing.Sequence[str]]
"""
List of tags associated with the file.
"""
version_id: str
"""
Unique identifier for the specific Flow Version. If no query params provided, the default deployed Flow Version is returned.
"""
type: typing_extensions.NotRequired[typing.Literal["flow"]]
environments: typing_extensions.NotRequired[typing.Sequence[EnvironmentResponseParams]]
"""
The list of environments the Flow Version is deployed to.
"""
created_at: dt.datetime
updated_at: dt.datetime
created_by: typing_extensions.NotRequired[UserResponse]
"""
The user who created the Flow.
"""
last_used_at: dt.datetime
version_logs_count: int
"""
The number of logs that have been generated for this Flow Version
"""
evaluator_aggregates: typing_extensions.NotRequired[typing.Sequence[EvaluatorAggregateParams]]
"""
Aggregation of Evaluator results for the Flow Version.
"""
evaluators: typing_extensions.NotRequired[typing.Sequence["MonitoringEvaluatorResponseParams"]]
"""
The list of Monitoring Evaluators associated with the Flow Version.
"""